| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.products.html">products</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#custombatch">custombatch(body=None, dryRun=None)</a></code></p> |
| <p class="firstline">Retrieves, inserts, and deletes multiple products in a single request.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(merchantId, productId, dryRun=None)</a></code></p> |
| <p class="firstline">Deletes a product from your Merchant Center account.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(merchantId, productId)</a></code></p> |
| <p class="firstline">Retrieves a product from your Merchant Center account.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(merchantId, body=None, dryRun=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(merchantId, includeInvalidInsertedItems=None, maxResults=None, pageToken=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code> |
| <pre>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. |
| "batchId": 42, # An entry ID, unique within the batch request. |
| "merchantId": "A String", # The ID of the managing account. |
| "method": "A String", # The method of the batch entry. |
| # |
| # Acceptable values are: |
| # - "`delete`" |
| # - "`get`" |
| # - "`insert`" |
| "product": { # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. # The product to insert. Only required if the method is `insert`. |
| # |
| # 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. |
| "additionalImageLinks": [ # Additional URLs of images of the item. |
| "A String", |
| ], |
| "additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification). |
| "A String", |
| ], |
| "adult": True or False, # Set to true if the item is targeted towards adults. |
| "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
| "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC. |
| "A String", |
| ], |
| "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
| "ageGroup": "A String", # Target age group of the item. |
| # |
| # Acceptable values are: |
| # - "`adult`" |
| # - "`infant`" |
| # - "`kids`" |
| # - "`newborn`" |
| # - "`toddler`" |
| # - "`youngAdult`" |
| "aspects": [ # Deprecated. Do not use. |
| { |
| "aspectName": "A String", # Deprecated. |
| "destinationName": "A String", # Deprecated. |
| "intention": "A String", # Deprecated. |
| }, |
| ], |
| "availability": "A String", # Availability status of the item. |
| # |
| # Acceptable values are: |
| # - "`in stock`" |
| # - "`out of stock`" |
| # - "`preorder`" |
| "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
| "brand": "A String", # Brand of the item. |
| "canonicalLink": "A String", # URL for the canonical version of your item's landing page. |
| "channel": "A String", # Required. The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "color": "A String", # Color of the item. |
| "condition": "A String", # Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| "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. |
| }, |
| "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 Shopping Actions. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "customGroups": [ # A list of custom (merchant-provided) custom attribute groups. |
| { |
| "attributes": [ # The sub-attributes. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion. |
| }, |
| ], |
| "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. |
| "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. |
| "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. |
| "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. |
| "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign. |
| "description": "A String", # Description of the item. |
| "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`" |
| }, |
| ], |
| "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns. |
| "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns. |
| "displayAdsSimilarIds": [ # Advertiser-specified recommendations. |
| "A String", |
| ], |
| "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. |
| "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. |
| "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`" |
| "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. |
| "gender": "A String", # Target gender of the item. |
| # |
| # Acceptable values are: |
| # - "`female`" |
| # - "`male`" |
| # - "`unisex`" |
| "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). |
| "gtin": "A String", # Global Trade Item Number (GTIN) of the item. |
| "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. |
| "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. |
| "imageLink": "A String", # URL of an image of the item. |
| "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. |
| }, |
| "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. |
| "itemGroupId": "A String", # Shared identifier for all variants of the same product. |
| "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "`content#product`" |
| "link": "A String", # URL directly linking to your item's page on your website. |
| "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. |
| "pointsValue": "A String", # The retailer's loyalty points in absolute value. |
| "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. |
| }, |
| "material": "A String", # The material of which the item is made. |
| "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`" |
| "maxHandlingTime": "A String", # Maximal product handling time (in business days). |
| "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`" |
| "minHandlingTime": "A String", # Minimal product handling time (in business days). |
| "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. |
| "mpn": "A String", # Manufacturer Part Number (MPN) of the item. |
| "multipack": "A String", # The number of identical products in a merchant-defined multipack. |
| "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. |
| "onlineOnly": True or False, # Deprecated. |
| "pattern": "A String", # The item's pattern (e.g. polka dots). |
| "price": { # Price of the item. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "productType": "A String", # Your category of the item (formatted as in products data specification). |
| "promotionIds": [ # The unique ID of a promotion. |
| "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. |
| }, |
| "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification). |
| "sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products. |
| "shipping": [ # Shipping rules. |
| { |
| "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. |
| "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. |
| "service": "A String", # A free-form description of the service class or delivery speed. |
| }, |
| ], |
| "shippingHeight": { # Height of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item. |
| }, |
| "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules. |
| "shippingLength": { # Length of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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. |
| }, |
| "shippingWidth": { # Width of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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`" |
| "sizeType": "A String", # The cut of the item. Recommended for apparel items. |
| # |
| # Acceptable values are: |
| # - "`big and tall`" |
| # - "`maternity`" |
| # - "`oversize`" |
| # - "`petite`" |
| # - "`plus`" |
| # - "`regular`" |
| "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`" |
| "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| "taxes": [ # Tax information. |
| { |
| "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code. |
| "locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API. |
| "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*. |
| "rate": 3.14, # The percentage of tax rate that applies to the item price. |
| "region": "A String", # The geographic region to which the tax rate applies. |
| "taxShip": True or False, # Set to true if tax is charged on shipping. |
| }, |
| ], |
| "title": "A String", # Title of the item. |
| "unitPricingBaseMeasure": { # The preference of the denominator of the unit price. |
| "unit": "A String", # The unit of the denominator. |
| "value": "A String", # The denominator of the unit price. |
| }, |
| "unitPricingMeasure": { # The measure and dimension of an item. |
| "unit": "A String", # The unit of the measure. |
| "value": 3.14, # The measure of an item. |
| }, |
| "validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation. |
| "A String", |
| ], |
| "warnings": [ # Read-only warnings. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| }, |
| "productId": "A String", # The ID of the product to get or delete. Only defined if the method is `get` or `delete`. |
| }, |
| ], |
| } |
| |
| 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). |
| |
| 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. |
| "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. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| "message": "A String", # The message of the first error in `errors`. |
| }, |
| "kind": "content#productsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#productsCustomBatchResponseEntry`" |
| "product": { # Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. # The inserted product. Only defined if the method is `insert` and if the request was successful. |
| # |
| # 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. |
| "additionalImageLinks": [ # Additional URLs of images of the item. |
| "A String", |
| ], |
| "additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification). |
| "A String", |
| ], |
| "adult": True or False, # Set to true if the item is targeted towards adults. |
| "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
| "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC. |
| "A String", |
| ], |
| "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
| "ageGroup": "A String", # Target age group of the item. |
| # |
| # Acceptable values are: |
| # - "`adult`" |
| # - "`infant`" |
| # - "`kids`" |
| # - "`newborn`" |
| # - "`toddler`" |
| # - "`youngAdult`" |
| "aspects": [ # Deprecated. Do not use. |
| { |
| "aspectName": "A String", # Deprecated. |
| "destinationName": "A String", # Deprecated. |
| "intention": "A String", # Deprecated. |
| }, |
| ], |
| "availability": "A String", # Availability status of the item. |
| # |
| # Acceptable values are: |
| # - "`in stock`" |
| # - "`out of stock`" |
| # - "`preorder`" |
| "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
| "brand": "A String", # Brand of the item. |
| "canonicalLink": "A String", # URL for the canonical version of your item's landing page. |
| "channel": "A String", # Required. The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "color": "A String", # Color of the item. |
| "condition": "A String", # Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| "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. |
| }, |
| "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 Shopping Actions. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "customGroups": [ # A list of custom (merchant-provided) custom attribute groups. |
| { |
| "attributes": [ # The sub-attributes. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion. |
| }, |
| ], |
| "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. |
| "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. |
| "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. |
| "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. |
| "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign. |
| "description": "A String", # Description of the item. |
| "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`" |
| }, |
| ], |
| "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns. |
| "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns. |
| "displayAdsSimilarIds": [ # Advertiser-specified recommendations. |
| "A String", |
| ], |
| "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. |
| "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. |
| "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`" |
| "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. |
| "gender": "A String", # Target gender of the item. |
| # |
| # Acceptable values are: |
| # - "`female`" |
| # - "`male`" |
| # - "`unisex`" |
| "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). |
| "gtin": "A String", # Global Trade Item Number (GTIN) of the item. |
| "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. |
| "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. |
| "imageLink": "A String", # URL of an image of the item. |
| "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. |
| }, |
| "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. |
| "itemGroupId": "A String", # Shared identifier for all variants of the same product. |
| "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "`content#product`" |
| "link": "A String", # URL directly linking to your item's page on your website. |
| "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. |
| "pointsValue": "A String", # The retailer's loyalty points in absolute value. |
| "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. |
| }, |
| "material": "A String", # The material of which the item is made. |
| "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`" |
| "maxHandlingTime": "A String", # Maximal product handling time (in business days). |
| "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`" |
| "minHandlingTime": "A String", # Minimal product handling time (in business days). |
| "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. |
| "mpn": "A String", # Manufacturer Part Number (MPN) of the item. |
| "multipack": "A String", # The number of identical products in a merchant-defined multipack. |
| "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. |
| "onlineOnly": True or False, # Deprecated. |
| "pattern": "A String", # The item's pattern (e.g. polka dots). |
| "price": { # Price of the item. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "productType": "A String", # Your category of the item (formatted as in products data specification). |
| "promotionIds": [ # The unique ID of a promotion. |
| "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. |
| }, |
| "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification). |
| "sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products. |
| "shipping": [ # Shipping rules. |
| { |
| "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. |
| "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. |
| "service": "A String", # A free-form description of the service class or delivery speed. |
| }, |
| ], |
| "shippingHeight": { # Height of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item. |
| }, |
| "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules. |
| "shippingLength": { # Length of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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. |
| }, |
| "shippingWidth": { # Width of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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`" |
| "sizeType": "A String", # The cut of the item. Recommended for apparel items. |
| # |
| # Acceptable values are: |
| # - "`big and tall`" |
| # - "`maternity`" |
| # - "`oversize`" |
| # - "`petite`" |
| # - "`plus`" |
| # - "`regular`" |
| "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`" |
| "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| "taxes": [ # Tax information. |
| { |
| "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code. |
| "locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API. |
| "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*. |
| "rate": 3.14, # The percentage of tax rate that applies to the item price. |
| "region": "A String", # The geographic region to which the tax rate applies. |
| "taxShip": True or False, # Set to true if tax is charged on shipping. |
| }, |
| ], |
| "title": "A String", # Title of the item. |
| "unitPricingBaseMeasure": { # The preference of the denominator of the unit price. |
| "unit": "A String", # The unit of the denominator. |
| "value": "A String", # The denominator of the unit price. |
| }, |
| "unitPricingMeasure": { # The measure and dimension of an item. |
| "unit": "A String", # The unit of the measure. |
| "value": 3.14, # The measure of an item. |
| }, |
| "validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation. |
| "A String", |
| ], |
| "warnings": [ # Read-only warnings. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| }, |
| }, |
| ], |
| "kind": "content#productsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(merchantId, productId, dryRun=None)</code> |
| <pre>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). |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(merchantId, productId)</code> |
| <pre>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) |
| |
| 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. |
| "additionalImageLinks": [ # Additional URLs of images of the item. |
| "A String", |
| ], |
| "additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification). |
| "A String", |
| ], |
| "adult": True or False, # Set to true if the item is targeted towards adults. |
| "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
| "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC. |
| "A String", |
| ], |
| "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
| "ageGroup": "A String", # Target age group of the item. |
| # |
| # Acceptable values are: |
| # - "`adult`" |
| # - "`infant`" |
| # - "`kids`" |
| # - "`newborn`" |
| # - "`toddler`" |
| # - "`youngAdult`" |
| "aspects": [ # Deprecated. Do not use. |
| { |
| "aspectName": "A String", # Deprecated. |
| "destinationName": "A String", # Deprecated. |
| "intention": "A String", # Deprecated. |
| }, |
| ], |
| "availability": "A String", # Availability status of the item. |
| # |
| # Acceptable values are: |
| # - "`in stock`" |
| # - "`out of stock`" |
| # - "`preorder`" |
| "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
| "brand": "A String", # Brand of the item. |
| "canonicalLink": "A String", # URL for the canonical version of your item's landing page. |
| "channel": "A String", # Required. The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "color": "A String", # Color of the item. |
| "condition": "A String", # Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| "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. |
| }, |
| "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 Shopping Actions. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "customGroups": [ # A list of custom (merchant-provided) custom attribute groups. |
| { |
| "attributes": [ # The sub-attributes. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion. |
| }, |
| ], |
| "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. |
| "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. |
| "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. |
| "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. |
| "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign. |
| "description": "A String", # Description of the item. |
| "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`" |
| }, |
| ], |
| "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns. |
| "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns. |
| "displayAdsSimilarIds": [ # Advertiser-specified recommendations. |
| "A String", |
| ], |
| "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. |
| "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. |
| "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`" |
| "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. |
| "gender": "A String", # Target gender of the item. |
| # |
| # Acceptable values are: |
| # - "`female`" |
| # - "`male`" |
| # - "`unisex`" |
| "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). |
| "gtin": "A String", # Global Trade Item Number (GTIN) of the item. |
| "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. |
| "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. |
| "imageLink": "A String", # URL of an image of the item. |
| "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. |
| }, |
| "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. |
| "itemGroupId": "A String", # Shared identifier for all variants of the same product. |
| "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "`content#product`" |
| "link": "A String", # URL directly linking to your item's page on your website. |
| "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. |
| "pointsValue": "A String", # The retailer's loyalty points in absolute value. |
| "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. |
| }, |
| "material": "A String", # The material of which the item is made. |
| "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`" |
| "maxHandlingTime": "A String", # Maximal product handling time (in business days). |
| "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`" |
| "minHandlingTime": "A String", # Minimal product handling time (in business days). |
| "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. |
| "mpn": "A String", # Manufacturer Part Number (MPN) of the item. |
| "multipack": "A String", # The number of identical products in a merchant-defined multipack. |
| "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. |
| "onlineOnly": True or False, # Deprecated. |
| "pattern": "A String", # The item's pattern (e.g. polka dots). |
| "price": { # Price of the item. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "productType": "A String", # Your category of the item (formatted as in products data specification). |
| "promotionIds": [ # The unique ID of a promotion. |
| "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. |
| }, |
| "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification). |
| "sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products. |
| "shipping": [ # Shipping rules. |
| { |
| "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. |
| "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. |
| "service": "A String", # A free-form description of the service class or delivery speed. |
| }, |
| ], |
| "shippingHeight": { # Height of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item. |
| }, |
| "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules. |
| "shippingLength": { # Length of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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. |
| }, |
| "shippingWidth": { # Width of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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`" |
| "sizeType": "A String", # The cut of the item. Recommended for apparel items. |
| # |
| # Acceptable values are: |
| # - "`big and tall`" |
| # - "`maternity`" |
| # - "`oversize`" |
| # - "`petite`" |
| # - "`plus`" |
| # - "`regular`" |
| "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`" |
| "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| "taxes": [ # Tax information. |
| { |
| "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code. |
| "locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API. |
| "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*. |
| "rate": 3.14, # The percentage of tax rate that applies to the item price. |
| "region": "A String", # The geographic region to which the tax rate applies. |
| "taxShip": True or False, # Set to true if tax is charged on shipping. |
| }, |
| ], |
| "title": "A String", # Title of the item. |
| "unitPricingBaseMeasure": { # The preference of the denominator of the unit price. |
| "unit": "A String", # The unit of the denominator. |
| "value": "A String", # The denominator of the unit price. |
| }, |
| "unitPricingMeasure": { # The measure and dimension of an item. |
| "unit": "A String", # The unit of the measure. |
| "value": 3.14, # The measure of an item. |
| }, |
| "validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation. |
| "A String", |
| ], |
| "warnings": [ # Read-only warnings. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(merchantId, body=None, dryRun=None)</code> |
| <pre>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. |
| "additionalImageLinks": [ # Additional URLs of images of the item. |
| "A String", |
| ], |
| "additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification). |
| "A String", |
| ], |
| "adult": True or False, # Set to true if the item is targeted towards adults. |
| "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
| "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC. |
| "A String", |
| ], |
| "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
| "ageGroup": "A String", # Target age group of the item. |
| # |
| # Acceptable values are: |
| # - "`adult`" |
| # - "`infant`" |
| # - "`kids`" |
| # - "`newborn`" |
| # - "`toddler`" |
| # - "`youngAdult`" |
| "aspects": [ # Deprecated. Do not use. |
| { |
| "aspectName": "A String", # Deprecated. |
| "destinationName": "A String", # Deprecated. |
| "intention": "A String", # Deprecated. |
| }, |
| ], |
| "availability": "A String", # Availability status of the item. |
| # |
| # Acceptable values are: |
| # - "`in stock`" |
| # - "`out of stock`" |
| # - "`preorder`" |
| "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
| "brand": "A String", # Brand of the item. |
| "canonicalLink": "A String", # URL for the canonical version of your item's landing page. |
| "channel": "A String", # Required. The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "color": "A String", # Color of the item. |
| "condition": "A String", # Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| "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. |
| }, |
| "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 Shopping Actions. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "customGroups": [ # A list of custom (merchant-provided) custom attribute groups. |
| { |
| "attributes": [ # The sub-attributes. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion. |
| }, |
| ], |
| "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. |
| "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. |
| "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. |
| "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. |
| "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign. |
| "description": "A String", # Description of the item. |
| "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`" |
| }, |
| ], |
| "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns. |
| "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns. |
| "displayAdsSimilarIds": [ # Advertiser-specified recommendations. |
| "A String", |
| ], |
| "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. |
| "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. |
| "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`" |
| "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. |
| "gender": "A String", # Target gender of the item. |
| # |
| # Acceptable values are: |
| # - "`female`" |
| # - "`male`" |
| # - "`unisex`" |
| "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). |
| "gtin": "A String", # Global Trade Item Number (GTIN) of the item. |
| "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. |
| "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. |
| "imageLink": "A String", # URL of an image of the item. |
| "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. |
| }, |
| "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. |
| "itemGroupId": "A String", # Shared identifier for all variants of the same product. |
| "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "`content#product`" |
| "link": "A String", # URL directly linking to your item's page on your website. |
| "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. |
| "pointsValue": "A String", # The retailer's loyalty points in absolute value. |
| "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. |
| }, |
| "material": "A String", # The material of which the item is made. |
| "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`" |
| "maxHandlingTime": "A String", # Maximal product handling time (in business days). |
| "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`" |
| "minHandlingTime": "A String", # Minimal product handling time (in business days). |
| "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. |
| "mpn": "A String", # Manufacturer Part Number (MPN) of the item. |
| "multipack": "A String", # The number of identical products in a merchant-defined multipack. |
| "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. |
| "onlineOnly": True or False, # Deprecated. |
| "pattern": "A String", # The item's pattern (e.g. polka dots). |
| "price": { # Price of the item. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "productType": "A String", # Your category of the item (formatted as in products data specification). |
| "promotionIds": [ # The unique ID of a promotion. |
| "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. |
| }, |
| "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification). |
| "sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products. |
| "shipping": [ # Shipping rules. |
| { |
| "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. |
| "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. |
| "service": "A String", # A free-form description of the service class or delivery speed. |
| }, |
| ], |
| "shippingHeight": { # Height of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item. |
| }, |
| "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules. |
| "shippingLength": { # Length of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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. |
| }, |
| "shippingWidth": { # Width of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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`" |
| "sizeType": "A String", # The cut of the item. Recommended for apparel items. |
| # |
| # Acceptable values are: |
| # - "`big and tall`" |
| # - "`maternity`" |
| # - "`oversize`" |
| # - "`petite`" |
| # - "`plus`" |
| # - "`regular`" |
| "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`" |
| "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| "taxes": [ # Tax information. |
| { |
| "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code. |
| "locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API. |
| "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*. |
| "rate": 3.14, # The percentage of tax rate that applies to the item price. |
| "region": "A String", # The geographic region to which the tax rate applies. |
| "taxShip": True or False, # Set to true if tax is charged on shipping. |
| }, |
| ], |
| "title": "A String", # Title of the item. |
| "unitPricingBaseMeasure": { # The preference of the denominator of the unit price. |
| "unit": "A String", # The unit of the denominator. |
| "value": "A String", # The denominator of the unit price. |
| }, |
| "unitPricingMeasure": { # The measure and dimension of an item. |
| "unit": "A String", # The unit of the measure. |
| "value": 3.14, # The measure of an item. |
| }, |
| "validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation. |
| "A String", |
| ], |
| "warnings": [ # Read-only warnings. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| } |
| |
| 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). |
| |
| 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. |
| "additionalImageLinks": [ # Additional URLs of images of the item. |
| "A String", |
| ], |
| "additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification). |
| "A String", |
| ], |
| "adult": True or False, # Set to true if the item is targeted towards adults. |
| "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
| "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC. |
| "A String", |
| ], |
| "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
| "ageGroup": "A String", # Target age group of the item. |
| # |
| # Acceptable values are: |
| # - "`adult`" |
| # - "`infant`" |
| # - "`kids`" |
| # - "`newborn`" |
| # - "`toddler`" |
| # - "`youngAdult`" |
| "aspects": [ # Deprecated. Do not use. |
| { |
| "aspectName": "A String", # Deprecated. |
| "destinationName": "A String", # Deprecated. |
| "intention": "A String", # Deprecated. |
| }, |
| ], |
| "availability": "A String", # Availability status of the item. |
| # |
| # Acceptable values are: |
| # - "`in stock`" |
| # - "`out of stock`" |
| # - "`preorder`" |
| "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
| "brand": "A String", # Brand of the item. |
| "canonicalLink": "A String", # URL for the canonical version of your item's landing page. |
| "channel": "A String", # Required. The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "color": "A String", # Color of the item. |
| "condition": "A String", # Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| "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. |
| }, |
| "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 Shopping Actions. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "customGroups": [ # A list of custom (merchant-provided) custom attribute groups. |
| { |
| "attributes": [ # The sub-attributes. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion. |
| }, |
| ], |
| "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. |
| "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. |
| "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. |
| "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. |
| "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign. |
| "description": "A String", # Description of the item. |
| "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`" |
| }, |
| ], |
| "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns. |
| "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns. |
| "displayAdsSimilarIds": [ # Advertiser-specified recommendations. |
| "A String", |
| ], |
| "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. |
| "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. |
| "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`" |
| "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. |
| "gender": "A String", # Target gender of the item. |
| # |
| # Acceptable values are: |
| # - "`female`" |
| # - "`male`" |
| # - "`unisex`" |
| "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). |
| "gtin": "A String", # Global Trade Item Number (GTIN) of the item. |
| "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. |
| "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. |
| "imageLink": "A String", # URL of an image of the item. |
| "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. |
| }, |
| "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. |
| "itemGroupId": "A String", # Shared identifier for all variants of the same product. |
| "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "`content#product`" |
| "link": "A String", # URL directly linking to your item's page on your website. |
| "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. |
| "pointsValue": "A String", # The retailer's loyalty points in absolute value. |
| "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. |
| }, |
| "material": "A String", # The material of which the item is made. |
| "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`" |
| "maxHandlingTime": "A String", # Maximal product handling time (in business days). |
| "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`" |
| "minHandlingTime": "A String", # Minimal product handling time (in business days). |
| "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. |
| "mpn": "A String", # Manufacturer Part Number (MPN) of the item. |
| "multipack": "A String", # The number of identical products in a merchant-defined multipack. |
| "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. |
| "onlineOnly": True or False, # Deprecated. |
| "pattern": "A String", # The item's pattern (e.g. polka dots). |
| "price": { # Price of the item. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "productType": "A String", # Your category of the item (formatted as in products data specification). |
| "promotionIds": [ # The unique ID of a promotion. |
| "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. |
| }, |
| "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification). |
| "sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products. |
| "shipping": [ # Shipping rules. |
| { |
| "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. |
| "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. |
| "service": "A String", # A free-form description of the service class or delivery speed. |
| }, |
| ], |
| "shippingHeight": { # Height of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item. |
| }, |
| "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules. |
| "shippingLength": { # Length of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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. |
| }, |
| "shippingWidth": { # Width of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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`" |
| "sizeType": "A String", # The cut of the item. Recommended for apparel items. |
| # |
| # Acceptable values are: |
| # - "`big and tall`" |
| # - "`maternity`" |
| # - "`oversize`" |
| # - "`petite`" |
| # - "`plus`" |
| # - "`regular`" |
| "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`" |
| "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| "taxes": [ # Tax information. |
| { |
| "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code. |
| "locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API. |
| "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*. |
| "rate": 3.14, # The percentage of tax rate that applies to the item price. |
| "region": "A String", # The geographic region to which the tax rate applies. |
| "taxShip": True or False, # Set to true if tax is charged on shipping. |
| }, |
| ], |
| "title": "A String", # Title of the item. |
| "unitPricingBaseMeasure": { # The preference of the denominator of the unit price. |
| "unit": "A String", # The unit of the denominator. |
| "value": "A String", # The denominator of the unit price. |
| }, |
| "unitPricingMeasure": { # The measure and dimension of an item. |
| "unit": "A String", # The unit of the measure. |
| "value": 3.14, # The measure of an item. |
| }, |
| "validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation. |
| "A String", |
| ], |
| "warnings": [ # Read-only warnings. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(merchantId, includeInvalidInsertedItems=None, maxResults=None, pageToken=None)</code> |
| <pre>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) |
| 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). |
| maxResults: integer, The maximum number of products to return in the response, used for paging. |
| pageToken: string, The token returned by the previous request. |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "kind": "content#productsListResponse", # 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. |
| "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. |
| "additionalImageLinks": [ # Additional URLs of images of the item. |
| "A String", |
| ], |
| "additionalProductTypes": [ # Additional categories of the item (formatted as in products data specification). |
| "A String", |
| ], |
| "adult": True or False, # Set to true if the item is targeted towards adults. |
| "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
| "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC. |
| "A String", |
| ], |
| "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
| "ageGroup": "A String", # Target age group of the item. |
| # |
| # Acceptable values are: |
| # - "`adult`" |
| # - "`infant`" |
| # - "`kids`" |
| # - "`newborn`" |
| # - "`toddler`" |
| # - "`youngAdult`" |
| "aspects": [ # Deprecated. Do not use. |
| { |
| "aspectName": "A String", # Deprecated. |
| "destinationName": "A String", # Deprecated. |
| "intention": "A String", # Deprecated. |
| }, |
| ], |
| "availability": "A String", # Availability status of the item. |
| # |
| # Acceptable values are: |
| # - "`in stock`" |
| # - "`out of stock`" |
| # - "`preorder`" |
| "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
| "brand": "A String", # Brand of the item. |
| "canonicalLink": "A String", # URL for the canonical version of your item's landing page. |
| "channel": "A String", # Required. The item's channel (online or local). |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "color": "A String", # Color of the item. |
| "condition": "A String", # Condition or state of the item. |
| # |
| # Acceptable values are: |
| # - "`local`" |
| # - "`online`" |
| "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. |
| "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. |
| }, |
| "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 Shopping Actions. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "customGroups": [ # A list of custom (merchant-provided) custom attribute groups. |
| { |
| "attributes": [ # The sub-attributes. |
| { |
| "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion. |
| "type": "A String", # The type of the attribute. |
| # |
| # Acceptable values are: |
| # - "`boolean`" |
| # - "`datetimerange`" |
| # - "`float`" |
| # - "`group`" |
| # - "`int`" |
| # - "`price`" |
| # - "`text`" |
| # - "`time`" |
| # - "`url`" |
| "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. |
| "value": "A String", # The value of the attribute. |
| }, |
| ], |
| "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion. |
| }, |
| ], |
| "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. |
| "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. |
| "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. |
| "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. |
| "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign. |
| "description": "A String", # Description of the item. |
| "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`" |
| }, |
| ], |
| "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns. |
| "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns. |
| "displayAdsSimilarIds": [ # Advertiser-specified recommendations. |
| "A String", |
| ], |
| "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. |
| "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. |
| "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`" |
| "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. |
| "gender": "A String", # Target gender of the item. |
| # |
| # Acceptable values are: |
| # - "`female`" |
| # - "`male`" |
| # - "`unisex`" |
| "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). |
| "gtin": "A String", # Global Trade Item Number (GTIN) of the item. |
| "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. |
| "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. |
| "imageLink": "A String", # URL of an image of the item. |
| "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. |
| }, |
| "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. |
| "itemGroupId": "A String", # Shared identifier for all variants of the same product. |
| "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "`content#product`" |
| "link": "A String", # URL directly linking to your item's page on your website. |
| "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. |
| "pointsValue": "A String", # The retailer's loyalty points in absolute value. |
| "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. |
| }, |
| "material": "A String", # The material of which the item is made. |
| "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`" |
| "maxHandlingTime": "A String", # Maximal product handling time (in business days). |
| "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`" |
| "minHandlingTime": "A String", # Minimal product handling time (in business days). |
| "mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page. |
| "mpn": "A String", # Manufacturer Part Number (MPN) of the item. |
| "multipack": "A String", # The number of identical products in a merchant-defined multipack. |
| "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. |
| "onlineOnly": True or False, # Deprecated. |
| "pattern": "A String", # The item's pattern (e.g. polka dots). |
| "price": { # Price of the item. |
| "currency": "A String", # The currency of the price. |
| "value": "A String", # The price represented as a number. |
| }, |
| "productType": "A String", # Your category of the item (formatted as in products data specification). |
| "promotionIds": [ # The unique ID of a promotion. |
| "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. |
| }, |
| "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products data specification). |
| "sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products. |
| "shipping": [ # Shipping rules. |
| { |
| "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. |
| "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. |
| "service": "A String", # A free-form description of the service class or delivery speed. |
| }, |
| ], |
| "shippingHeight": { # Height of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item. |
| }, |
| "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules. |
| "shippingLength": { # Length of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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. |
| }, |
| "shippingWidth": { # Width of the item for shipping. |
| "unit": "A String", # The unit of value. |
| "value": 3.14, # The dimension of the product used to calculate the shipping cost 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`" |
| "sizeType": "A String", # The cut of the item. Recommended for apparel items. |
| # |
| # Acceptable values are: |
| # - "`big and tall`" |
| # - "`maternity`" |
| # - "`oversize`" |
| # - "`petite`" |
| # - "`plus`" |
| # - "`regular`" |
| "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`" |
| "targetCountry": "A String", # Required. The CLDR territory code for the item. |
| "taxes": [ # Tax information. |
| { |
| "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code. |
| "locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the AdWords API. |
| "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*. |
| "rate": 3.14, # The percentage of tax rate that applies to the item price. |
| "region": "A String", # The geographic region to which the tax rate applies. |
| "taxShip": True or False, # Set to true if tax is charged on shipping. |
| }, |
| ], |
| "title": "A String", # Title of the item. |
| "unitPricingBaseMeasure": { # The preference of the denominator of the unit price. |
| "unit": "A String", # The unit of the denominator. |
| "value": "A String", # The denominator of the unit price. |
| }, |
| "unitPricingMeasure": { # The measure and dimension of an item. |
| "unit": "A String", # The unit of the measure. |
| "value": 3.14, # The measure of an item. |
| }, |
| "validatedDestinations": [ # Deprecated. The read-only list of intended destinations which passed validation. |
| "A String", |
| ], |
| "warnings": [ # Read-only warnings. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
