TypeScript typings for Web Content Publisher API v1

webcontentpublisher.googleapis.com API, a service for web content publishers. For detailed description please check documentation.

Installing

Install typings for Web Content Publisher API:

npm install @types/gapi.client.webcontentpublisher-v1 --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.webcontentpublisher-v1"
    ]
  }
}

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

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

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 and review your subscription information
    'https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.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 Web Content Publisher API resources:

/*
Checks if a user is eligible for free article access.
*/
await gapi.client.webcontentpublisher.publications.checkFreeAccess({
  name: 'name',
});

For provenance information see Provenance section on NPM