You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/content_v2_1.promotions.html
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -98,14 +98,14 @@ <h3>Method Details</h3>
98
98
body: object, The request body.
99
99
The object takes the form of:
100
100
101
-
{ # The Promotions feature is available for `AU`, `CA`, `DE`, `FR`, `GB`, `IN` and `US` target countries, and `en` content language. Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
101
+
{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
102
102
"brand": [ # Product filter by brand for the promotion.
103
103
"A String",
104
104
],
105
105
"brandExclusion": [ # Product filter by brand exclusion for the promotion.
106
106
"A String",
107
107
],
108
-
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. Currently only `en` value is supported.
108
+
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries, and `de` content language is available for `DE` target country.
109
109
"couponValueType": "A String", # Required. Coupon value type for the promotion.
110
110
"freeGiftDescription": "A String", # Free gift description for the promotion.
111
111
"freeGiftItemId": "A String", # Free gift item ID for the promotion.
@@ -188,14 +188,14 @@ <h3>Method Details</h3>
188
188
Returns:
189
189
An object of the form:
190
190
191
-
{ # The Promotions feature is available for `AU`, `CA`, `DE`, `FR`, `GB`, `IN` and `US` target countries, and `en` content language. Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
191
+
{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
192
192
"brand": [ # Product filter by brand for the promotion.
193
193
"A String",
194
194
],
195
195
"brandExclusion": [ # Product filter by brand exclusion for the promotion.
196
196
"A String",
197
197
],
198
-
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. Currently only `en` value is supported.
198
+
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries, and `de` content language is available for `DE` target country.
199
199
"couponValueType": "A String", # Required. Coupon value type for the promotion.
200
200
"freeGiftDescription": "A String", # Free gift description for the promotion.
201
201
"freeGiftItemId": "A String", # Free gift item ID for the promotion.
@@ -286,14 +286,14 @@ <h3>Method Details</h3>
286
286
Returns:
287
287
An object of the form:
288
288
289
-
{ # The Promotions feature is available for `AU`, `CA`, `DE`, `FR`, `GB`, `IN` and `US` target countries, and `en` content language. Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
289
+
{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
290
290
"brand": [ # Product filter by brand for the promotion.
291
291
"A String",
292
292
],
293
293
"brandExclusion": [ # Product filter by brand exclusion for the promotion.
294
294
"A String",
295
295
],
296
-
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. Currently only `en` value is supported.
296
+
"contentLanguage": "A String", # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries, and `de` content language is available for `DE` target country.
297
297
"couponValueType": "A String", # Required. Coupon value type for the promotion.
298
298
"freeGiftDescription": "A String", # Free gift description for the promotion.
299
299
"freeGiftItemId": "A String", # Free gift item ID for the promotion.
Copy file name to clipboardExpand all lines: docs/dyn/content_v2_1.reports.html
+18-17Lines changed: 18 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -117,29 +117,29 @@ <h3>Method Details</h3>
117
117
"results": [ # Rows that matched the search query.
118
118
{ # Result row returned from the search query.
119
119
"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.
120
-
"aos": 3.14, # Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions.**
121
-
"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.**
120
+
"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.**
121
+
"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.**
122
122
"clicks": "A String", # Number of clicks.
123
123
"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.
124
124
"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.
125
125
"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.
126
126
"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).
127
-
"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.**
127
+
"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.**
128
128
"impressions": "A String", # Number of times merchant's products are shown.
129
-
"itemDaysToShip": 3.14, # Average number of days between an item being ordered and the item being
130
-
"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.
131
-
"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.
132
-
"orderedItems": "A String", # Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order.
133
-
"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.**
134
-
"rejectedItems": "A String", # Number of ordered items canceled by the merchant, reported on the order date.
135
-
"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.
136
-
"returnedItems": "A String", # Number of ordered items sent back for return, reported on the date when the merchant accepted the return.
137
-
"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.
138
-
"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.
139
-
"shippedItems": "A String", # Number of shipped items, reported on the shipment date.
140
-
"shippedOrders": "A String", # Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions.**
141
-
"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.
142
-
"unshippedOrders": 3.14, # Number of orders not shipped or partially 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 orders over the days in the queried period. **This metric cannot be segmented by product dimensions.**
129
+
"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.**
130
+
"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.**
131
+
"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.**
132
+
"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.**
133
+
"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.**
134
+
"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.**
135
+
"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.**
136
+
"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.**
137
+
"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.**
138
+
"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.**
139
+
"shippedItems": "A String", # Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.**
140
+
"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.**
141
+
"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.**
142
+
"unshippedOrders": 3.14, # Number of orders not shipped or partially 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 orders over the days in the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.**
143
143
},
144
144
"segments": { # Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query. # Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query.
145
145
"brand": "A String", # Brand of the product.
@@ -154,6 +154,7 @@ <h3>Method Details</h3>
154
154
"customLabel2": "A String", # Custom label 2 for custom grouping of products.
155
155
"customLabel3": "A String", # Custom label 3 for custom grouping of products.
156
156
"customLabel4": "A String", # Custom label 4 for custom grouping of products.
157
+
"customerCountryCode": "A String", # Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. If the customer country cannot be determined, a special 'ZZ' code is returned.
157
158
"date": { # 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 # Date in the merchant timezone to which metrics apply.
158
159
"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.
159
160
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
0 commit comments