Close httplib2 connections.
custombatch(body=None, dryRun=None, x__xgafv=None)
Retrieves, inserts, and deletes multiple products in a single request.
delete(merchantId, productId, dryRun=None, x__xgafv=None)
Deletes a product from your Merchant Center account.
get(merchantId, productId, x__xgafv=None)
Retrieves a product from your Merchant Center account.
insert(merchantId, body=None, dryRun=None, x__xgafv=None)
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.
list(merchantId, maxResults=None, includeInvalidInsertedItems=None, pageToken=None, x__xgafv=None)
Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.
list_next(previous_request, previous_response)
Retrieves the next page of results.
close()
Close httplib2 connections.
custombatch(body=None, dryRun=None, x__xgafv=None)
Retrieves, inserts, and deletes multiple products in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{ # A batch entry encoding a single non-batch products request.
"product": { # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. # The product to insert. Only required if the method is `insert`.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"pattern": "A String", # The item's pattern (e.g. polka dots).
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"value": "A String", # The denominator of the unit price.
"unit": "A String", # The unit of the denominator.
},
"gender": "A String", # Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "`unisex`"
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"aspects": [ # Deprecated. Do not use.
{
"intention": "A String", # Deprecated.
"aspectName": "A String", # Deprecated.
"destinationName": "A String", # Deprecated.
},
],
"brand": "A String", # Brand of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"isBundle": True or False, # 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.
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"offerId": "A String", # 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.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"shippingLength": { # Length of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"link": "A String", # URL directly linking to your item's page on your website.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
{
"attributes": [ # The sub-attributes.
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
},
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"description": "A String", # Description of the item.
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"material": "A String", # The material of which the item is made.
"color": "A String", # Color of the item.
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`"
"warnings": [ # Read-only warnings.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
"shipping": [ # Shipping rules.
{
"service": "A String", # A free-form description of the service class or delivery speed.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
"postalCode": "A 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.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
},
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"expirationDate": "A 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.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation.
"A String",
],
"ageGroup": "A String", # Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`"
"adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
"A String",
],
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"installment": { # Number and amount of installments to pay for an item.
"months": "A String", # The number of installments the buyer has to pay.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"shippingHeight": { # Height of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.
"productType": "A String", # Your category of the item (formatted as in products data specification).
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"shippingWidth": { # Width of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"identifierExists": True or False, # 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.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"ratio": 3.14, # 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.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"title": "A String", # Title of the item.
"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 (see size definition).
"A String",
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"imageLink": "A String", # URL of an image of the item.
"adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items. Acceptable values are: - "`big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "`regular`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"destinations": [ # Specifies the intended destinations for the product.
{
"destinationName": "A String", # The name of the destination.
"intention": "A String", # Whether the destination is required, excluded or should be validated. Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`"
},
],
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"taxes": [ # Tax information.
{
"region": "A String", # The geographic region to which the tax rate applies.
"postalCode": "A 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*.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`local`" - "`online`"
"onlineOnly": True or False, # Deprecated.
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customAttributes": [ # 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", "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).
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification).
"A String",
],
"availability": "A String", # Availability status of the item. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
},
"method": "A String", # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`"
"productId": "A String", # The ID of the product to get or delete. Only defined if the method is `get` or `delete`.
"merchantId": "A String", # The ID of the managing account.
"batchId": 42, # An entry ID, unique within the batch request.
},
],
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch products response.
"product": { # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. # The inserted product. Only defined if the method is `insert` and if the request was successful.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"pattern": "A String", # The item's pattern (e.g. polka dots).
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"value": "A String", # The denominator of the unit price.
"unit": "A String", # The unit of the denominator.
},
"gender": "A String", # Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "`unisex`"
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"aspects": [ # Deprecated. Do not use.
{
"intention": "A String", # Deprecated.
"aspectName": "A String", # Deprecated.
"destinationName": "A String", # Deprecated.
},
],
"brand": "A String", # Brand of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"isBundle": True or False, # 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.
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"offerId": "A String", # 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.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"shippingLength": { # Length of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"link": "A String", # URL directly linking to your item's page on your website.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
{
"attributes": [ # The sub-attributes.
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
},
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"description": "A String", # Description of the item.
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"material": "A String", # The material of which the item is made.
"color": "A String", # Color of the item.
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`"
"warnings": [ # Read-only warnings.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
"shipping": [ # Shipping rules.
{
"service": "A String", # A free-form description of the service class or delivery speed.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
"postalCode": "A 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.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
},
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"expirationDate": "A 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.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation.
"A String",
],
"ageGroup": "A String", # Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`"
"adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
"A String",
],
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"installment": { # Number and amount of installments to pay for an item.
"months": "A String", # The number of installments the buyer has to pay.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"shippingHeight": { # Height of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.
"productType": "A String", # Your category of the item (formatted as in products data specification).
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"shippingWidth": { # Width of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"identifierExists": True or False, # 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.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"ratio": 3.14, # 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.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"title": "A String", # Title of the item.
"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 (see size definition).
"A String",
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"imageLink": "A String", # URL of an image of the item.
"adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items. Acceptable values are: - "`big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "`regular`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"destinations": [ # Specifies the intended destinations for the product.
{
"destinationName": "A String", # The name of the destination.
"intention": "A String", # Whether the destination is required, excluded or should be validated. Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`"
},
],
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"taxes": [ # Tax information.
{
"region": "A String", # The geographic region to which the tax rate applies.
"postalCode": "A 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*.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`local`" - "`online`"
"onlineOnly": True or False, # Deprecated.
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customAttributes": [ # 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", "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).
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification).
"A String",
],
"availability": "A String", # Availability status of the item. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productsCustomBatchResponseEntry`"
"batchId": 42, # The ID of the request entry this entry responds to.
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
"message": "A String", # The message of the first error in `errors`.
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".
}
delete(merchantId, productId, dryRun=None, x__xgafv=None)
Deletes a product from your Merchant Center account.
Args:
merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
productId: string, The REST ID of the product. (required)
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
get(merchantId, productId, x__xgafv=None)
Retrieves a product from your Merchant Center account.
Args:
merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
productId: string, The REST ID of the product. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"pattern": "A String", # The item's pattern (e.g. polka dots).
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"value": "A String", # The denominator of the unit price.
"unit": "A String", # The unit of the denominator.
},
"gender": "A String", # Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "`unisex`"
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"aspects": [ # Deprecated. Do not use.
{
"intention": "A String", # Deprecated.
"aspectName": "A String", # Deprecated.
"destinationName": "A String", # Deprecated.
},
],
"brand": "A String", # Brand of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"isBundle": True or False, # 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.
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"offerId": "A String", # 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.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"shippingLength": { # Length of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"link": "A String", # URL directly linking to your item's page on your website.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
{
"attributes": [ # The sub-attributes.
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
},
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"description": "A String", # Description of the item.
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"material": "A String", # The material of which the item is made.
"color": "A String", # Color of the item.
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`"
"warnings": [ # Read-only warnings.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
"shipping": [ # Shipping rules.
{
"service": "A String", # A free-form description of the service class or delivery speed.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
"postalCode": "A 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.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
},
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"expirationDate": "A 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.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation.
"A String",
],
"ageGroup": "A String", # Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`"
"adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
"A String",
],
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"installment": { # Number and amount of installments to pay for an item.
"months": "A String", # The number of installments the buyer has to pay.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"shippingHeight": { # Height of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.
"productType": "A String", # Your category of the item (formatted as in products data specification).
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"shippingWidth": { # Width of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"identifierExists": True or False, # 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.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"ratio": 3.14, # 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.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"title": "A String", # Title of the item.
"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 (see size definition).
"A String",
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"imageLink": "A String", # URL of an image of the item.
"adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items. Acceptable values are: - "`big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "`regular`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"destinations": [ # Specifies the intended destinations for the product.
{
"destinationName": "A String", # The name of the destination.
"intention": "A String", # Whether the destination is required, excluded or should be validated. Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`"
},
],
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"taxes": [ # Tax information.
{
"region": "A String", # The geographic region to which the tax rate applies.
"postalCode": "A 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*.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`local`" - "`online`"
"onlineOnly": True or False, # Deprecated.
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customAttributes": [ # 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", "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).
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification).
"A String",
],
"availability": "A String", # Availability status of the item. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
}
insert(merchantId, body=None, dryRun=None, x__xgafv=None)
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.
Args:
merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
body: object, The request body.
The object takes the form of:
{ # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"pattern": "A String", # The item's pattern (e.g. polka dots).
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"value": "A String", # The denominator of the unit price.
"unit": "A String", # The unit of the denominator.
},
"gender": "A String", # Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "`unisex`"
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"aspects": [ # Deprecated. Do not use.
{
"intention": "A String", # Deprecated.
"aspectName": "A String", # Deprecated.
"destinationName": "A String", # Deprecated.
},
],
"brand": "A String", # Brand of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"isBundle": True or False, # 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.
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"offerId": "A String", # 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.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"shippingLength": { # Length of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"link": "A String", # URL directly linking to your item's page on your website.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
{
"attributes": [ # The sub-attributes.
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
},
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"description": "A String", # Description of the item.
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"material": "A String", # The material of which the item is made.
"color": "A String", # Color of the item.
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`"
"warnings": [ # Read-only warnings.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
"shipping": [ # Shipping rules.
{
"service": "A String", # A free-form description of the service class or delivery speed.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
"postalCode": "A 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.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
},
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"expirationDate": "A 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.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation.
"A String",
],
"ageGroup": "A String", # Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`"
"adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
"A String",
],
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"installment": { # Number and amount of installments to pay for an item.
"months": "A String", # The number of installments the buyer has to pay.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"shippingHeight": { # Height of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.
"productType": "A String", # Your category of the item (formatted as in products data specification).
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"shippingWidth": { # Width of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"identifierExists": True or False, # 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.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"ratio": 3.14, # 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.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"title": "A String", # Title of the item.
"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 (see size definition).
"A String",
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"imageLink": "A String", # URL of an image of the item.
"adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items. Acceptable values are: - "`big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "`regular`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"destinations": [ # Specifies the intended destinations for the product.
{
"destinationName": "A String", # The name of the destination.
"intention": "A String", # Whether the destination is required, excluded or should be validated. Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`"
},
],
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"taxes": [ # Tax information.
{
"region": "A String", # The geographic region to which the tax rate applies.
"postalCode": "A 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*.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`local`" - "`online`"
"onlineOnly": True or False, # Deprecated.
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customAttributes": [ # 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", "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).
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification).
"A String",
],
"availability": "A String", # Availability status of the item. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"pattern": "A String", # The item's pattern (e.g. polka dots).
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"value": "A String", # The denominator of the unit price.
"unit": "A String", # The unit of the denominator.
},
"gender": "A String", # Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "`unisex`"
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"aspects": [ # Deprecated. Do not use.
{
"intention": "A String", # Deprecated.
"aspectName": "A String", # Deprecated.
"destinationName": "A String", # Deprecated.
},
],
"brand": "A String", # Brand of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"isBundle": True or False, # 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.
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"offerId": "A String", # 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.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"shippingLength": { # Length of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"link": "A String", # URL directly linking to your item's page on your website.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
{
"attributes": [ # The sub-attributes.
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
},
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"description": "A String", # Description of the item.
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"material": "A String", # The material of which the item is made.
"color": "A String", # Color of the item.
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`"
"warnings": [ # Read-only warnings.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
"shipping": [ # Shipping rules.
{
"service": "A String", # A free-form description of the service class or delivery speed.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
"postalCode": "A 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.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
},
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"expirationDate": "A 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.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation.
"A String",
],
"ageGroup": "A String", # Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`"
"adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
"A String",
],
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"installment": { # Number and amount of installments to pay for an item.
"months": "A String", # The number of installments the buyer has to pay.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"shippingHeight": { # Height of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.
"productType": "A String", # Your category of the item (formatted as in products data specification).
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"shippingWidth": { # Width of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"identifierExists": True or False, # 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.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"ratio": 3.14, # 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.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"title": "A String", # Title of the item.
"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 (see size definition).
"A String",
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"imageLink": "A String", # URL of an image of the item.
"adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items. Acceptable values are: - "`big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "`regular`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"destinations": [ # Specifies the intended destinations for the product.
{
"destinationName": "A String", # The name of the destination.
"intention": "A String", # Whether the destination is required, excluded or should be validated. Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`"
},
],
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"taxes": [ # Tax information.
{
"region": "A String", # The geographic region to which the tax rate applies.
"postalCode": "A 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*.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`local`" - "`online`"
"onlineOnly": True or False, # Deprecated.
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customAttributes": [ # 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", "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).
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification).
"A String",
],
"availability": "A String", # Availability status of the item. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
}
list(merchantId, maxResults=None, includeInvalidInsertedItems=None, pageToken=None, x__xgafv=None)
Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.
Args:
merchantId: string, The ID of the account that contains the products. This account cannot be a multi-client account. (required)
maxResults: integer, The maximum number of products to return in the response, used for paging.
includeInvalidInsertedItems: 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).
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"nextPageToken": "A String", # The token for the retrieval of the next page of products.
"resources": [
{ # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"pattern": "A String", # The item's pattern (e.g. polka dots).
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"value": "A String", # The denominator of the unit price.
"unit": "A String", # The unit of the denominator.
},
"gender": "A String", # Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "`unisex`"
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"aspects": [ # Deprecated. Do not use.
{
"intention": "A String", # Deprecated.
"aspectName": "A String", # Deprecated.
"destinationName": "A String", # Deprecated.
},
],
"brand": "A String", # Brand of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"isBundle": True or False, # 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.
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"offerId": "A String", # 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.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"shippingLength": { # Length of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"link": "A String", # URL directly linking to your item's page on your website.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
{
"attributes": [ # The sub-attributes.
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
},
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"description": "A String", # Description of the item.
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"material": "A String", # The material of which the item is made.
"color": "A String", # Color of the item.
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`"
"warnings": [ # Read-only warnings.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
"shipping": [ # Shipping rules.
{
"service": "A String", # A free-form description of the service class or delivery speed.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
"postalCode": "A 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.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
},
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"expirationDate": "A 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.
"targetCountry": "A String", # Required. The CLDR territory code for the item.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation.
"A String",
],
"ageGroup": "A String", # Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`"
"adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
"A String",
],
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"installment": { # Number and amount of installments to pay for an item.
"months": "A String", # The number of installments the buyer has to pay.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"shippingHeight": { # Height of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.
"productType": "A String", # Your category of the item (formatted as in products data specification).
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"shippingWidth": { # Width of the item for shipping.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
"unit": "A String", # The unit of value.
},
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"identifierExists": True or False, # 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.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"ratio": 3.14, # 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.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
},
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"title": "A String", # Title of the item.
"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 (see size definition).
"A String",
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"imageLink": "A String", # URL of an image of the item.
"adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items. Acceptable values are: - "`big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "`regular`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"destinations": [ # Specifies the intended destinations for the product.
{
"destinationName": "A String", # The name of the destination.
"intention": "A String", # Whether the destination is required, excluded or should be validated. Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`"
},
],
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"taxes": [ # Tax information.
{
"region": "A String", # The geographic region to which the tax rate applies.
"postalCode": "A 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*.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"condition": "A String", # Condition or state of the item. Acceptable values are: - "`local`" - "`online`"
"onlineOnly": True or False, # Deprecated.
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customAttributes": [ # 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", "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).
{
"type": "A String", # The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`"
"value": "A String", # The value of the attribute.
"unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`"
"additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification).
"A String",
],
"availability": "A String", # Availability status of the item. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse".
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.