1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<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.inventory.html">inventory</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.</p>
<p class="toc_element">
<code><a href="#set">set(merchantId, storeCode, productId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates price and availability of a product in your Merchant Center account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</code>
<pre>Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.
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 inventory request.
"batchId": 42, # An entry ID, unique within the batch request.
"inventory": { # Price and availability of the product.
"availability": "A String", # The availability of the product. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel4": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
"installment": { # Number and amount of installments to pay for an item. Brazil only.
"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.
},
"instoreProductLocation": "A String", # The instore product location. Supported only for local products.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#inventory`"
"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.
},
"pickup": { # Store pickup information. Only supported for local inventory. Not setting `pickup` means "don't update" while setting it to the empty value (`{}` in JSON) means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set together, unless `pickupMethod` is "not supported".
"pickupMethod": "A String", # Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with `pickupSla`. Acceptable values are: - "`buy`" - "`not supported`" - "`reserve`" - "`ship to store`"
"pickupSla": "A String", # The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with `pickupMethod`. Acceptable values are: - "`five day`" - "`four day`" - "`multi day`" - "`multi week`" - "`next day`" - "`same day`" - "`seven day`" - "`six day`" - "`three day`" - "`two day`"
},
"price": { # The price of the product.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": 42, # The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
"salePrice": { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
"sellOnGoogleQuantity": 42, # The quantity of the product that is available for selling on Google. Supported only for online products.
},
"merchantId": "A String", # The ID of the managing account.
"productId": "A String", # The ID of the product for which to update price and availability.
"storeCode": "A String", # The code of the store for which to update price and availability. Use `online` to update price and availability of an online product.
},
],
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch inventory 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": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#inventoryCustomBatchResponseEntry`"
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="set">set(merchantId, storeCode, productId, body=None, dryRun=None, x__xgafv=None)</code>
<pre>Updates price and availability of a product in 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)
storeCode: string, The code of the store for which to update price and availability. Use `online` to update price and availability of an online product. (required)
productId: string, The REST ID of the product for which to update price and availability. (required)
body: object, The request body.
The object takes the form of:
{
"availability": "A String", # The availability of the product. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`"
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
"customLabel4": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
"installment": { # Number and amount of installments to pay for an item. Brazil only.
"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.
},
"instoreProductLocation": "A String", # The instore product location. Supported only for local products.
"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.
},
"pickup": { # Store pickup information. Only supported for local inventory. Not setting `pickup` means "don't update" while setting it to the empty value (`{}` in JSON) means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set together, unless `pickupMethod` is "not supported".
"pickupMethod": "A String", # Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with `pickupSla`. Acceptable values are: - "`buy`" - "`not supported`" - "`reserve`" - "`ship to store`"
"pickupSla": "A String", # The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with `pickupMethod`. Acceptable values are: - "`five day`" - "`four day`" - "`multi day`" - "`multi week`" - "`next day`" - "`same day`" - "`seven day`" - "`six day`" - "`three day`" - "`two day`"
},
"price": { # The price of the product.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"quantity": 42, # The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
"salePrice": { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
"sellOnGoogleQuantity": 42, # The quantity of the product that is available for selling on Google. Supported only for online products.
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse".
}</pre>
</div>
</body></html>
|
