Skip to main content

Google Shopping Component

The Google Content API for Shopping can be used to manage and automate Google Merchant Center account management.

Component key: google-content-shopping

Description

The Google Content API for Shopping can be used to manage and automate Google Merchant Center account management. Use the Google Content API to Upload Products, Manage Inventory, and Manage Orders and Returns.

Connections

OAuth2

All requests to the Google Content API for Shopping must be authorized by an authenticated user.

The details of the authorization process, or "flow," for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:

  1. When you create your application, you register it using the Google API Console. Google then provides information you'll need later, such as a client ID and a client secret.
  2. From APIs & Services > Library, activate the Google Content API for Shopping
  3. To create API Credentials navigate to Enabled APIs & Services and select Content API for Shopping
    1. Select Create Credentials
    2. Ensure Content API for Shopping is set for Select an API
    3. Choose User Data and select Next
    4. Fill out the OAuth consent screen with an app name (your company or product's name), support email, app logo, domain, etc.
    5. Select Add Or Remove scopes, search Content API for Shopping, and check the boxes for the following scopes
      1. https://capture.dropbox.com/yONkE7x1vw9doIJ9
    6. For OAuth Client ID, under Application type select Web application. Under Authorized redirect URIs enter the OAuth 2.0 callback URL: https://oauth2.prismatic.io/callback and then click CREATE.
      1. Take note of the Client ID and Client Secret that are generated, as you will enter them for authentication.
    7. Client Id and Secret can also be obtained in the Credentials Page under the OAuth 2.0 Client IDs section by selecting the name of the OAuth client created.
InputNotesExample
Authorize URL

The Authorization URL for Google Content.

https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent
Client ID

The Google Content app's Client Identifier.

Client Secret

The Google Content app's Client Secret.

Scopes

Space delimited listing of scopes. https://developers.google.com/identity/protocols/oauth2/scopes#content

https://www.googleapis.com/auth/content
Token URL

The Token URL for Google Content.

https://oauth2.googleapis.com/token

Triggers

PubSub Notification

PubSub Notification Trigger Settings | key: myTrigger

The Push Notifications service lets you to receive notifications that an order has been created. This is called "push" since Google will push notifications to you about events, such as orders, that happen on the Google side.

  • The Content API's pubsubnotificationsettings.update receives the request and sends you back a cloudTopicName.

  • To configure additional Topics

    • In the Google Cloud console, select the navigation menu scroll to the Pub/Sub page (Navigation Menu > More Products > Analytics > Pub/Sub)
    • In the Topics page, click Create Topic
      • In the window that opens, enter MyTopic in the Topic ID field.
        • Leave the default values for the remaining options, and then click Create.
        • You see the success message: A new topic and a new subscription have been successfully created.
        • You have just created a topic called MyTopic and an associated default subscription MyTopic-sub.
  • You create a subscription for the topic and register the URL push endpoint with Cloud Pub/Sub.

  • To Configure Subscription go to Pub/Sub > Subscriptions

    • In the Subscriptions page, click Create subscription.
    • Enter MySub in the Subscription ID field.
    • For Select a Cloud Pub/Sub topic, select the MyTopic topic from the drop-down menu
    • Leave the default values for the remaining options.
    • Click Create
      • You see the success message: Subscription successfully added.
    • Click the Topics page and click MyTopic.
      • The MySub subscription is now attached to the topic

        MyTopic. Pub/Sub delivers all messages sent to

        MyTopic to the MySub and MyTopic-sub subscriptions.

  • Cloud Pub/Sub accepts your subscription and associates that cloudTopicName with your URL. When messages are published to that cloudTopicName (for example, your order notifications), they will be sent to your URL push endpoint.

Request

PUT https://shoppingcontent.googleapis.com/content/v2.1/merchantId/pubsubnotificationsettings


Actions

Batch Local Inventory

Updates local inventory for multiple products or regions in a single request. | key: batchLocalInventory

InputNotesExample
Connection
Entries for Batch Request

Entries


Batch Product

Retrieves, inserts, and deletes multiple products in a single request. | key: batchProduct

InputNotesExample
Connection
Entries for Batch Request

Entries


Batch Regional Inventory

Updates regional inventory for multiple products or regions in a single request. | key: batchRegionalInventory

InputNotesExample
Connection
Entries for Batch Request

Entries


Cancel Order

Cancels all line items in an order, making a full refund. | key: cancelOrder

InputNotesExample
Connection
Merchant Id

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.

Operation Id

The ID of the operation. Unique across all operations for a given order.

Order Id

The ID of the order.

Reason

The reason for the cancellation.

Reason Text

The explanation of the reason.


Create Account

Creates a Merchant Center sub-account. | key: createAccount

InputNotesExample
Account Management

Controls which fields will be populated. Acceptable values are: 'merchant' and 'css'. The default value is 'merchant'.

Ads Links

Linked Ads 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 Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.

Adult Content

Indicates whether the merchant sells adult content.

false
Automatic Improvements

The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.

Automatic Label Ids

Automatically created label IDs that are assigned to the account by CSS Center.

000xxx
Business Information

The business information of the account.

Connection
Conversion Settings

Settings for conversion tracking.

Css Id

ID of CSS the account belongs to

Google My Business Link

The Business Profile which is linked or in the process of being linked with the Merchant Center account.

Kind

Identifies what kind of resource this is. Value: the fixed string 'content#account'.

Label Ids

Manually created label IDs that are assigned to the account by CSS.

000xxx
Merchant Id

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.

Name

Display name for the account.

Seller Id

Client-specific, locally-unique, internal ID for the child account.

User

Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

Website Url

The merchant's website.

Youtube Channel Links

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.


Create Order Return

Create return in your Merchant Center account. | key: createOrderReturn

InputNotesExample
Connection
Line Items

The list of line items to return.

Merchant Id

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.

Operation Id

The ID of the operation. Unique across all operations for a given order.

Order Id

The ID of the order.

Return Method Type

The way of the package being returned.


Create Product

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. | key: createProduct

InputNotesExample
Additional Image Links

Additional URLs of images of the item.

000xxx
Additional Size Type

Additional cut of the item. Used together with sizeType to represent combined size types for apparel items.

Ads Grouping

Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.

Ads Labels

Similar to adsGrouping, but only works on CPC.

000xxx
Ads Redirect

Allows advertisers to override the item URL when the product is shown within the context of Product Ads.

Adult

Should be set to true if the item is targeted towards adults.

false
Age Group

Target age group of the item.

Availability

Availability status of the item.

Availability Date

The day a pre-ordered product becomes available for delivery, in ISO 8601 format.

Brand

Brand of the item.

Canonical Link

URL for the canonical version of your item's landing page.

Channel

The item's channel (online or local).

Color

Color of the item.

Condition

Condition or state of the item.

Connection
Content Language

The two-letter ISO 639-1 language code for the item.

Cost Of Goods Sold

Cost of goods sold. Used for gross profit reporting.

Custom Attributes

A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, { 'name': 'size type', 'value': 'regular' }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).

