diff --git a/docs/dyn/content_v2_1.datafeeds.html b/docs/dyn/content_v2_1.datafeeds.html index 9c56411964c..dc153b6e99b 100644 --- a/docs/dyn/content_v2_1.datafeeds.html +++ b/docs/dyn/content_v2_1.datafeeds.html @@ -145,7 +145,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. @@ -204,7 +204,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. @@ -310,7 +310,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. @@ -361,7 +361,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. @@ -410,7 +410,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. @@ -472,7 +472,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. @@ -540,7 +540,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. @@ -589,7 +589,7 @@

Method Details

"targets": [ # The targets this feed should apply to (country, language, destinations). { "country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. diff --git a/docs/dyn/content_v2_1.products.html b/docs/dyn/content_v2_1.products.html index 00d050ae015..09cf0a40760 100644 --- a/docs/dyn/content_v2_1.products.html +++ b/docs/dyn/content_v2_1.products.html @@ -166,7 +166,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -306,7 +306,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { @@ -406,7 +406,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -546,7 +546,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { @@ -652,7 +652,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -792,7 +792,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { @@ -873,7 +873,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -1013,7 +1013,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { @@ -1093,7 +1093,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -1233,7 +1233,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { @@ -1325,7 +1325,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -1465,7 +1465,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { @@ -1563,7 +1563,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -1703,7 +1703,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { @@ -1783,7 +1783,7 @@

Method Details

"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. - "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). + "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. "A String", ], "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. @@ -1923,7 +1923,7 @@

Method Details

"period": "A String", # The type of subscription period. "periodLength": "A String", # The number of subscription periods the buyer has to pay. }, - "targetCountry": "A String", # Required. The CLDR territory code for the item. + "targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale. "taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings. "taxes": [ # Tax information. { diff --git a/docs/dyn/content_v2_1.quotas.html b/docs/dyn/content_v2_1.quotas.html index 126ca886468..276bcde6b4b 100644 --- a/docs/dyn/content_v2_1.quotas.html +++ b/docs/dyn/content_v2_1.quotas.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists the quota limit and quota usage per method for your Merchant Center account.

+

Lists the daily call quota and usage per method for your Merchant Center account.

list_next()

Retrieves the next page of results.

@@ -91,7 +91,7 @@

Method Details

