vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-07-01 15:50:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Google API TypeScript Definition Files

Browse Source 
TypeScript Definition File for the Google API Client (gapi). Also
included are gapi.urlshortener, gapi.youtube, gapi.youtubeAnalytics. All
the Definition files have full JsDoc Support.
This commit is contained in:
sgtfrankieboy
2013-07-07 01:27:58 +02:00
parent cd282f4a03
commit f7450dcedb
5 changed files with 2755 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -68,9 +68,11 @@ List of Definitions
* [glDatePicker](http://glad.github.com/glDatePicker/) (by [Dániel Tar](https://github.com/qcz))
* [GreenSock Animation Platform (GSAP)](http://www.greensock.com/get-started-js/) (by [Robert S.](https://github.com/codeBelt))
* [Grunt JS](http://gruntjs.com/) (by [Basarat Ali Syed](https://github.com/basarat))
* [Google API Client](https://code.google.com/p/google-api-javascript-client/) (by [Frank M](https://github.com/sgtfrankieboy))
* [Google App Engine Channel API](https://developers.google.com/appengine/docs/java/channel/javascript) (by [vvakame](https://github.com/vvakame))
* [GoogleMaps](https://developers.google.com/maps/) (by [Esben Nepper](https://github.com/eNepper))
* [Google Geolocation](https://code.google.com/p/geo-location-javascript/) (by [Vincent Bortone](https://github.com/vbortone))
* [Google Url Shortener](https://developers.google.com/url-shortener/) (by [Frank M](https://github.com/sgtfrankieboy))
* [Hammer.js](http://eightmedia.github.com/hammer.js/) (by [Boris Yankov](https://github.com/borisyankov))
* [Handlebars](http://handlebarsjs.com/) (by [Boris Yankov](https://github.com/borisyankov))
* [Highcharts](http://www.highcharts.com/) (by [damianog](https://github.com/damianog))
@@ -178,7 +180,9 @@ List of Definitions
* [Vimeo](http://developer.vimeo.com/player/js-api) (by [Daz Wilkin](https://github.com/DazWilkin/))
* [WebRTC](http://dev.w3.org/2011/webrtc/editor/webrtc.html) (by [Ken Smith](https://github.com/smithkl42))
* [YouTube](https://developers.google.com/youtube/) (by [Daz Wilkin](https://github.com/DazWilkin/))
* [Zepto.js] (http://zeptojs.com/) (by [Josh Baldwin](https://github.com/jbaldwin))
* [YouTube Analytics API](https://developers.google.com/youtube/analytics/) (by [Frank M](https://github.com/sgtfrankieboy))
* [YouTube Data API](https://developers.google.com/youtube/v3/) (by [Frank M](https://github.com/sgtfrankieboy/))
* [Zepto.js](http://zeptojs.com/) (by [Josh Baldwin](https://github.com/jbaldwin))
* [Zynga Scroller](https://github.com/zynga/scroller) (by [Boris Yankov](https://github.com/borisyankov))
* [ZeroClipboard](https://github.com/jonrohan/ZeroClipboard) (by [Eric J. Smith](https://github.com/ejsmith))

146
gapi.urlshortener/gapi.urlshortener.d.ts vendored Normal file
View File

@@ -0,0 +1,146 @@
// Type definitions for Google Url Shortener API
// Project: https://developers.google.com/url-shortener/
// Definitions by: Frank M <https://github.com/sgtfrankieboy>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../gapi/gapi.d.ts" />
declare module gapi.client.urlshortener {
export interface url {
/**
* Expands a short URL or gets creation time and analytics.
*/
get(object: {
/**
* The short URL, including the protocol.
*/
'shortUrl': string;
/**
* Additional information to return. ANALYTICS_CLICKS, ANALYTICS_TOP_STRINGS, FULL
*/
'projection'?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
'fields'?: string
}): HttpRequest<GoogleApiUrlShortenerUrlResource>;
/**
* Creates a new short URL.
*/
insert(object: {
/**
* Selector specifying which fields to include in a partial response.
*/
'fields'?: string;
/**
* HTTP Request Body
*/
'RequestBody'?: string
}): HttpRequest<GoogleApiUrlShortenerUrlResource>;
/**
* Retrieves a list of URLs shortened by a user.
*/
list(object: {
/**
* Additional information to return. ANALYTICS_CLICKS, FULL
*/
'projection'?: string;
/**
* Token for requesting successive pages of results.
*/
'start-token'?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
'fields'?: string
}): HttpRequest<GoogleApiUrlShortenerUrlResource>;
}
}
interface GoogleApiUrlShortenerUrlResource {
/**
* The fixed string "urlshortener#url".
*/
kind: string;
/**
* Short URL
*/
id: string;
/**
* Long URL
*/
longUrl: string;
/**
* Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED".
*/
status: string;
/**
* Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format.
*/
created: string;
/**
* A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
*/
analytics: {
/**
* Click analytics over all time.
*/
allTime: GoogleApiUrlShortenerUrlResourceAnalyticsObject;
/**
* Click analytics over the last month.
*/
month: GoogleApiUrlShortenerUrlResourceAnalyticsObject;
/**
* Click analytics over the last week.
*/
week: GoogleApiUrlShortenerUrlResourceAnalyticsObject;
/**
* Click analytics over the last day.
*/
day: GoogleApiUrlShortenerUrlResourceAnalyticsObject;
/**
* Click analytics over the last two hours.
*/
twoHours: GoogleApiUrlShortenerUrlResourceAnalyticsObject;
}
}
interface GoogleApiUrlShortenerUrlResourceAnalyticsObject {
/**
* Number of clicks on this short URL.
*/
shortUrlClicks: string;
/**
* Number of clicks on all goo.gl short URLs pointing to this long URL.
*/
longUrlClicks: string;
/**
* Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
*/
referrers: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[];
/**
* Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
*/
countries: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[];
/**
* Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
*/
browsers: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[];
/**
* Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
*/
platforms: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[];
}
interface GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject {
/**
* Number of clicks for this top entry, e.g. for this particular country or browser.
*/
count: string;
/**
* Label assigned to this top entry, e.g. "US" or "Chrome".
*/
id: string;
}

2337
gapi.youtube/gapi.youtube.d.ts vendored Normal file
View File

File diff suppressed because it is too large Load Diff

60
gapi.youtubeAnalytics/gapi.youtubeAnalytics.d.ts vendored Normal file
View File

@@ -0,0 +1,60 @@
// Type definitions for YouTube Analytics API
// Project: https://developers.google.com/youtube/analytics/
// Definitions by: Frank M <https://github.com/sgtfrankieboy>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../gapi/gapi.d.ts" />
declare module gapi.client.youtubeAnalytics {
export interface reports {
/**
* Retrieve your YouTube Analytics reports.
*/
query(object: {
/**
* Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner.
*/
ids: string;
/**
* The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.
*/
'start-date': string;
/**
* The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.
*/
'end-date': string;
/**
* A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes.
*/
metrics: string;
/**
* A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender.
*/
dimensions?: string;
/**
* A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters.
*/
filters?: string;
/**
* The maximum number of rows to include in the response.
*/
'max-results'?: number;
/**
* A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order.
*/
sort?: string;
/**
* An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).
*/
'start-index'?: number;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
}): HttpRequest<any>
}
}

207
gapi/gapi.d.ts vendored Normal file
View File

@@ -0,0 +1,207 @@
// Type definitions for Google API Client
// Project: https://code.google.com/p/google-api-javascript-client/
// Definitions by: Frank M <https://github.com/sgtfrankieboy>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/**
* The OAuth 2.0 token object represents the OAuth 2.0 token and any associated data.
*/
interface GoogleApiOAuth2TokenObject {
/**
* The OAuth 2.0 token. Only present in successful responses
*/
access_token: string;
/**
* Details about the error. Only present in error responses
*/
error: string;
/**
* The duration, in seconds, the token is valid for. Only present in successful responses
*/
expires_in: string;
/**
* The Google API scopes related to this token
*/
state: string;
}
declare module gapi.auth {
/**
* Initiates the OAuth 2.0 authorization process. The browser displays a popup window prompting the user authenticate and authorize. After the user authorizes, the popup closes and the callback function fires.
* @param params A key/value map of parameters for the request. If the key is not one of the expected OAuth 2.0 parameters, it is added to the URI as a query parameter.
* @param callback The function to call once the login process is complete. The function takes an OAuth 2.0 token object as its only parameter.
*/
export function authorize(params: {
/**
* The application's client ID.
*/
client_id?: string;
/**
* If true, then login uses "immediate mode", which means that the token is refreshed behind the scenes, and no UI is shown to the user.
*/
immediate?: boolean;
/**
* The OAuth 2.0 response type property. Default: token
*/
response_type?: string;
/**
* The auth scope or scopes to authorize. Auth scopes for individual APIs can be found in their documentation.
*/
scope?: any[]
}, callback: (token: GoogleApiOAuth2TokenObject) => any): void;
/**
* Initializes the authorization feature. Call this when the client loads to prevent popup blockers from blocking the auth window on gapi.auth.authorize calls.
* @param callback A callback to execute when the auth feature is ready to make authorization calls.
*/
export function init(callback: () => any): void;
/**
* Retrieves the OAuth 2.0 token for the application.
* @return The OAuth 2.0 token.
*/
export function getToken(): GoogleApiOAuth2TokenObject;
/**
* Sets the OAuth 2.0 token for the application.
* @param token The token to set.
*/
export function setToken(token: GoogleApiOAuth2TokenObject): void;
}
declare module gapi.client {
/**
* Loads the client library interface to a particular API. The new API interface will be in the form gapi.client.api.collection.method.
* @param name The name of the API to load.
* @param version The version of the API to load
* @param callback the function that is called once the API interface is loaded
*/
export function load(name: string, version: string, callback?: () => any): void;
/**
* Creates a HTTP request for making RESTful requests.
* An object encapsulating the various arguments for this method.
*/
export function request(args: {
/**
* The URL to handle the request
*/
path: string;
/**
* The HTTP request method to use. Default is GET
*/
method?: string;
/**
* URL params in key-value pair form
*/
params?: any;
/**
* Additional HTTP request headers
*/
headers?: any;
/**
* The HTTP request body (applies to PUT or POST).
*/
body?: string;
/**
* If supplied, the request is executed immediately and no gapi.client.HttpRequest object is returned
*/
callback?: () => any;
}): HttpRequest;
/**
* Creates an RPC Request directly. The method name and version identify the method to be executed and the RPC params are provided upon RPC creation.
* @param method The method to be executed.
* @param version The version of the API which defines the method to be executed. Defaults to v1
* @param rpcParams A key-value pair of the params to supply to this RPC
*/
export function rpcRequest(method: string, version?: string, rpcParams?: any): RpcRequest;
/**
* Sets the API key for the application.
* @param apiKey The API key to set
*/
export function setApiKey(apiKey: string): void;
/**
* An object encapsulating an HTTP request. This object is not instantiated directly, rather it is returned by gapi.client.request.
*/
export class HttpRequest<T> {
/**
* Executes the request and runs the supplied callback on response.
* @param callback The callback function which executes when the request succeeds or fails.
*/
execute(callback: (
/**
* contains the response parsed as JSON. If the response is not JSON, this field will be false.
*/
jsonResp: T,
/**
* is the HTTP response. It is JSON, and can be parsed to an object
*/
rawResp: {
body: string;
headers: any[];
status: number;
statusText: string;
}
) => any);
}
/**
* Represents an HTTP Batch operation. Individual HTTP requests are added with the add method and the batch is executed using execute.
*/
export class HttpBatch {
/**
* Adds a gapi.client.HttpRequest to the batch.
* @param httpRequest The HTTP request to add to this batch.
* @param opt_params extra parameters for this batch entry.
*/
add(httpRequest: HttpRequest<any>, opt_params?: {
/**
* Identifies the response for this request in the map of batch responses. If one is not provided, the system generates a random ID.
*/
id: string;
callback: (
/**
* is the response for this request only. Its format is defined by the API method being called.
*/
individualResponse: any,
/**
* is the raw batch ID-response map as a string. It contains all responses to all requests in the batch.
*/
rawBatchResponse: any
) => any
});
/**
* Executes all requests in the batch. The supplied callback is executed on success or failure.
* @param callback The callback to execute when the batch returns.
*/
execute(callback: (
/**
* is an ID-response map of each requests response.
*/
responseMap: any,
/**
* is the same response, but as an unparsed JSON-string.
*/
rawBatchResponse: string
) => any);
}
/**
* Similar to gapi.client.HttpRequest except this object encapsulates requests generated by registered methods.
*/
export class RpcRequest {
/**
* Executes the request and runs the supplied callback with the response.
* @param callback The callback function which executes when the request succeeds or fails.
*/
callback(callback: (
/**
* contains the response parsed as JSON. If the response is not JSON, this field will be false.
*/
jsonResp: any,
/**
* is the same as jsonResp, except it is a raw string that has not been parsed. It is typically used when the response is not JSON.
*/
rawResp: string
) => void );
}
}