Custom Label 0

Custom Label 0 for custom grouping of items in a Shopping campaign.

Custom Label 1

Custom Label 1 for custom grouping of items in a Shopping campaign.

Custom Label 2

Custom Label 2 for custom grouping of items in a Shopping campaign.

Custom Label 3

Custom Label 3 for custom grouping of items in a Shopping campaign.

Custom Label 4

Custom Label 4 for custom grouping of items in a Shopping campaign.

Description

Description of the item.

Display Ads Id

An identifier for an item for dynamic remarketing campaigns.

Display Ads Link

URL directly to your item's landing page for dynamic remarketing campaigns.

Display Ads Similar Ids

Advertiser-specified recommendations.

000xxx
Display Ads Title

Title of an item for dynamic remarketing campaigns.

Display Ads Value

Offer margin for dynamic remarketing campaigns.

Energy Efficiency Class

The energy efficiency class as defined in EU directive 2010/30/EU.

Excluded Destinations

The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.

000xxx
Expiration Date

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.

External Seller Id

Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.

Feed Id

The Content API Supplemental Feed ID. If present then product deletion applies to the data in a supplemental feed. If absent, entire product will be deleted.

Feed Label

Feed label for the item. Either targetCountry or feedLabel is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).

Gender

Target gender of the item.

Google Product Category

Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.

GTIN

Global Trade Item Number (GTIN) of the item.

Identifier Exists

Date range during which the item is on sale

false
Image Link

URL of an image of the item.

Included Destinations

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 excludedDestinations.

000xxx
Installment

Number and amount of installments to pay for an item.

Is Bundle

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.

false
Item Group Id

Shared identifier for all variants of the same product.

Kind

Identifies what kind of resource this is. Value: the fixed string 'content#account'.

Lifestyle Image Links

Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context.

000xxx
Link

URL directly linking to your item's page on your website.

Link Template

URL template for merchant hosted local storefront.

Material

The material of which the item is made.

Max Energy Efficiency Class

The energy efficiency class as defined in EU directive 2010/30/EU.

Max Handling Time

Maximal product handling time (in business days).

Merchant Id

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.

Min Energy Efficiency Class

The energy efficiency class as defined in EU directive 2010/30/EU.

Min Handling Time

Minimal product handling time (in business days).

Mobile Link

URL for the mobile-optimized version of your item's landing page.

Mobile Link Template

URL template for merchant hosted local storefront optimized for mobile devices.

MPN

Manufacturer Part Number (MPN) of the item.

Multipack

The number of identical products in a merchant-defined multipack.

Offer Id

Required. 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. Note: Content API methods that operate on products take the REST ID of the product, not this identifier.

Pattern

The item's pattern (for example, polka dots).

Pause

Publication of this item should be temporarily paused.

Pickup Method

The pick up option for the item.

Pickup Sla

Item store pickup timeline.

Price

Price of the item.

Product Details

Technical specification or additional product details.

Product Height

The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Product Highlights

Bullet points describing the most relevant highlights of a product.

000xxx
Product Length

The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Product Types

Categories of the item (formatted as in product data specification).

000xxx
Product Weight

The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).

Product Width

The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Promotion Ids

The unique ID of a promotion.

000xxx
Sale Price

Advertised sale price of the item.

Sale Price Effective Date

Date range during which the item is on sale

Sell On Google Quantity

The quantity of the product that is available for selling on Google. Supported only for online products.

Shipping

Array of shipping rules.

Shipping Height

Height of the item for shipping.

Shipping Label

The shipping label of the product, used to group product in account-level shipping rules.

Shipping Length

Length of the item for shipping.

Shipping Weight

Weight of the item for shipping.

Shipping Width

Width of the item for shipping.

Shopping Ads Excluded Countries

products.list of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.

000xxx
Sizes

Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value

000xxx
Size System

System in which the size is specified. Recommended for apparel items.

Size Type

The cut of the item. Recommended for apparel items.

Source

The source of the offer, that is, how the offer was created.

Subscription Cost

Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.

Target Country

The CLDR territory code for the item's country of sale.

Tax Category

The energy efficiency class as defined in EU directive 2010/30/EU.

Taxes

Array with tax information.

Title

Title of the item.

Transit Time Label

The transit time label of the product, used to group product in account-level transit time tables.

Unit Pricing Base Measure

The preference of the denominator of the unit price.

Unit Pricing Measure

The measure and dimension of an item.


Delete Account

Deletes a Merchant Center sub-account. | key: deleteAccount

InputNotesExample
Account Id

The ID of the account.

Connection
Merchant Id

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.


Delete Product

Deletes a product from your Merchant Center account. | key: deleteProduct

InputNotesExample
Connection
Feed Id

The Content API Supplemental Feed ID. If present then product deletion applies to the data in a supplemental feed. If absent, entire product will be deleted.

Merchant Id

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.

Product Id

The REST ID of the product.


Get Account

Retrieves a Merchant Center account. | key: getAccount

InputNotesExample
Account Id

The ID of the account.

Connection
Merchant Id

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.

View

Controls which fields will be populated. Acceptable values are: 'merchant' and 'css'. The default value is 'merchant'.


Get Order

Retrieves an order from your Merchant Center account. | key: getOrder

InputNotesExample
Connection
Merchant Id

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.

Order Id

The ID of the order.


Get Order Return

Retrieves an order return from your Merchant Center account. | key: getOrderReturn

InputNotesExample
Connection
Merchant Id

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.

Return Id

Merchant order return ID generated by Google.


Get Product

Retrieves a product from your Merchant Center account. | key: getProduct

InputNotesExample
Connection
Merchant Id

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.

Product Id

The REST ID of the product.


Get PubSub Notification Settings

Retrieves a Merchant Center account's pubsub notification settings. | key: getPubSubNotification

InputNotesExample
Connection
Merchant Id

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.


List Accounts

Lists the sub-accounts in your Merchant Center account. | key: listAccounts

InputNotesExample
Connection
Label

If view is set to 'css', only return accounts that are assigned label with given ID.

Max Results

The maximum number of accounts to return in the response, used for paging.

Merchant Id

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.

Name

If set, only the accounts with the given name (case sensitive) will be returned.

Page Token

The token returned by the previous request.

View

Controls which fields will be populated. Acceptable values are: 'merchant' and 'css'. The default value is 'merchant'.


List Orders

Lists the orders in your Merchant Center account. | key: listOrders

InputNotesExample
Acknowledged

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.

false
Connection
Max Results

The maximum number of accounts to return in the response, used for paging.

Merchant Id

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.

Pause

Order results by placement date in descending or ascending order.

Page Token

The token returned by the previous request.

Placed Date End

Obtains orders placed before this date (inclusively), in ISO 8601 format.

Placed Date Start

Obtains orders placed after this date (inclusively), in ISO 8601 format.

Statuses

Obtains orders that match any of the specified statuses. Note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled.

000xxx

List Orders Returns

Lists order returns in your Merchant Center account. | key: listReturnsOrders

InputNotesExample
Acknowledged

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.

false
Connection
Created End Date

Obtains order returns created before this date (inclusively), in ISO 8601 format.

Created Start Date

Obtains order returns created after this date (inclusively), in ISO 8601 format.

Google Order Ids

Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

000xxx
Max Results

The maximum number of accounts to return in the response, used for paging.

Merchant Id

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.

Pause

Order results by placement date in descending or ascending order.

Page Token

The token returned by the previous request.

Shipment States

Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

000xxx
Shipment Status

Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

000xxx
Shipping Tracking Numbers

Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

000xxx
Shipment Types

Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

000xxx

List Products

Lists the products in your Merchant Center account. | key: listProducts

InputNotesExample
Connection
Max Results

The maximum number of accounts to return in the response, used for paging.

Merchant Id

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.

Page Token

The token returned by the previous request.


Process Order Return

Processes return in your Merchant Center account | key: processOrderReturn

InputNotesExample
Connection
Full Charge Return Shipping Cost

Option to charge the customer return shipping cost.

false
Merchant Id

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.

Operation Id

The ID of the operation. Unique across all operations for a given order.

Refund Shipping Fee

Refunds for original shipping fee.

Return Id

Merchant order return ID generated by Google.

Return Items

The list of items to return.


Raw Request

Send raw HTTP request to Google Content Shopping | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type.

false
Retry Delay (ms)