list(merchantId, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the quota limit and quota usage per method for your Merchant Center account.
+  
Lists the daily call quota and usage per method for your Merchant Center account.
 
 Args:
   merchantId: string, Required. The ID of the account that has quota. This account must be an admin. (required)
@@ -107,10 +107,10 @@ 

Method Details

{ # Response message for the ListMethodQuotas method. "methodQuotas": [ # The current quota usage and limits per each method. - { # The quota information per method in the Content API. - "method": "A String", # The method name, for example “products.list”. Method name does not contain version because quota can be shared between different API versions of the same method. - "quotaLimit": "A String", # The current quota limit, for example the maximum number of calls for the method. - "quotaUsage": "A String", # The current quota usage, for example the number of calls for the method. + { # The quota information per method in the Content API. Includes only methods with current usage greater than zero for your account. + "method": "A String", # The method name, for example `products.list`. Method name does not contain version because quota can be shared between different API versions of the same method. + "quotaLimit": "A String", # The current quota limit per day, meaning the maximum number of calls for the method. + "quotaUsage": "A String", # The current quota usage, meaning the number of calls already made to the method. }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. diff --git a/docs/dyn/content_v2_1.reports.html b/docs/dyn/content_v2_1.reports.html index d8751f7bd22..a469b409158 100644 --- a/docs/dyn/content_v2_1.reports.html +++ b/docs/dyn/content_v2_1.reports.html @@ -117,43 +117,43 @@

Method Details

"results": [ # Rows that matched the search query. { # Result row returned from the search query. "bestSellers": { # Fields related to the [Best Sellers reports](https://support.google.com/merchants/answer/9488679). # Best Sellers fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersProductClusterView` or `BestSellersBrandView`. - "categoryId": "A String", # Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). - "countryCode": "A String", # Country where the ranking is calculated. + "categoryId": "A String", # Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). If a `WHERE` condition on `best_sellers.category_id` is not specified in the query, rankings for all top-level categories are returned. + "countryCode": "A String", # Country where the ranking is calculated. A `WHERE` condition on `best_sellers.country_code` is required in the query. "previousRank": "A String", # Popularity rank in the previous week or month. "previousRelativeDemand": "A String", # Estimated demand in relation to the item with the highest popularity rank in the same category and country in the previous week or month. "rank": "A String", # Popularity on Shopping ads and free listings, in the selected category and country, based on the estimated number of units sold. "relativeDemand": "A String", # Estimated demand in relation to the item with the highest popularity rank in the same category and country. "relativeDemandChange": "A String", # Change in the estimated demand. Whether it rose, sank or remained flat. - "reportDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Report date. The value of this field can only be one of the following: * The first day of the week (Monday) for weekly reports. * The first day of the month for monthly reports. + "reportDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Report date. The value of this field can only be one of the following: * The first day of the week (Monday) for weekly reports. * The first day of the month for monthly reports. If a `WHERE` condition on `best_sellers.report_date` is not specified in the query, the latest available weekly or monthly report is returned. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "reportGranularity": "A String", # Granularity of the report. The ranking can be done over a week or a month timeframe. + "reportGranularity": "A String", # Granularity of the report. The ranking can be done over a week or a month timeframe. A `WHERE` condition on `best_sellers.report_granularity` is required in the query. }, "brand": { # Brand fields. Values are only set for fields requested explicitly in the request's search query. # Brand fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersBrandView`. "name": "A String", # Name of the brand. }, "metrics": { # Performance metrics. Values are only set for metrics requested explicitly in the request's search query. # Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query. "aos": 3.14, # Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions and customer_country_code.** - "aovMicros": 3.14, # Average order value - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.** + "aovMicros": 3.14, # Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.** "clicks": "A String", # Number of clicks. "conversionRate": 3.14, # Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the FREE_PRODUCT_LISTING program. - "conversionValueMicros": "A String", # Value of conversions in micros attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. + "conversionValueMicros": "A String", # Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. "conversions": 3.14, # Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. The metric is currently available only for the FREE_PRODUCT_LISTING program. "ctr": 3.14, # Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). "daysToShip": 3.14, # Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.** "impressions": "A String", # Number of times merchant's products are shown. "itemDaysToShip": 3.14, # Average number of days between an item being ordered and the item being **This metric cannot be segmented by customer_country_code.** "itemFillRate": 3.14, # Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. **This metric cannot be segmented by customer_country_code.** - "orderedItemSalesMicros": "A String", # Total price of ordered items. Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.** + "orderedItemSalesMicros": "A String", # Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.** "orderedItems": "A String", # Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by customer_country_code.** "orders": "A String", # Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions and customer_country_code.** "rejectedItems": "A String", # Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by customer_country_code.** "returnRate": 3.14, # Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.** "returnedItems": "A String", # Number of ordered items sent back for return, reported on the date when the merchant accepted the return. **This metric cannot be segmented by customer_country_code.** - "returnsMicros": "A String", # Total price of ordered items sent back for return, reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.** - "shippedItemSalesMicros": "A String", # Total price of shipped items, reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.** + "returnsMicros": "A String", # Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.** + "shippedItemSalesMicros": "A String", # Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.** "shippedItems": "A String", # Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.** "shippedOrders": "A String", # Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.** "unshippedItems": 3.14, # Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. **This metric cannot be segmented by customer_country_code.** @@ -161,7 +161,7 @@

Method Details

}, "priceCompetitiveness": { # Price Competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`. https://support.google.com/merchants/answer/9626903 # Price Competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`. "benchmarkPriceCurrencyCode": "A String", # The price benchmark currency (ISO 4217 code). - "benchmarkPriceMicros": "A String", # The latest available price benchmark in micros for the product's catalog in the benchmark country. + "benchmarkPriceMicros": "A String", # The latest available price benchmark in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product's catalog in the benchmark country. "countryCode": "A String", # The country of the price benchmark (ISO 3166 code). }, "priceInsights": { # Price Insights fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceInsightsProductView`. https://support.google.com/merchants/answer/11916926 # Price Insights fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceInsightsProductView`. @@ -170,9 +170,9 @@

Method Details

"predictedGrossProfitChangeFraction": 3.14, # The predicted change in gross profit as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in gross profit. "predictedImpressionsChangeFraction": 3.14, # The predicted change in impressions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in impressions. "predictedMonthlyGrossProfitChangeCurrencyCode": "A String", # The predicted monthly gross profit change currency (ISO 4217 code). - "predictedMonthlyGrossProfitChangeMicros": "A String", # The predicted change in gross profit in micros after introducing the suggested price for a month compared to current active price. + "predictedMonthlyGrossProfitChangeMicros": "A String", # The predicted change in gross profit in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) after introducing the suggested price for a month compared to current active price. "suggestedPriceCurrencyCode": "A String", # The suggested price currency (ISO 4217 code). - "suggestedPriceMicros": "A String", # The latest suggested price in micros for the product. + "suggestedPriceMicros": "A String", # The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product. }, "productCluster": { # Product cluster fields. A product cluster is a grouping for different offers that represent the same product. Values are only set for fields requested explicitly in the request's search query. # Product cluster fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersProductClusterView`. "brand": "A String", # Brand of the product cluster. @@ -192,6 +192,11 @@

Method Details

"aggregatedDestinationStatus": "A String", # Aggregated destination status. "availability": "A String", # Availability of the product. "brand": "A String", # Brand of the product. + "categoryL1": "A String", # First level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). + "categoryL2": "A String", # Second level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). + "categoryL3": "A String", # Third level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). + "categoryL4": "A String", # Fourth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). + "categoryL5": "A String", # Fifth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). "channel": "A String", # Channel of the product (online versus local). "condition": "A String", # Condition of the product. "creationTime": "A String", # The time the merchant created the product in timestamp seconds. @@ -230,7 +235,12 @@

Method Details

], "languageCode": "A String", # Language code of the product in BCP 47 format. "offerId": "A String", # Merchant-provided id of the product. - "priceMicros": "A String", # Product price specified as micros in the product currency. Absent in case the information about the price of the product is not available. + "priceMicros": "A String", # Product price specified as micros (1 millionth of a standard unit, 1 USD = 1000000 micros) in the product currency. Absent in case the information about the price of the product is not available. + "productTypeL1": "A String", # First level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436). + "productTypeL2": "A String", # Second level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436). + "productTypeL3": "A String", # Third level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436). + "productTypeL4": "A String", # Fourth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436). + "productTypeL5": "A String", # Fifth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436). "shippingLabel": "A String", # The normalized shipping label specified in the feed "title": "A String", # Title of the product. }, diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index b7f015ece64..153aeabc440 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -4581,7 +4581,7 @@ "quotas": { "methods": { "list": { - "description": "Lists the quota limit and quota usage per method for your Merchant Center account.", + "description": "Lists the daily call quota and usage per method for your Merchant Center account.", "flatPath": "{merchantId}/quotas", "httpMethod": "GET", "id": "content.quotas.list", @@ -5953,7 +5953,7 @@ } } }, - "revision": "20221110", + "revision": "20221201", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -7169,12 +7169,12 @@ "id": "BestSellers", "properties": { "categoryId": { - "description": "Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", + "description": "Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). If a `WHERE` condition on `best_sellers.category_id` is not specified in the query, rankings for all top-level categories are returned.", "format": "int64", "type": "string" }, "countryCode": { - "description": "Country where the ranking is calculated.", + "description": "Country where the ranking is calculated. A `WHERE` condition on `best_sellers.country_code` is required in the query.", "type": "string" }, "previousRank": { @@ -7245,10 +7245,10 @@ }, "reportDate": { "$ref": "Date", - "description": "Report date. The value of this field can only be one of the following: * The first day of the week (Monday) for weekly reports. * The first day of the month for monthly reports." + "description": "Report date. The value of this field can only be one of the following: * The first day of the week (Monday) for weekly reports. * The first day of the month for monthly reports. If a `WHERE` condition on `best_sellers.report_date` is not specified in the query, the latest available weekly or monthly report is returned." }, "reportGranularity": { - "description": "Granularity of the report. The ranking can be done over a week or a month timeframe.", + "description": "Granularity of the report. The ranking can be done over a week or a month timeframe. A `WHERE` condition on `best_sellers.report_granularity` is required in the query.", "enum": [ "REPORT_GRANULARITY_UNSPECIFIED", "WEEKLY", @@ -7996,7 +7996,7 @@ "type": "string" }, "excludedDestinations": { - "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center).", + "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.", "items": { "type": "string" }, @@ -9681,20 +9681,20 @@ "type": "object" }, "MethodQuota": { - "description": "The quota information per method in the Content API.", + "description": "The quota information per method in the Content API. Includes only methods with current usage greater than zero for your account.", "id": "MethodQuota", "properties": { "method": { - "description": "The method name, for example \u201cproducts.list\u201d. Method name does not contain version because quota can be shared between different API versions of the same method.", + "description": "The method name, for example `products.list`. Method name does not contain version because quota can be shared between different API versions of the same method.", "type": "string" }, "quotaLimit": { - "description": "The current quota limit, for example the maximum number of calls for the method.", + "description": "The current quota limit per day, meaning the maximum number of calls for the method.", "format": "int64", "type": "string" }, "quotaUsage": { - "description": "The current quota usage, for example the number of calls for the method.", + "description": "The current quota usage, meaning the number of calls already made to the method.", "format": "int64", "type": "string" } @@ -9711,7 +9711,7 @@ "type": "number" }, "aovMicros": { - "description": "Average order value - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**", + "description": "Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**", "format": "double", "type": "number" }, @@ -9726,7 +9726,7 @@ "type": "number" }, "conversionValueMicros": { - "description": "Value of conversions in micros attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.", + "description": "Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.", "format": "int64", "type": "string" }, @@ -9761,7 +9761,7 @@ "type": "number" }, "orderedItemSalesMicros": { - "description": "Total price of ordered items. Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", + "description": "Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, @@ -9791,12 +9791,12 @@ "type": "string" }, "returnsMicros": { - "description": "Total price of ordered items sent back for return, reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", + "description": "Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "shippedItemSalesMicros": { - "description": "Total price of shipped items, reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", + "description": "Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, @@ -12681,7 +12681,7 @@ "type": "string" }, "benchmarkPriceMicros": { - "description": "The latest available price benchmark in micros for the product's catalog in the benchmark country.", + "description": "The latest available price benchmark in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product's catalog in the benchmark country.", "format": "int64", "type": "string" }, @@ -12721,7 +12721,7 @@ "type": "string" }, "predictedMonthlyGrossProfitChangeMicros": { - "description": "The predicted change in gross profit in micros after introducing the suggested price for a month compared to current active price.", + "description": "The predicted change in gross profit in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) after introducing the suggested price for a month compared to current active price.", "format": "int64", "type": "string" }, @@ -12730,7 +12730,7 @@ "type": "string" }, "suggestedPriceMicros": { - "description": "The latest suggested price in micros for the product.", + "description": "The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product.", "format": "int64", "type": "string" } @@ -12871,7 +12871,7 @@ "type": "string" }, "excludedDestinations": { - "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center).", + "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.", "items": { "type": "string" }, @@ -13126,7 +13126,7 @@ "description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract." }, "targetCountry": { - "description": "Required. The CLDR territory code for the item.", + "description": "Required. The CLDR territory code for the item's country of sale.", "type": "string" }, "taxCategory": { @@ -13680,6 +13680,26 @@ "description": "Brand of the product.", "type": "string" }, + "categoryL1": { + "description": "First level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "categoryL2": { + "description": "Second level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "categoryL3": { + "description": "Third level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "categoryL4": { + "description": "Fourth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "categoryL5": { + "description": "Fifth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, "channel": { "description": "Channel of the product (online versus local).", "enum": [ @@ -13742,10 +13762,30 @@ "type": "string" }, "priceMicros": { - "description": "Product price specified as micros in the product currency. Absent in case the information about the price of the product is not available.", + "description": "Product price specified as micros (1 millionth of a standard unit, 1 USD = 1000000 micros) in the product currency. Absent in case the information about the price of the product is not available.", "format": "int64", "type": "string" }, + "productTypeL1": { + "description": "First level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "productTypeL2": { + "description": "Second level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "productTypeL3": { + "description": "Third level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "productTypeL4": { + "description": "Fourth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, + "productTypeL5": { + "description": "Fifth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).", + "type": "string" + }, "shippingLabel": { "description": "The normalized shipping label specified in the feed", "type": "string"