@maxim_mazurok/gapi.client.displayvideo-v4

TypeScript typings for Display & Video 360 API v4

Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items. For detailed description please check documentation.

Installing

Install typings for Display & Video 360 API:

npm install @types/gapi.client.displayvideo-v4 --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://displayvideo.googleapis.com/$discovery/rest?version=v4',
  () => {
    // now we can use:
    // gapi.client.displayvideo
  }
);

// 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('displayvideo', 'v4', () => {
  // now we can use:
  // gapi.client.displayvideo
});

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 = [
    // Create, see, edit, and permanently delete your Display & Video 360 entities and reports
    'https://www.googleapis.com/auth/display-video',

    // View and manage your reports in DoubleClick Bid Manager
    'https://www.googleapis.com/auth/doubleclickbidmanager',
  ],
  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 Display & Video 360 API resources:

/*
Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.
*/
await gapi.client.displayvideo.media.download({resourceName: 'resourceName'});

/*
Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.
*/
await gapi.client.displayvideo.media.upload({resourceName: 'resourceName'});