The delay in milliseconds between retries.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/{merchantId}/accounts), The base URL is already included (https://shoppingcontent.googleapis.com/content/{version}). For example, to connect to https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts, only /{merchantId}/accounts is entered in this field.

/{merchantId}/accounts
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries.

false
API Version

The API version to use. This is used to construct the base URL for the request.

v2.1

Update Account

Updates a Merchant Center account. Any fields that are not provided are deleted from the resource. | key: updateAccount

InputNotesExample
Account Id

The ID of the account.

Account Management

Controls which fields will be populated. Acceptable values are: 'merchant' and 'css'. The default value is 'merchant'.

Ads Links

Linked Ads 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 Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.

Adult Content

Indicates whether the merchant sells adult content.

false
Automatic Improvements

The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.

Automatic Label Ids

Automatically created label IDs that are assigned to the account by CSS Center.

000xxx
Business Information

The business information of the account.

Connection
Conversion Settings

Settings for conversion tracking.

Css Id

ID of CSS the account belongs to

Google My Business Link

The Business Profile which is linked or in the process of being linked with the Merchant Center account.

Kind

Identifies what kind of resource this is. Value: the fixed string 'content#account'.

Label Ids

Manually created label IDs that are assigned to the account by CSS.

000xxx
Merchant Id

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.

Name

Display name for the account.

Seller Id

Client-specific, locally-unique, internal ID for the child account.

User

Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

Website Url

The merchant's website.

Youtube Channel Links

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.


Update Product

Updates an existing product in your Merchant Center account. Only updates attributes provided in the request. | key: updateProduct

InputNotesExample
Additional Image Links

Additional URLs of images of the item.

000xxx
Additional Size Type

Additional cut of the item. Used together with sizeType to represent combined size types for apparel items.

Ads Grouping

Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.

Ads Labels

Similar to adsGrouping, but only works on CPC.

000xxx
Ads Redirect

Allows advertisers to override the item URL when the product is shown within the context of Product Ads.

Adult

Should be set to true if the item is targeted towards adults.

false
Age Group

Target age group of the item.

Availability

Availability status of the item.

Availability Date

The day a pre-ordered product becomes available for delivery, in ISO 8601 format.

Brand

Brand of the item.

Canonical Link

URL for the canonical version of your item's landing page.

Channel

The item's channel (online or local).

Color

Color of the item.

Condition

Condition or state of the item.

Connection
Content Language

The two-letter ISO 639-1 language code for the item.

Cost Of Goods Sold

Cost of goods sold. Used for gross profit reporting.

Custom Attributes

A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, { 'name': 'size type', 'value': 'regular' }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).

Custom Label 0

Custom Label 0 for custom grouping of items in a Shopping campaign.

Custom Label 1

Custom Label 1 for custom grouping of items in a Shopping campaign.

Custom Label 2

Custom Label 2 for custom grouping of items in a Shopping campaign.

Custom Label 3

Custom Label 3 for custom grouping of items in a Shopping campaign.

Custom Label 4

Custom Label 4 for custom grouping of items in a Shopping campaign.

Description

Description of the item.

Display Ads Id

An identifier for an item for dynamic remarketing campaigns.

Display Ads Link

URL directly to your item's landing page for dynamic remarketing campaigns.

Display Ads Similar Ids

Advertiser-specified recommendations.

000xxx
Display Ads Title

Title of an item for dynamic remarketing campaigns.

Display Ads Value

Offer margin for dynamic remarketing campaigns.

Energy Efficiency Class

The energy efficiency class as defined in EU directive 2010/30/EU.

Excluded Destinations

The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.

000xxx
Expiration Date

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.

External Seller Id

Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.

Feed Label

Feed label for the item. Either targetCountry or feedLabel is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).

Gender

Target gender of the item.

Google Product Category

Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.

GTIN

Global Trade Item Number (GTIN) of the item.

Identifier Exists

Date range during which the item is on sale

false
Image Link

URL of an image of the item.

Included Destinations

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 excludedDestinations.

000xxx
Installment

Number and amount of installments to pay for an item.

Is Bundle

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.

false
Item Group Id

Shared identifier for all variants of the same product.

Kind

Identifies what kind of resource this is. Value: the fixed string 'content#account'.

Lifestyle Image Links

Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context.

000xxx
Link

URL directly linking to your item's page on your website.

Link Template

URL template for merchant hosted local storefront.

Material

The material of which the item is made.

Max Energy Efficiency Class

The energy efficiency class as defined in EU directive 2010/30/EU.

Max Handling Time

Maximal product handling time (in business days).

Merchant Id

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.

Min Energy Efficiency Class

The energy efficiency class as defined in EU directive 2010/30/EU.

Min Handling Time

Minimal product handling time (in business days).

Mobile Link

URL for the mobile-optimized version of your item's landing page.

Mobile Link Template

URL template for merchant hosted local storefront optimized for mobile devices.

MPN

Manufacturer Part Number (MPN) of the item.

Multipack

The number of identical products in a merchant-defined multipack.

Offer Id

Required. 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. Note: Content API methods that operate on products take the REST ID of the product, not this identifier.

Pattern

The item's pattern (for example, polka dots).

Pause

Publication of this item should be temporarily paused.

Pickup Method

The pick up option for the item.

Pickup Sla

Item store pickup timeline.

Price

Price of the item.

Product Details

Technical specification or additional product details.

Product Height

The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Product Highlights

Bullet points describing the most relevant highlights of a product.

000xxx
Product Id

The REST ID of the product.

Product Length

The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Product Types

Categories of the item (formatted as in product data specification).

000xxx
Product Weight

The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).

Product Width

The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Promotion Ids

The unique ID of a promotion.

000xxx
Sale Price

Advertised sale price of the item.

Sale Price Effective Date

Date range during which the item is on sale

Sell On Google Quantity

The quantity of the product that is available for selling on Google. Supported only for online products.

Shipping

Array of shipping rules.

Shipping Height

Height of the item for shipping.

Shipping Label

The shipping label of the product, used to group product in account-level shipping rules.

Shipping Length

Length of the item for shipping.

Shipping Weight

Weight of the item for shipping.

Shipping Width

Width of the item for shipping.

Shopping Ads Excluded Countries

products.list of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.

000xxx
Sizes

Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value

000xxx
Size System

System in which the size is specified. Recommended for apparel items.

Size Type

The cut of the item. Recommended for apparel items.

Source

The source of the offer, that is, how the offer was created.

Subscription Cost

Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.

Target Country

The CLDR territory code for the item's country of sale.

Tax Category

The energy efficiency class as defined in EU directive 2010/30/EU.

Taxes

Array with tax information.

Title

Title of the item.

Transit Time Label

The transit time label of the product, used to group product in account-level transit time tables.

Unit Pricing Base Measure

The preference of the denominator of the unit price.

Unit Pricing Measure

The measure and dimension of an item.

Update Mask

The comma-separated list of product attributes to be updated. Example: 'title,salePrice'. Attributes specified in the update mask without a value specified in the body will be deleted from the product. You must specify the update mask to delete attributes. Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged. Only defined if the method is update.


Update Product Local Inventory

Updates the local inventory of a product in your Merchant Center account. | key: updateProductLocalInventory

InputNotesExample
Availability

Availability status of the item.

Connection
Custom Attributes

A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, { 'name': 'size type', 'value': 'regular' }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).

Instore Product Location

In-store product location.

Kind

Identifies what kind of resource this is. Value: the fixed string 'content#account'.

Merchant Id

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.

Pickup Method

The pick up option for the item.

Pickup Sla

Item store pickup timeline.

Price

Price of the item.

Product Id

The REST ID of the product.

Quantity

Quantity of the product. Must be nonnegative.

Sale Price

Advertised sale price of the item.

Sale Price Effective Date

Date range during which the item is on sale

Store Code

Store code of this local inventory resource.


Update Product Regional Inventory

Updates the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry. | key: updateProductRegionalInventory

InputNotesExample
Availability

Availability status of the item.

Connection
Custom Attributes

A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, { 'name': 'size type', 'value': 'regular' }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).

Kind

Identifies what kind of resource this is. Value: the fixed string 'content#account'.

Merchant Id

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.

Price

Price of the item.

Product Id

The REST ID of the product.

Region Id

The ID uniquely identifying each region.

Sale Price

Advertised sale price of the item.

Sale Price Effective Date

Date range during which the item is on sale


Update PubSub Notification

Register a Merchant Center account for pubsub notifications. Note that cloud topic name shouldn't be provided as part of the request. | key: updatePubSubNotification

InputNotesExample
Cloud Topic Name

Cloud pub/sub topic to which notifications are sent (read-only).

Connection
Kind

Identifies what kind of resource this is. Value: the fixed string 'content#account'.

Merchant Id

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.

Registered Events

List of event types.

000xxx