Socket
Socket
Sign inDemoInstall

@maxim_mazurok/gapi.client.youtubereporting-v1

Package Overview
Dependencies
3
Maintainers
1
Versions
270
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@maxim_mazurok/gapi.client.youtubereporting-v1

TypeScript typings for YouTube Reporting API v1


Version published
Maintainers
1
Weekly downloads
1,724
increased by21.92%

Weekly downloads

Readme

Source

TypeScript typings for YouTube Reporting API v1

Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files. For detailed description please check documentation.

Installing

Install typings for YouTube Reporting API:

npm install @types/gapi.client.youtubereporting-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(
  'https://youtubereporting.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.youtubereporting
  }
);
// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('youtubereporting', 'v1', () => {
  // now we can use:
  // gapi.client.youtubereporting
});

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 = [
    // 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 successful authorization */
    } else {
      /* handle authorization error */
    }
  }
);

After that you can use YouTube Reporting API resources:

/*
Creates a job and returns it.
*/
await gapi.client.youtubereporting.jobs.create({});

/*
Deletes a job.
*/
await gapi.client.youtubereporting.jobs.delete({jobId: 'jobId'});

/*
Gets a job.
*/
await gapi.client.youtubereporting.jobs.get({jobId: 'jobId'});

/*
Lists jobs.
*/
await gapi.client.youtubereporting.jobs.list({});

/*
Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
*/
await gapi.client.youtubereporting.media.download({
  resourceName: 'resourceName',
});

/*
Lists report types.
*/
await gapi.client.youtubereporting.reportTypes.list({});

FAQs

Last updated on 25 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc