Merchant API: Node.js Client

Merchant API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Merchant API API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-shopping/accounts

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The account to list regions for.
 *  Format: `accounts/{account}`
 */
// const parent = 'accounts/abc123'
/**
 *  Optional. The maximum number of regions to return. The service may return
 *  fewer than this value.
 *  If unspecified, at most 50 regions will be returned.
 *  The maximum value is 1000; values above 1000 will be coerced to 1000.
 */
// const pageSize = 1234
/**
 *  Optional. A page token, received from a previous `ListRegions` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListRegions` must
 *  match the call that provided the page token.
 */
// const pageToken = 'abc123'

// Imports the Accounts library
const {RegionsServiceClient} = require('@google-shopping/accounts').v1beta;

// Instantiates a client
const accountsClient = new RegionsServiceClient();

async function callListRegions() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = accountsClient.listRegionsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListRegions();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Account_issue_service.list_account_issues	source code
Account_tax_service.get_account_tax	source code
Account_tax_service.list_account_tax	source code
Account_tax_service.update_account_tax	source code
Accounts_service.create_and_configure_account	source code
Accounts_service.delete_account	source code
Accounts_service.get_account	source code
Accounts_service.list_accounts	source code
Accounts_service.list_sub_accounts	source code
Accounts_service.update_account	source code
Autofeed_settings_service.get_autofeed_settings	source code
Autofeed_settings_service.update_autofeed_settings	source code
Automatic_improvements_service.get_automatic_improvements	source code
Automatic_improvements_service.update_automatic_improvements	source code
Business_identity_service.get_business_identity	source code
Business_identity_service.update_business_identity	source code
Business_info_service.get_business_info	source code
Business_info_service.update_business_info	source code
Email_preferences_service.get_email_preferences	source code
Email_preferences_service.update_email_preferences	source code
Gbp_accounts_service.link_gbp_account	source code
Gbp_accounts_service.list_gbp_accounts	source code
Homepage_service.claim_homepage	source code
Homepage_service.get_homepage	source code
Homepage_service.unclaim_homepage	source code
Homepage_service.update_homepage	source code
Lfp_providers_service.find_lfp_providers	source code
Lfp_providers_service.link_lfp_provider	source code
Omnichannel_settings_service.create_omnichannel_setting	source code
Omnichannel_settings_service.get_omnichannel_setting	source code
Omnichannel_settings_service.list_omnichannel_settings	source code
Omnichannel_settings_service.request_inventory_verification	source code
Omnichannel_settings_service.update_omnichannel_setting	source code
Online_return_policy_service.create_online_return_policy	source code
Online_return_policy_service.delete_online_return_policy	source code
Online_return_policy_service.get_online_return_policy	source code
Online_return_policy_service.list_online_return_policies	source code
Online_return_policy_service.update_online_return_policy	source code
Programs_service.disable_program	source code
Programs_service.enable_program	source code
Programs_service.get_program	source code
Programs_service.list_programs	source code
Regions_service.create_region	source code
Regions_service.delete_region	source code
Regions_service.get_region	source code
Regions_service.list_regions	source code
Regions_service.update_region	source code
Shipping_settings_service.get_shipping_settings	source code
Shipping_settings_service.insert_shipping_settings	source code
Terms_of_service_agreement_state_service.get_terms_of_service_agreement_state	source code
Terms_of_service_agreement_state_service.retrieve_for_application_terms_of_service_agreement_state	source code
Terms_of_service_service.accept_terms_of_service	source code
Terms_of_service_service.get_terms_of_service	source code
Terms_of_service_service.retrieve_latest_terms_of_service	source code
User_service.create_user	source code
User_service.delete_user	source code
User_service.get_user	source code
User_service.list_users	source code
User_service.update_user	source code
Quickstart	source code

The Merchant API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-shopping/accounts@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE