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
242
243
|
<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_1.html">Content API for Shopping</a> . <a href="content_v2_1.localinventory.html">localinventory</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, x__xgafv=None)</a></code></p>
<p class="firstline">Updates local inventory for multiple products or stores in a single request.</p>
<p class="toc_element">
<code><a href="#insert">insert(merchantId, productId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the local inventory 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, x__xgafv=None)</code>
<pre>Updates local inventory for multiple products or stores 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.
{ # Batch entry encoding a single local inventory update request.
"batchId": 42, # An entry ID, unique within the batch request.
"localInventory": { # Local inventory resource. For accepted attribute values, see the local product inventory feed specification. # Local inventory of the product.
"availability": "A String", # The availability of the product. For accepted attribute values, see the local product inventory feed specification.
"customAttributes": [ # A list of custom (merchant-provided) attributes. Can also be used to submit any attribute of the feed specification in its generic form, for example, `{ "name": "size type", "value": "regular" }`.
{ # A message that represents custom attributes. Exactly one of `value` or `groupValues` must be provided. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per merchant, with total size of 102.4kB.
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
"value": "A String", # The value of the attribute.
},
],
"instoreProductLocation": "A String", # The in-store product location.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#localInventory`"
"pickupMethod": "A String", # The supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed specification.
"pickupSla": "A String", # The expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.
"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 nonnegative.
"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 may be specified as 'null' if undecided.
"storeCode": "A String", # Required. The store code of this local inventory resource.
},
"merchantId": "A String", # The ID of the managing account.
"method": "A String", # Method of the batch request entry. Acceptable values are: - "`insert`"
"productId": "A String", # The ID of the product for which to update local inventory.
},
],
}
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.
{ # Batch entry encoding a single local inventory update 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 for failed custombatch entries. *Note:* Schema errors fail the whole request.
"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#localinventoryCustomBatchResponseEntry`"
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#localinventoryCustomBatchResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, productId, body=None, x__xgafv=None)</code>
<pre>Updates the local inventory 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)
productId: string, The REST ID of the product for which to update local inventory. (required)
body: object, The request body.
The object takes the form of:
{ # Local inventory resource. For accepted attribute values, see the local product inventory feed specification.
"availability": "A String", # The availability of the product. For accepted attribute values, see the local product inventory feed specification.
"customAttributes": [ # A list of custom (merchant-provided) attributes. Can also be used to submit any attribute of the feed specification in its generic form, for example, `{ "name": "size type", "value": "regular" }`.
{ # A message that represents custom attributes. Exactly one of `value` or `groupValues` must be provided. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per merchant, with total size of 102.4kB.
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
"value": "A String", # The value of the attribute.
},
],
"instoreProductLocation": "A String", # The in-store product location.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#localInventory`"
"pickupMethod": "A String", # The supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed specification.
"pickupSla": "A String", # The expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.
"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 nonnegative.
"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 may be specified as 'null' if undecided.
"storeCode": "A String", # Required. The store code of this local inventory resource.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Local inventory resource. For accepted attribute values, see the local product inventory feed specification.
"availability": "A String", # The availability of the product. For accepted attribute values, see the local product inventory feed specification.
"customAttributes": [ # A list of custom (merchant-provided) attributes. Can also be used to submit any attribute of the feed specification in its generic form, for example, `{ "name": "size type", "value": "regular" }`.
{ # A message that represents custom attributes. Exactly one of `value` or `groupValues` must be provided. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per merchant, with total size of 102.4kB.
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
"value": "A String", # The value of the attribute.
},
],
"instoreProductLocation": "A String", # The in-store product location.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#localInventory`"
"pickupMethod": "A String", # The supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed specification.
"pickupSla": "A String", # The expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.
"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 nonnegative.
"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 may be specified as 'null' if undecided.
"storeCode": "A String", # Required. The store code of this local inventory resource.
}</pre>
</div>
</body></html>
|
