@maxim_mazurok/gapi.client.merchantapi-accounts_v1beta

TypeScript typings for Merchant API accounts_v1beta

Programmatically manage your Merchant Center Accounts. For detailed description please check documentation.

Installing

Install typings for Merchant API:

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

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

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 product listings and accounts for Google Shopping
    'https://www.googleapis.com/auth/content',
  ],
  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 Merchant API resources:

/*
Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
*/
await gapi.client.merchantapi.accounts.createAndConfigure({});

/*
Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this.
*/
await gapi.client.merchantapi.accounts.delete({name: 'name'});

/*
Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.
*/
await gapi.client.merchantapi.accounts.get({name: 'name'});

/*
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
*/
await gapi.client.merchantapi.accounts.list({});

/*
List all sub-accounts for a given advanced account. This is a convenience wrapper for the more powerful `accounts.list` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`
*/
await gapi.client.merchantapi.accounts.listSubaccounts({provider: 'provider'});

/*
Updates an account regardless of its type: standalone, advanced account or sub-account. Executing this method requires admin access.
*/
await gapi.client.merchantapi.accounts.patch({name: 'name'});

/*
Accepts a `TermsOfService`. Executing this method requires admin access.
*/
await gapi.client.merchantapi.termsOfService.accept({name: 'name'});

/*
Retrieves the `TermsOfService` associated with the provided version.
*/
await gapi.client.merchantapi.termsOfService.get({name: 'name'});

/*
Retrieves the latest version of the `TermsOfService` for a given `kind` and `region_code`.
*/
await gapi.client.merchantapi.termsOfService.retrieveLatest({});