Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Retrieves, inserts, and deletes multiple products in a single request.
delete(merchantId, productId, feedId=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, feedId=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, 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, 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.
"feedId": "A String", # The Content API feed id.
"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`.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"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.
},
"title": "A String", # Title of the item.
"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.
},
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"productTypes": [ # Categories of the item (formatted as in products data specification).
"A String",
],
"pattern": "A String", # The item's pattern (e.g. polka dots).
"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.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"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.
},
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"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.
"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.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"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.
"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.
"region": "A String", # The geographic region to which the tax rate applies.
},
],
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"link": "A String", # URL directly linking to your item's page on your website.
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
"period": "A String", # The type of subscription period.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"productDetails": [ # Technical specification or additional product details.
{
"sectionName": "A String", # The section header used to group a set of product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
},
],
"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.
"installment": { # Number and amount of installments to pay for an item.
"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.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for 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.
"includedDestinations": [ # 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`.
"A String",
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"brand": "A String", # Brand of the item.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"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.
},
"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",
],
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"unitPricingMeasure": { # The measure and dimension of an item.
"value": 3.14, # The measure of an item.
"unit": "A String", # The unit of the measure.
},
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"description": "A String", # Description of the item.
"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).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"value": "A String", # The value of the attribute.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"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.
},
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"shoppingAdsExcludedCountries": [ # 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.
"A String",
],
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"ageGroup": "A String", # Target age group of the item.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"availability": "A String", # Availability status of the item.
"color": "A String", # Color of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"condition": "A String", # Condition or state of the item.
"imageLink": "A String", # URL of an image of the item.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"shipping": [ # Shipping rules.
{
"region": "A String", # The geographic region to which a shipping rate applies.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"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.
},
"service": "A String", # A free-form description of the service class or delivery speed.
"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.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
},
],
"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.
},
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"material": "A String", # The material of which the item is made.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"gender": "A String", # Target gender of the item.
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"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.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
},
"batchId": 42, # An entry ID, unique within the batch request.
"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.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".
"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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"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.
},
"title": "A String", # Title of the item.
"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.
},
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"productTypes": [ # Categories of the item (formatted as in products data specification).
"A String",
],
"pattern": "A String", # The item's pattern (e.g. polka dots).
"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.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"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.
},
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"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.
"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.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"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.
"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.
"region": "A String", # The geographic region to which the tax rate applies.
},
],
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"link": "A String", # URL directly linking to your item's page on your website.
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
"period": "A String", # The type of subscription period.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"productDetails": [ # Technical specification or additional product details.
{
"sectionName": "A String", # The section header used to group a set of product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
},
],
"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.
"installment": { # Number and amount of installments to pay for an item.
"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.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for 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.
"includedDestinations": [ # 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`.
"A String",
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"brand": "A String", # Brand of the item.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"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.
},
"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",
],
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"unitPricingMeasure": { # The measure and dimension of an item.
"value": 3.14, # The measure of an item.
"unit": "A String", # The unit of the measure.
},
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"description": "A String", # Description of the item.
"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).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"value": "A String", # The value of the attribute.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"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.
},
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"shoppingAdsExcludedCountries": [ # 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.
"A String",
],
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"ageGroup": "A String", # Target age group of the item.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"availability": "A String", # Availability status of the item.
"color": "A String", # Color of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"condition": "A String", # Condition or state of the item.
"imageLink": "A String", # URL of an image of the item.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"shipping": [ # Shipping rules.
{
"region": "A String", # The geographic region to which a shipping rate applies.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"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.
},
"service": "A String", # A free-form description of the service class or delivery speed.
"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.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
},
],
"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.
},
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"material": "A String", # The material of which the item is made.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"gender": "A String", # Target gender of the item.
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"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.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
},
"batchId": 42, # The ID of the request entry this entry responds to.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productsCustomBatchResponseEntry`"
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
"errors": [ # A list of errors.
{ # An error returned by the API.
"reason": "A String", # The error code.
"message": "A String", # A description of the error.
"domain": "A String", # The domain of the error.
},
],
"code": 42, # The HTTP status of the first error in `errors`.
"message": "A String", # The message of the first error in `errors`.
},
},
],
}
delete(merchantId, productId, feedId=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)
feedId: string, The Content API Supplemental Feed ID.
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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"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.
},
"title": "A String", # Title of the item.
"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.
},
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"productTypes": [ # Categories of the item (formatted as in products data specification).
"A String",
],
"pattern": "A String", # The item's pattern (e.g. polka dots).
"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.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"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.
},
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"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.
"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.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"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.
"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.
"region": "A String", # The geographic region to which the tax rate applies.
},
],
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"link": "A String", # URL directly linking to your item's page on your website.
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
"period": "A String", # The type of subscription period.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"productDetails": [ # Technical specification or additional product details.
{
"sectionName": "A String", # The section header used to group a set of product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
},
],
"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.
"installment": { # Number and amount of installments to pay for an item.
"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.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for 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.
"includedDestinations": [ # 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`.
"A String",
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"brand": "A String", # Brand of the item.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"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.
},
"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",
],
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"unitPricingMeasure": { # The measure and dimension of an item.
"value": 3.14, # The measure of an item.
"unit": "A String", # The unit of the measure.
},
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"description": "A String", # Description of the item.
"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).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"value": "A String", # The value of the attribute.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"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.
},
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"shoppingAdsExcludedCountries": [ # 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.
"A String",
],
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"ageGroup": "A String", # Target age group of the item.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"availability": "A String", # Availability status of the item.
"color": "A String", # Color of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"condition": "A String", # Condition or state of the item.
"imageLink": "A String", # URL of an image of the item.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"shipping": [ # Shipping rules.
{
"region": "A String", # The geographic region to which a shipping rate applies.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"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.
},
"service": "A String", # A free-form description of the service class or delivery speed.
"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.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
},
],
"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.
},
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"material": "A String", # The material of which the item is made.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"gender": "A String", # Target gender of the item.
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"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.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
}
insert(merchantId, body=None, feedId=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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"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.
},
"title": "A String", # Title of the item.
"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.
},
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"productTypes": [ # Categories of the item (formatted as in products data specification).
"A String",
],
"pattern": "A String", # The item's pattern (e.g. polka dots).
"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.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"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.
},
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"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.
"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.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"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.
"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.
"region": "A String", # The geographic region to which the tax rate applies.
},
],
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"link": "A String", # URL directly linking to your item's page on your website.
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
"period": "A String", # The type of subscription period.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"productDetails": [ # Technical specification or additional product details.
{
"sectionName": "A String", # The section header used to group a set of product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
},
],
"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.
"installment": { # Number and amount of installments to pay for an item.
"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.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for 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.
"includedDestinations": [ # 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`.
"A String",
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"brand": "A String", # Brand of the item.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"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.
},
"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",
],
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"unitPricingMeasure": { # The measure and dimension of an item.
"value": 3.14, # The measure of an item.
"unit": "A String", # The unit of the measure.
},
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"description": "A String", # Description of the item.
"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).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"value": "A String", # The value of the attribute.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"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.
},
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"shoppingAdsExcludedCountries": [ # 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.
"A String",
],
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"ageGroup": "A String", # Target age group of the item.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"availability": "A String", # Availability status of the item.
"color": "A String", # Color of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"condition": "A String", # Condition or state of the item.
"imageLink": "A String", # URL of an image of the item.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"shipping": [ # Shipping rules.
{
"region": "A String", # The geographic region to which a shipping rate applies.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"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.
},
"service": "A String", # A free-form description of the service class or delivery speed.
"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.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
},
],
"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.
},
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"material": "A String", # The material of which the item is made.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"gender": "A String", # Target gender of the item.
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"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.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
}
feedId: string, The Content API Supplemental Feed ID.
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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"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.
},
"title": "A String", # Title of the item.
"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.
},
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"productTypes": [ # Categories of the item (formatted as in products data specification).
"A String",
],
"pattern": "A String", # The item's pattern (e.g. polka dots).
"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.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"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.
},
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"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.
"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.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"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.
"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.
"region": "A String", # The geographic region to which the tax rate applies.
},
],
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"link": "A String", # URL directly linking to your item's page on your website.
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
"period": "A String", # The type of subscription period.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"productDetails": [ # Technical specification or additional product details.
{
"sectionName": "A String", # The section header used to group a set of product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
},
],
"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.
"installment": { # Number and amount of installments to pay for an item.
"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.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for 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.
"includedDestinations": [ # 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`.
"A String",
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"brand": "A String", # Brand of the item.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"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.
},
"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",
],
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"unitPricingMeasure": { # The measure and dimension of an item.
"value": 3.14, # The measure of an item.
"unit": "A String", # The unit of the measure.
},
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"description": "A String", # Description of the item.
"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).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"value": "A String", # The value of the attribute.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"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.
},
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"shoppingAdsExcludedCountries": [ # 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.
"A String",
],
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"ageGroup": "A String", # Target age group of the item.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"availability": "A String", # Availability status of the item.
"color": "A String", # Color of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"condition": "A String", # Condition or state of the item.
"imageLink": "A String", # URL of an image of the item.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"shipping": [ # Shipping rules.
{
"region": "A String", # The geographic region to which a shipping rate applies.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"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.
},
"service": "A String", # A free-form description of the service class or delivery speed.
"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.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
},
],
"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.
},
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"material": "A String", # The material of which the item is made.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"gender": "A String", # Target gender of the item.
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"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.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
}
list(merchantId, maxResults=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.
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:
{
"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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"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.
},
"title": "A String", # Title of the item.
"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.
},
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"productTypes": [ # Categories of the item (formatted as in products data specification).
"A String",
],
"pattern": "A String", # The item's pattern (e.g. polka dots).
"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.
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"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.
},
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"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.
"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.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"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.
"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.
"region": "A String", # The geographic region to which the tax rate applies.
},
],
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"link": "A String", # URL directly linking to your item's page on your website.
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
"period": "A String", # The type of subscription period.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"productDetails": [ # Technical specification or additional product details.
{
"sectionName": "A String", # The section header used to group a set of product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
},
],
"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.
"installment": { # Number and amount of installments to pay for an item.
"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.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for 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.
"includedDestinations": [ # 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`.
"A String",
],
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification ).
"brand": "A String", # Brand of the item.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"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.
},
"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",
],
"source": "A String", # The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"unitPricingMeasure": { # The measure and dimension of an item.
"value": 3.14, # The measure of an item.
"unit": "A String", # The unit of the measure.
},
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"description": "A String", # Description of the item.
"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).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"value": "A String", # The value of the attribute.
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
},
],
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"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.
},
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"shoppingAdsExcludedCountries": [ # 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.
"A String",
],
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"ageGroup": "A String", # Target age group of the item.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"availability": "A String", # Availability status of the item.
"color": "A String", # Color of the item.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"condition": "A String", # Condition or state of the item.
"imageLink": "A String", # URL of an image of the item.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"shipping": [ # Shipping rules.
{
"region": "A String", # The geographic region to which a shipping rate applies.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"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.
},
"service": "A String", # A free-form description of the service class or delivery speed.
"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.
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
},
],
"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.
},
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
"material": "A String", # The material of which the item is made.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"gender": "A String", # Target gender of the item.
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"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.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse".
"nextPageToken": "A String", # The token for the retrieval of the next page of products.
}
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.