@datafire/google_content
Advanced tools
Client library for Content API for Shopping
npm install --save @datafire/google_content
let google_content = require('@datafire/google_content').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
google_content.shippingsettings.custombatch({}).then(data => {
console.log(data);
});
Manages product items, inventory, and Merchant Center accounts for Google Shopping.
Exchange the code passed to your redirect URI for an access_token
google_content.oauthCallback({
"code": ""
}, context)
object
stringobject
stringstringstringstringstringExchange a refresh_token for an access_token
google_content.oauthRefresh(null, context)
This action has no parameters
object
stringstringstringstringstringReturns information about the authenticated user.
google_content.accounts.authinfo({}, context)
object
string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
google_content.accounts.custombatch({}, context)
object
boolean: Flag to run the request in dry-run mode.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.google_content.accountstatuses.custombatch({}, context)
object
string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves and updates tax settings of multiple accounts in a single request.
google_content.accounttax.custombatch({}, context)
object
boolean: Flag to run the request in dry-run mode.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.google_content.datafeeds.custombatch({}, context)
object
boolean: Flag to run the request in dry-run mode.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.google_content.datafeedstatuses.custombatch({}, context)
object
string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.
google_content.inventory.custombatch({}, context)
object
boolean: Flag to run the request in dry-run mode.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves or modifies multiple orders in a single request.
google_content.orders.custombatch({}, context)
object
string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves, inserts, and deletes multiple products in a single request.
google_content.products.custombatch({}, context)
object
boolean: Flag to run the request in dry-run mode.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Gets the statuses of multiple products in a single request.
google_content.productstatuses.custombatch({}, context)
object
boolean: Flag to include full product data in the results of this request. The default value is false.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves and updates the shipping settings of multiple accounts in a single request.
google_content.shippingsettings.custombatch({}, context)
object
boolean: Flag to run the request in dry-run mode.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the sub-accounts in your Merchant Center account.
google_content.accounts.list({
"merchantId": ""
}, context)
object
integer: The maximum number of accounts to return in the response, used for paging.string: The ID of the managing account. This must be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Creates a Merchant Center sub-account.
google_content.accounts.insert({
"merchantId": ""
}, context)
object
boolean: Flag to run the request in dry-run mode.string: The ID of the managing account. This must be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Deletes a Merchant Center sub-account.
google_content.accounts.delete({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account.boolean: Flag to run the request in dry-run mode.boolean: Flag to delete sub-accounts with products. The default value is false.string: The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Output schema unknown
Retrieves a Merchant Center account.
google_content.accounts.get({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates a Merchant Center account. This method supports patch semantics.
google_content.accounts.patch({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account.boolean: Flag to run the request in dry-run mode.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates a Merchant Center account.
google_content.accounts.update({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account.boolean: Flag to run the request in dry-run mode.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Claims the website of a Merchant Center sub-account.
google_content.accounts.claimwebsite({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account whose website is claimed.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.boolean: Only available to selected merchants. When set to True, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the statuses of the sub-accounts in your Merchant Center account.
google_content.accountstatuses.list({
"merchantId": ""
}, context)
object
integer: The maximum number of account statuses to return in the response, used for paging.string: The ID of the managing account. This must be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves the status of a Merchant Center account.
google_content.accountstatuses.get({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the tax settings of the sub-accounts in your Merchant Center account.
google_content.accounttax.list({
"merchantId": ""
}, context)
object
integer: The maximum number of tax settings to return in the response, used for paging.string: The ID of the managing account. This must be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves the tax settings of the account.
google_content.accounttax.get({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account for which to get/update account tax settings.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates the tax settings of the account. This method supports patch semantics.
google_content.accounttax.patch({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account for which to get/update account tax settings.boolean: Flag to run the request in dry-run mode.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates the tax settings of the account.
google_content.accounttax.update({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account for which to get/update account tax settings.boolean: Flag to run the request in dry-run mode.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the configurations for datafeeds in your Merchant Center account.
google_content.datafeeds.list({
"merchantId": ""
}, context)
object
integer: The maximum number of products to return in the response, used for paging.string: The ID of the account that manages the datafeeds. This account cannot be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Registers a datafeed configuration with your Merchant Center account.
google_content.datafeeds.insert({
"merchantId": ""
}, context)
object
boolean: Flag to run the request in dry-run mode.string: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Deletes a datafeed configuration from your Merchant Center account.
google_content.datafeeds.delete({
"datafeedId": "",
"merchantId": ""
}, context)
object
string: The ID of the datafeed.boolean: Flag to run the request in dry-run mode.string: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Output schema unknown
Retrieves a datafeed configuration from your Merchant Center account.
google_content.datafeeds.get({
"datafeedId": "",
"merchantId": ""
}, context)
object
string: The ID of the datafeed.string: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics.
google_content.datafeeds.patch({
"datafeedId": "",
"merchantId": ""
}, context)
object
string: The ID of the datafeed.boolean: Flag to run the request in dry-run mode.string: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates a datafeed configuration of your Merchant Center account.
google_content.datafeeds.update({
"datafeedId": "",
"merchantId": ""
}, context)
object
string: The ID of the datafeed.boolean: Flag to run the request in dry-run mode.string: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the statuses of the datafeeds in your Merchant Center account.
google_content.datafeedstatuses.list({
"merchantId": ""
}, context)
object
integer: The maximum number of products to return in the response, used for paging.string: The ID of the account that manages the datafeeds. This account cannot be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves the status of a datafeed from your Merchant Center account.
google_content.datafeedstatuses.get({
"datafeedId": "",
"merchantId": ""
}, context)
object
string: The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.string: The ID of the datafeed.string: The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.string: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates price and availability of a product in your Merchant Center account.
google_content.inventory.set({
"merchantId": "",
"productId": "",
"storeCode": ""
}, context)
object
boolean: Flag to run the request in dry-run mode.string: The ID of the account that contains the product. This account cannot be a multi-client account.string: The REST id of the product for which to update price and availability.string: The code of the store for which to update price and availability. Use online to update price and availability of an online product.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the orders in your Merchant Center account.
google_content.orders.list({
"merchantId": ""
}, context)
object
boolean: Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.integer: The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.string: The ID of the account that manages the order. This cannot be a multi-client account.string (values: placedDate asc, placedDate desc): The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.string: The token returned by the previous request.string: Obtains orders placed before this date (exclusively), in ISO 8601 format.string: Obtains orders placed after this date (inclusively), in ISO 8601 format.array: Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves an order from your Merchant Center account.
google_content.orders.get({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Marks an order as acknowledged.
google_content.orders.acknowledge({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Cancels all line items in an order, making a full refund.
google_content.orders.cancel({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order to cancel.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Cancels a line item, making a full refund.
google_content.orders.cancellineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Notifies that item return and refund was handled directly in store.
google_content.orders.instorerefundlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Refund a portion of the order, up to the full amount paid.
google_content.orders.refund({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order to refund.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Rejects return on an line item.
google_content.orders.rejectreturnlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Returns a line item.
google_content.orders.returnlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Returns and refunds a line item. Note that this method can only be called on fully shipped orders.
google_content.orders.returnrefundlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Sets (overrides) merchant provided annotations on the line item.
google_content.orders.setlineitemmetadata({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Marks line item(s) as shipped.
google_content.orders.shiplineitems({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates ship by and delivery by dates for a line item.
google_content.orders.updatelineitemshippingdetails({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates the merchant order ID for a given order.
google_content.orders.updatemerchantorderid({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates a shipment's status, carrier, and/or tracking ID.
google_content.orders.updateshipment({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the order.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves an order using merchant order id.
google_content.orders.getbymerchantorderid({
"merchantId": "",
"merchantOrderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The merchant order id to be looked for.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the products in your Merchant Center account.
google_content.products.list({
"merchantId": ""
}, context)
object
boolean: Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).integer: The maximum number of products to return in the response, used for paging.string: The ID of the account that contains the products. This account cannot be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.
google_content.products.insert({
"merchantId": ""
}, context)
object
boolean: Flag to run the request in dry-run mode.string: The ID of the account that contains the product. This account cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Deletes a product from your Merchant Center account.
google_content.products.delete({
"merchantId": "",
"productId": ""
}, context)
object
boolean: Flag to run the request in dry-run mode.string: The ID of the account that contains the product. This account cannot be a multi-client account.string: The REST id of the product.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Output schema unknown
Retrieves a product from your Merchant Center account.
google_content.products.get({
"merchantId": "",
"productId": ""
}, context)
object
string: The ID of the account that contains the product. This account cannot be a multi-client account.string: The REST id of the product.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the statuses of the products in your Merchant Center account.
google_content.productstatuses.list({
"merchantId": ""
}, context)
object
boolean: Flag to include full product data in the results of the list request. The default value is false.boolean: Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).integer: The maximum number of product statuses to return in the response, used for paging.string: The ID of the account that contains the products. This account cannot be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Gets the status of a product from your Merchant Center account.
google_content.productstatuses.get({
"merchantId": "",
"productId": ""
}, context)
object
boolean: Flag to include full product data in the result of this get request. The default value is false.string: The ID of the account that contains the product. This account cannot be a multi-client account.string: The REST id of the product.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Lists the shipping settings of the sub-accounts in your Merchant Center account.
google_content.shippingsettings.list({
"merchantId": ""
}, context)
object
integer: The maximum number of shipping settings to return in the response, used for paging.string: The ID of the managing account. This must be a multi-client account.string: The token returned by the previous request.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves the shipping settings of the account.
google_content.shippingsettings.get({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account for which to get/update shipping settings.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates the shipping settings of the account. This method supports patch semantics.
google_content.shippingsettings.patch({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account for which to get/update shipping settings.boolean: Flag to run the request in dry-run mode.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Updates the shipping settings of the account.
google_content.shippingsettings.update({
"accountId": "",
"merchantId": ""
}, context)
object
string: The ID of the account for which to get/update shipping settings.boolean: Flag to run the request in dry-run mode.string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves supported carriers and carrier services for an account.
google_content.shippingsettings.getsupportedcarriers({
"merchantId": ""
}, context)
object
string: The ID of the account for which to retrieve the supported carriers.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Retrieves supported holidays for an account.
google_content.shippingsettings.getsupportedholidays({
"merchantId": ""
}, context)
object
string: The ID of the account for which to retrieve the supported holidays.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Sandbox only. Creates a test order.
google_content.orders.createtestorder({
"merchantId": ""
}, context)
object
string: The ID of the account that should manage the order. This cannot be a multi-client account.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".
google_content.orders.advancetestorder({
"merchantId": "",
"orderId": ""
}, context)
object
string: The ID of the account that manages the order. This cannot be a multi-client account.string: The ID of the test order to modify.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
google_content.orders.gettestordertemplate({
"merchantId": "",
"templateName": ""
}, context)
object
string: The ID of the account that should manage the order. This cannot be a multi-client account.string (values: template1, template1a, template1b, template2): The name of the template to retrieve.string (values: json): Data format for the response.string: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.string: IP address of the site where the request originates. Use this if you want to enforce per-user limits.object: Account data.
boolean: Indicates whether the merchant sells adult content.array: List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
string: Merchant Center account ID.string: Identifies what kind of resource this is. Value: the fixed string "content#account".string: Display name for the account.string: URL for individual seller reviews, i.e., reviews for each child account.string: Client-specific, locally-unique, internal ID for the child account.array: Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
string: The merchant's website.array: List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
object
string: Customer ID of the AdWords account.string: Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.object
string: The GMB email address.string: Status of the link between this Merchant Center account and the GMB account.object
string: The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).string: The merchant account ID, set for individual accounts and subaccounts.object: The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
string: The ID of the account for which the status is reported.array: A list of account level issues.
array: A list of data quality issues.
string: Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".boolean: Whether the account's website is claimed or not.object
string: Country for which this issue is reported.string: Additional details about the issue.string: Issue identifier.string: Severity of the issue.string: Short description of the issue.object
string: Country for which this issue is reported.string: A more detailed description of the issue.string: Actual value displayed on the landing page.array: Example items featuring the issue.
string: Issue identifier.string: Last time the account was checked for this issue.string: The attribute name that is relevant for the issue.integer: Number of items in the account found to have the said issue.string: Severity of the problem.string: Submitted value that causes the issue.object: An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
string: Unique item ID as specified in the uploaded product data.string: Landing page of the item.string: The item value that was submitted.string: Title of the item.string: The actual value on the landing page.object: The tax settings of a merchant account.
string: The ID of the account to which these account tax settings belong.string: Identifies what kind of resource this is. Value: the fixed string "content#accountTax".array: Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
object: Tax calculation rule to apply in a state or province (USA only).
string: Country code in which tax is applicable.string: State (or province) is which the tax is applicable, described by its location id (also called criteria id).string: Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.boolean: If true, shipping charges are also taxed.boolean: Whether the tax rate is taken from a global tax table or specified explicitly.object
boolean: Whether user is an admin.string: User's email address.object
string: Channel ID.string: Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.object
array: The account identifiers corresponding to the authenticated user.
string: Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".object
string: Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch accounts request.
string: The ID of the targeted account. Only defined if the method is get, delete or claimwebsite.integer: An entry ID, unique within the batch request.boolean: Whether the account should be deleted if the account has offers. Only applicable if the method is delete.string: The ID of the managing account.stringboolean: Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict.object
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".object: A batch entry encoding a single non-batch accounts response.
object
string: Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".string: The token for the retrieval of the next page of accounts.array
object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch accountstatuses request.
string: The ID of the (sub-)account whose status to get.integer: An entry ID, unique within the batch request.string: The ID of the managing account.string: The method (get).object
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse".object: A batch entry encoding a single non-batch accountstatuses response.
integer: The ID of the request entry this entry responds to.object
string: Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".string: The token for the retrieval of the next page of account statuses.array
object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch accounttax request.
string: The ID of the account for which to get/update account tax settings.integer: An entry ID, unique within the batch request.string: The ID of the managing account.stringobject
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".object: A batch entry encoding a single non-batch accounttax response.
integer: The ID of the request entry this entry responds to.string: Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry".object
string: Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".string: The token for the retrieval of the next page of account tax settings.array
object
string: Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.string: Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.string: Name of the carrier rate. Must be unique per rate group. Required.string: Shipping origin for this carrier rate. Required.string: Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.object
string: The CLDR country code of the carrier (e.g., "US"). Always present.string: The name of the carrier (e.g., "UPS"). Always present.array: A list of supported services (e.g., "ground") for that carrier. Contains at least one service.
stringobject: Datafeed configuration data.
string: The two-letter ISO 639-1 language in which the attributes are defined in the data feed.string: [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.string: The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.string: The filename of the feed. All feeds must have a unique file name.string: The ID of the data feed.array: [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
stringstring: Identifies what kind of resource this is. Value: the fixed string "content#datafeed".string: A descriptive name of the data feed.string: [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.array: The targets this feed should apply to (country, language, destinations).
object: The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.
integer: The day of the month the feed file should be fetched (1-31).string: The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.integer: The hour of the day the feed file should be fetched (0-23).integer: The minute of the hour the feed file should be fetched (0-59). Read-only.string: An optional password for fetch_url.boolean: Whether the scheduled fetch is paused or not.string: Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".string: An optional user name for fetch_url.string: The day of the week the feed file should be fetched.object
string: Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.string: Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.string: Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.object: The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
string: The country for which the status is reported, represented as a CLDR territory code.string: The ID of the feed for which the status is reported.array: The list of errors occurring in the feed.
string: The number of items in the feed that were processed.string: The number of items in the feed that were valid.string: Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".string: The two-letter ISO 639-1 language for which the status is reported.string: The last date at which the feed was uploaded.string: The processing status of the feed.array: The list of errors occurring in the feed.
object: An error occurring in the feed, like "invalid price".
string: The code of the error, e.g., "validation/invalid_value".string: The number of occurrences of the error in the feed.array: A list of example occurrences of the error, grouped by product.
string: The error message, e.g., "Invalid price".object: An example occurrence for a particular error.
string: The ID of the example item.string: Line number in the data feed where the example is found.string: The problematic value.object
string: The country where the items in the feed will be included in the search index, represented as a CLDR territory code.array: The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
stringarray: The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
stringstring: The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch datafeeds request.
integer: An entry ID, unique within the batch request.string: The ID of the data feed to get or delete.string: The ID of the managing account.stringobject
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".object: A batch entry encoding a single non-batch datafeeds response.
object
string: Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".string: The token for the retrieval of the next page of datafeeds.array
object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch datafeedstatuses request.
integer: An entry ID, unique within the batch request.string: The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required.string: The ID of the data feed to get.string: The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.string: The ID of the managing account.stringobject
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".object: A batch entry encoding a single non-batch datafeedstatuses response.
integer: The ID of the request entry this entry responds to.object
string: Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".string: The token for the retrieval of the next page of datafeed statuses.array
object
array: Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
integer: Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.integer: Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.object: An error returned by the API.
string: The domain of the error.string: A description of the error.string: The error code.object: A list of errors returned by a failed batch entry.
integer: The HTTP status of the first error in errors.array: A list of errors.
string: The message of the first error in errors.object: A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set.
array: A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
array: A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
stringarray: A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
stringarray: A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
array: A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
object
string: Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.integer: Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.string: Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.string: Unique identifier for the holiday. Required.string: Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.object
string: The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.string: Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.string: Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present.string: Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.string: Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.string: The holiday type. Always present.object
string: The number of installments the buyer has to pay.object
string: The availability of the product.string: Identifies what kind of resource this is. Value: the fixed string "content#inventory".integer: The quantity of the product. Must be equal to or greater than zero. Supported only for local products.string: A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.integer: The quantity of the product that is reserved for sell-on-google ads. Supported only for online products.object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch inventory request.
integer: An entry ID, unique within the batch request.string: The ID of the managing account.string: The ID of the product for which to update price and availability.string: The code of the store for which to update price and availability. Use online to update price and availability of an online product.object
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse".object: A batch entry encoding a single non-batch inventory response.
integer: The ID of the request entry this entry responds to.string: Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponseEntry".object
string: Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with pickupSla.string: The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with pickupMethod.object
string: The availability of the product.integer: The quantity of the product. Must be equal to or greater than zero. Supported only for local products.string: A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.integer: The quantity of the product that is reserved for sell-on-google ads. Supported only for online products.object
string: Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse".object
array: A non-empty list of location IDs. They must all be of the same location type (e.g., state).
stringobject
string: Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.string: The retailer's loyalty points in absolute value.number: The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.object
boolean: Whether the order was acknowledged.string: The channel type of the order: "purchaseOnGoogle" or "googleExpress".string: The REST id of the order. Globally unique.string: Identifies what kind of resource this is. Value: the fixed string "content#order".array: Line items that are ordered.
stringstring: Merchant-provided id of the order.string: The status of the payment.string: The date when the order was placed, in ISO 8601 format.array: The details of the merchant provided promotions applied to the order. More details about the program are here.
array: Refunds for the order.
array: Shipments of the order.
string: The requested shipping option.string: The status of the order.object
string: CLDR country code (e.g. "US").array: Strings representing the lines of the printed label for mailing the order, for example:
stringboolean: Whether the address is a post office box.string: City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).string: Postal Code or ZIP (e.g. "94043").string: Name of the recipient.string: Top-level administrative subdivision of the country (e.g. "CA").array: Street-level part of the address.
stringobject
string: The actor that created the cancellation.string: Date on which the cancellation has been created, in ISO 8601 format.integer: The quantity that was canceled.string: The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.string: The explanation of the reason.object
string: Email address of the customer.boolean: If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the checkout flow.string: Full name of the customer.object
string: The phone number of the person receiving the delivery.object
array: Annotations that are attached to the line item.
array: Cancellations of the line item.
string: The id of the line item.integer: Number of items canceled.integer: Number of items delivered.integer: Number of items ordered.integer: Number of items pending.integer: Number of items returned.integer: Number of items shipped.array: Returns of the line item.
object
string: Brand of the item.string: The item's channel (online or local).string: Condition or state of the item.string: The two-letter ISO 639-1 language code for the item.string: Global Trade Item Number (GTIN) of the item.string: The REST id of the product.string: URL of an image of the item.string: Shared identifier for all variants of the same product.string: Manufacturer Part Number (MPN) of the item.string: An identifier of the item.string: URL to the cached image shown to the user when order was placed.string: The CLDR territory code of the target country of the product.string: The title of the product.array: Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
object
string: The dimension of the variant.string: The value for the dimension.object
integer: How many days later the item can be returned.boolean: Whether the item is returnable.string: URL of the item return policy.object
string: The delivery by date, in ISO 8601 format.string: The ship by date, in ISO 8601 format.object
string: The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values.integer: Maximum transit time.string: The name of the shipping method.integer: Minimum transit time.object
string: Key for additional merchant provided (as key-value pairs) annotation about the line item.string: Value for additional merchant provided (as key-value pairs) annotation about the line item.object
integer: The card expiration month (January = 1, February = 2 etc.).integer: The card expiration year (4-digit, e.g. 2015).string: The last four digits of the card number.string: The billing phone number.string: The type of instrument.object
array
string: The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.string: Optional. The text code that corresponds to the promotion when applied on the retailer?s website.string: The unique ID of the promotion.string: The full title of the promotion.string: Whether the promotion is applicable to all products or only specific products.string: Indicates that the promotion is valid online.object
array: The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
stringstring: Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.string: Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).object
string: The actor that created the refund.string: Date on which the item has been created, in ISO 8601 format.string: The reason for the refund.string: The explanation of the reason.object
string: The actor that created the refund.string: Date on which the item has been created, in ISO 8601 format.integer: Quantity that is returned.string: The reason for the return.string: The explanation of the reason.object
string: The carrier handling the shipment.string: Date on which the shipment has been created, in ISO 8601 format.string: Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delieveredstring: The id of the shipment.array: The line items that are shipped.
string: The status of the shipment.string: The tracking id for the shipment.object
string: The id of the line item that is shipped. Either lineItemId or productId is required.string: The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity that is shipped.object
string: The ID of the operation. Unique across all operations for a given order.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".object
string: Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".object
string: The ID of the line item to cancel. Either lineItemId or productId is required.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to cancel.string: The reason for the cancellation.string: The explanation of the reason.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".object
string: The ID of the operation. Unique across all operations for a given order.string: The reason for the cancellation.string: The explanation of the reason.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".object
string: The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template.object
string: Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".string: The ID of the newly created test order.object
array: The request entries to be processed in the batch.
object
integer: An entry ID, unique within the batch request.string: The ID of the managing account.string: The merchant order id. Required for updateMerchantOrderId and getByMerchantOrderId methods.string: The method to apply.string: The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId.string: The ID of the order. Required for all methods beside getByMerchantOrderId.object
string: The reason for the cancellation.string: The explanation of the reason.object
string: The ID of the line item to cancel. Either lineItemId or productId is required.string: The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to cancel.string: The reason for the cancellation.string: The explanation of the reason.object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return and refund.string: The reason for the return.string: The explanation of the reason.object
object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return and refund.string: The reason for the return.string: The explanation of the reason.object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return.string: The reason for the return.string: The explanation of the reason.object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return and refund.string: The reason for the return.string: The explanation of the reason.object
array
string: The ID of the line item to set metadata. Either lineItemId or productId is required.string: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.object
string: Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.array: Line items to ship.
string: Deprecated. Please use shipmentInfo instead. The ID of the shipment.array: Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
string: Deprecated. Please use shipmentInfo instead. The tracking id for the shipment.object
string: The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.string: The ID of the shipment.string: The tracking id for the shipment.object
string: Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.string: The ID of the line item to set metadata. Either lineItemId or productId is required.string: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.string: Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated.object
string: The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.string: The ID of the shipment.string: New status for the shipment. Not updated if missing.string: The tracking id for the shipment. Not updated if missing.object
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse".object
integer: The ID of the request entry this entry responds to.string: The status of the execution. Only defined if the method is not get or getByMerchantOrderId and if the request was successful.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry".object
string: Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".object
string: Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return and refund.string: The reason for the return.string: The explanation of the reason.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse".object
string: Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".string: The token for the retrieval of the next page of orders.array
object
object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse".object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return and refund.string: The reason for the return.string: The explanation of the reason.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse".object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return.string: The reason for the return.string: The explanation of the reason.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse".object
string: The ID of the line item to return. Either lineItemId or productId is required.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer: The quantity to return and refund.string: The reason for the return.string: The explanation of the reason.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse".object
array
string: The ID of the line item to set metadata. Either lineItemId or productId is required.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse".object
string: Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.array: Line items to ship.
string: The ID of the operation. Unique across all operations for a given order.string: Deprecated. Please use shipmentInfo instead. The ID of the shipment.array: Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
string: Deprecated. Please use shipmentInfo instead. The tracking id for the shipment.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".object
string: Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.string: The ID of the line item to set metadata. Either lineItemId or productId is required.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.string: Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse".object
string: The merchant order id to be assigned to the order. Must be unique per merchant.string: The ID of the operation. Unique across all operations for a given order.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".object
string: The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.string: The ID of the operation. Unique across all operations for a given order.string: The ID of the shipment.string: New status for the shipment. Not updated if missing.string: The tracking id for the shipment. Not updated if missing.object
string: The status of the execution.string: Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".object
string: The CLDR territory code of the country the postal code group applies to. Required.string: The name of the postal code group, referred to in headers. Required.array: A range of postal codes. Required.
object
string: A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.string: A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.object
string: The currency of the price.string: The price represented as a number.object: Product data.
array: Additional URLs of images of the item.
stringarray: Additional categories of the item (formatted as in products feed specification).
stringboolean: Set to true if the item is targeted towards adults.string: Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.array: Similar to adwords_grouping, but only works on CPC.
stringstring: Allows advertisers to override the item URL when the product is shown within the context of Product Ads.string: Target age group of the item.array: Specifies the intended aspects for the product.
string: Availability status of the item.string: The day a pre-ordered product becomes available for delivery, in ISO 8601 format.string: Brand of the item.string: The item's channel (online or local).string: Color of the item.string: Condition or state of the item.string: The two-letter ISO 639-1 language code for the item.array: A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
array: A list of custom (merchant-provided) custom attribute groups.
string: Custom label 0 for custom grouping of items in a Shopping campaign.string: Custom label 1 for custom grouping of items in a Shopping campaign.string: Custom label 2 for custom grouping of items in a Shopping campaign.string: Custom label 3 for custom grouping of items in a Shopping campaign.string: Custom label 4 for custom grouping of items in a Shopping campaign.string: Description of the item.array: Specifies the intended destinations for the product.
string: An identifier for an item for dynamic remarketing campaigns.string: URL directly to your item's landing page for dynamic remarketing campaigns.array: Advertiser-specified recommendations.
stringstring: Title of an item for dynamic remarketing campaigns.number: Offer margin for dynamic remarketing campaigns.string: The energy efficiency class as defined in EU directive 2010/30/EU.string: Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.string: Target gender of the item.string: Google's category of the item (see Google product taxonomy).string: Global Trade Item Number (GTIN) of the item.string: The REST id of the product. Content API methods that operate on products take this as their productId parameter.boolean: False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.string: URL of an image of the item.boolean: Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.string: Shared identifier for all variants of the same product.string: Identifies what kind of resource this is. Value: the fixed string "content#product".string: URL directly linking to your item's page on your website.string: The material of which the item is made.string: Maximal product handling time (in business days).string: Minimal product handling time (in business days).string: Link to a mobile-optimized version of the landing page.string: Manufacturer Part Number (MPN) of the item.string: The number of identical products in a merchant-defined multipack.string: A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.boolean: Whether an item is available for purchase only online.string: The item's pattern (e.g. polka dots).string: Your category of the item (formatted as in products feed specification).array: The unique ID of a promotion.
stringstring: Date range during which the item is on sale (see products feed specification).string: The quantity of the product that is reserved for sell-on-google ads.array: Shipping rules.
string: The shipping label of the product, used to group product in account-level shipping rules.string: System in which the size is specified. Recommended for apparel items.string: The cut of the item. Recommended for apparel items.array: Size of the item.
stringstring: The CLDR territory code for the item.array: Tax information.
string: Title of the item.array: The read-only list of intended destinations which passed validation.
stringarray: Read-only warnings.
object
string: The name of the aspect.string: The name of the destination. Leave out to apply to all destinations.string: Whether the aspect is required, excluded or should be validated.object
string: The name of the attribute. Underscores will be replaced by spaces upon insertion.string: The type of the attribute.string: Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.string: The value of the attribute.object
array: The sub-attributes.
string: The name of the group. Underscores will be replaced by spaces upon insertion.object
string: The name of the destination.string: Whether the destination is required, excluded or should be validated.object
string: The CLDR territory code of the country to which an item will ship.string: The location where the shipping is applicable, represented by a location group name.string: The numeric id of a location that the shipping rate applies to as defined in the AdWords API.string: The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.string: The geographic region to which a shipping rate applies.string: A free-form description of the service class or delivery speed.object
string: The unit of value.number: The dimension of the product used to calculate the shipping cost of the item.object
string: The unit of value.number: The weight of the product used to calculate the shipping cost of the item.object: The status of a product, i.e., information about a product computed asynchronously by the data quality analysis.
string: Date on which the item has been created, in ISO 8601 format.array: A list of data quality issues associated with the product.
array: The intended destinations for the product.
string: Date on which the item expires in Google Shopping, in ISO 8601 format.array: A list of all issues associated with the product.
string: Identifies what kind of resource this is. Value: the fixed string "content#productStatus".string: Date on which the item has been last updated, in ISO 8601 format.string: The link to the product.string: The id of the product for which status is reported.string: The title of the product.object
string: A more detailed error string.string: The fetch status for landing_page_errors.string: The id of the data quality issue.string: The attribute name that is relevant for the issue.string: The severity of the data quality issue.string: The time stamp of the data quality issue.string: The value of that attribute that was found on the landing pagestring: The value the attribute had at time of evaluation.object
boolean: Whether the approval status might change due to further processing.string: The destination's approval status.string: The name of the destinationstring: Provided for backward compatibility only. Always set to "required".object
string: The attribute's name, if the issue is caused by a single attribute.string: The error code of the issue.string: The destination the issue applies to.string: Whether the issue can be resolved by the merchant.string: How this issue affects serving of the offer.object
string: The country within which the item is taxed, specified as a CLDR territory code.string: The numeric id of a location that the tax rate applies to as defined in the AdWords API.string: The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.number: The percentage of tax rate that applies to the item price.string: The geographic region to which the tax rate applies.boolean: Set to true if tax is charged on shipping.object
string: The unit of the denominator.string: The denominator of the unit price.object
string: The unit of the measure.number: The measure of an item.object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch products request.
integer: An entry ID, unique within the batch request.string: The ID of the managing account.stringstring: The ID of the product to get or delete. Only defined if the method is get or delete.object
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".object: A batch entry encoding a single non-batch products response.
object
string: Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse".string: The token for the retrieval of the next page of products.array
object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch productstatuses request.
integer: An entry ID, unique within the batch request.booleanstring: The ID of the managing account.stringstring: The ID of the product whose status to get.object
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse".object: A batch entry encoding a single non-batch productstatuses response.
integer: The ID of the request entry this entry responds to.string: Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry".object
string: Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse".string: The token for the retrieval of the next page of products statuses.array
object
array: A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
stringarray: A list of carrier rates that can be referred to by mainTable or singleValue.
array: A list of subtables referred to by mainTable. Can only be set if mainTable is set.
object
array: The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
object
boolean: A boolean exposing the active status of the shipping service. Required.string: The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.string: The CLDR territory code of the country to which the service applies. Required.string: Free-form name of the service. Must be unique within target account. Required.array: Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
object: The merchant account's shipping settings.
string: The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.array: A list of postal code groups that can be referred to in services. Optional.
array: The target account's list of services. Optional.
object
array: The request entries to be processed in the batch.
object: A batch entry encoding a single non-batch shippingsettings request.
string: The ID of the account for which to get/update account shipping settings.integer: An entry ID, unique within the batch request.string: The ID of the managing account.stringobject
array: The result of the execution of the batch requests.
string: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".object: A batch entry encoding a single non-batch shipping settings response.
integer: The ID of the request entry to which this entry responds.string: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry".object
array: A list of supported carriers. May be empty.
string: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".object
array: A list of holidays applicable for delivery guarantees. May be empty.
string: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".object
string: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".string: The token for the retrieval of the next page of shipping settings.array
object
object
string: Identifies what kind of resource this is. Value: the fixed string "content#testOrder".array: Line items that are ordered. At least one line item must be provided.
string: Determines if test order must be pulled by merchant or pushed to merchant via push integration.string: Identifier of one of the predefined delivery addresses for the delivery.array: The details of the merchant provided promotions applied to the order. More details about the program are here.
string: The requested shipping option.object
string: Email address of the customer.boolean: If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the checkout flow. Optional.string: Full name of the customer.object
integer: Number of items ordered.object
string: Brand of the item.string: The item's channel.string: Condition or state of the item.string: The two-letter ISO 639-1 language code for the item.string: Global Trade Item Number (GTIN) of the item. Optional.string: URL of an image of the item.string: Shared identifier for all variants of the same product. Optional.string: Manufacturer Part Number (MPN) of the item. Optional.string: An identifier of the item.string: The CLDR territory code of the target country of the product.string: The title of the product.array: Variant attributes for the item. Optional.
object
integer: The card expiration month (January = 1, February = 2 etc.).integer: The card expiration year (4-digit, e.g. 2015).string: The last four digits of the card number.string: The billing address.string: The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.object: The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
string: The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.boolean: If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.string: A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.string: The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.object
string: The weight unit.string: The weight represented as a number.FAQs
DataFire integration for Content API for Shopping
The npm package @datafire/google_content receives a total of 0 weekly downloads. As such, @datafire/google_content popularity was classified as not popular.
We found that @datafire/google_content demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.