TypeScript typings for Authorized Buyers Marketplace API v1alpha

The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers. For detailed description please check documentation.

Installing

Install typings for Authorized Buyers Marketplace API:

npm install @types/gapi.client.authorizedbuyersmarketplace-v1alpha --save-dev

TypeScript 6.0+

TypeScript 6.0 changed types to default to []. You must now explicitly list type packages in tsconfig.json:

{
  "compilerOptions": {
    "types": [
      "gapi",
      "gapi.auth2",
      "gapi.client",
      "gapi.client.authorizedbuyersmarketplace-v1alpha"
    ]
  }
}

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

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

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 = [
    // See, create, edit, and delete your Authorized Buyers Marketplace entities.
    'https://www.googleapis.com/auth/authorized-buyers-marketplace',
  ],
  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 Authorized Buyers Marketplace API resources:

/*
Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.
*/
await gapi.client.authorizedbuyersmarketplace.mediaPlanners.list({});

For provenance information see Provenance section on NPM