mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
4f8a3d571b
* Add Google APIs typings * [gapi.cliebt.* ] Add version as part of typings name and fix gapi.client tslint errors * versions should not get their own folders fixing a few typos using /** syntax so comments show up in editors export only actual (last) version for now * export only actual (last) version for now * merge namespaces and remove unnecessary namespace qualifiers * remove namespace qualifier for gapi.client.Request from nested namespaces and change Request base interface to Promise * disable await-promise rule * fix collision between gapi.client.Request and Request from nested namespace disable no-irregular-whitespace rule * sort properties and namespace resources * remove empty comments sort resources amd methods in tests and readme.md * update 'this is autogenerated file' banner to remove this text from gapi.client namespace hint use multiline comments when comment has several lines * implement no-trailing-whitespace, no-padding, max-line-length, await-promise, no-irregular-whitespace rules * add strictFunctionTypes to tsconfig * fix "Whitespace within parentheses is not allowed" rule * fix ts-lint rules * fixes * remove deprecated replicapool and replicapoolupdater api * fix no-irregular-whitespace * fix no-irregular-whitespace
2.8 KiB
2.8 KiB
TypeScript typings for YouTube Analytics API v1
Retrieves your YouTube Analytics data. For detailed description please check documentation.
Installing
Install typings for YouTube Analytics API:
npm install @types/gapi.client.youtubeanalytics@v1 --save-dev
Usage
You need to initialize Google API client in your code:
gapi.load("client", () => {
// now we can use gapi.client
// ...
});
Then load api client wrapper:
gapi.client.load('youtubeanalytics', 'v1', () => {
// now we can use gapi.client.youtubeanalytics
// ...
});
Don't forget to authenticate your client before sending any request to resources:
// declare client_id registered in Google Developers Console
var client_id = '',
scope = [
// Manage your YouTube account
'https://www.googleapis.com/auth/youtube',
// View your YouTube account
'https://www.googleapis.com/auth/youtube.readonly',
// View and manage your assets and associated content on YouTube
'https://www.googleapis.com/auth/youtubepartner',
// View monetary and non-monetary YouTube Analytics reports for your YouTube content
'https://www.googleapis.com/auth/yt-analytics-monetary.readonly',
// View YouTube Analytics reports for your YouTube content
'https://www.googleapis.com/auth/yt-analytics.readonly',
],
immediate = true;
// ...
gapi.auth.authorize({ client_id: client_id, scope: scope, immediate: immediate }, authResult => {
if (authResult && !authResult.error) {
/* handle succesfull authorization */
} else {
/* handle authorization error */
}
});
After that you can use YouTube Analytics API resources:
/*
Removes an item from a group.
*/
await gapi.client.groupItems.delete({ id: "id", });
/*
Creates a group item.
*/
await gapi.client.groupItems.insert({ });
/*
Returns a collection of group items that match the API request parameters.
*/
await gapi.client.groupItems.list({ groupId: "groupId", });
/*
Deletes a group.
*/
await gapi.client.groups.delete({ id: "id", });
/*
Creates a group.
*/
await gapi.client.groups.insert({ });
/*
Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.
*/
await gapi.client.groups.list({ });
/*
Modifies a group. For example, you could change a group's title.
*/
await gapi.client.groups.update({ });
/*
Retrieve your YouTube Analytics reports.
*/
await gapi.client.reports.query({ end-date: "end-date", ids: "ids", metrics: "metrics", start-date: "start-date", });