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 with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-shopping/inventories

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 `name` of the parent product to list `RegionalInventory`
 *  resources for. Format: `accounts/{account}/products/{product}`
 */
// const parent = 'abc123'
/**
 *  The maximum number of `RegionalInventory` resources for the given product
 *  to return. The service returns fewer than this value if the number of
 *  inventories for the given product is less that than the `pageSize`. The
 *  default value is 25000. The maximum value is 100000; If a value higher than
 *  the maximum is specified, then the `pageSize` will default to the maximum.
 */
// const pageSize = 1234
/**
 *  A page token, received from a previous `ListRegionalInventories` call.
 *  Provide the page token to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListRegionalInventories`
 *  must match the call that provided the page token. The token returned as
 *  nextPageToken google.shopping.merchant.inventories.v1beta.ListRegionalInventoriesResponse.next_page_token
 *  in the response to the previous request.
 */
// const pageToken = 'abc123'

// Imports the Inventories library
const {RegionalInventoryServiceClient} =
  require('@google-cloud/inventories').v1beta;

// Instantiates a client
const inventoriesClient = new RegionalInventoryServiceClient();

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

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

callListRegionalInventories();

Samples

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

Sample	Source Code	Try it
Local_inventory_service.delete_local_inventory	source code
Local_inventory_service.insert_local_inventory	source code
Local_inventory_service.list_local_inventories	source code
Regional_inventory_service.delete_regional_inventory	source code
Regional_inventory_service.insert_regional_inventory	source code
Regional_inventory_service.list_regional_inventories	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/inventories@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