Debian Codegraph @

docs/dyn/content_v2_1.localinventory.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.localinventory.html">localinventory</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Updates local inventory for multiple products or stores in a single request.</p>
83 <p class="toc_element">
84 <code><a href="#insert">insert(merchantId, productId, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Updates the local inventory of a product in your Merchant Center account.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code>
94 <pre>Updates local inventory for multiple products or stores in a single request.
95
96 Args:
97 body: object, The request body.
98 The object takes the form of:
99
100 {
101 &quot;entries&quot;: [ # The request entries to be processed in the batch.
102 { # Batch entry encoding a single local inventory update request.
103 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
104 &quot;localInventory&quot;: { # Local inventory resource. For accepted attribute values, see the local product inventory feed specification. # Local inventory of the product.
105 &quot;availability&quot;: &quot;A String&quot;, # The availability of the product. For accepted attribute values, see the local product inventory feed specification.
106 &quot;customAttributes&quot;: [ # 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, `{ &quot;name&quot;: &quot;size type&quot;, &quot;value&quot;: &quot;regular&quot; }`.
107 { # 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.
108 &quot;groupValues&quot;: [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
109 # Object with schema name: CustomAttribute
110 ],
111 &quot;name&quot;: &quot;A String&quot;, # The name of the attribute. Underscores will be replaced by spaces upon insertion.
112 &quot;value&quot;: &quot;A String&quot;, # The value of the attribute.
113 },
114 ],
115 &quot;instoreProductLocation&quot;: &quot;A String&quot;, # The in-store product location.
116 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#localInventory`&quot;
117 &quot;pickupMethod&quot;: &quot;A String&quot;, # The supported pickup method for this offer. Unless the value is &quot;not supported&quot;, this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed specification.
118 &quot;pickupSla&quot;: &quot;A String&quot;, # 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.
119 &quot;price&quot;: { # The price of the product.
120 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
121 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
122 },
123 &quot;quantity&quot;: 42, # The quantity of the product. Must be nonnegative.
124 &quot;salePrice&quot;: { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
125 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
126 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
127 },
128 &quot;salePriceEffectiveDate&quot;: &quot;A String&quot;, # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as &#x27;null&#x27; if undecided.
129 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The store code of this local inventory resource.
130 },
131 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
132 &quot;method&quot;: &quot;A String&quot;, # Method of the batch request entry. Acceptable values are: - &quot;`insert`&quot;
133 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product for which to update local inventory.
134 },
135 ],
136 }
137
138 x__xgafv: string, V1 error format.
139 Allowed values
140 1 - v1 error format
141 2 - v2 error format
142
143 Returns:
144 An object of the form:
145
146 {
147 &quot;entries&quot;: [ # The result of the execution of the batch requests.
148 { # Batch entry encoding a single local inventory update response.
149 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
150 &quot;errors&quot;: { # 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.
151 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
152 &quot;errors&quot;: [ # A list of errors.
153 { # An error returned by the API.
154 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
155 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
156 &quot;reason&quot;: &quot;A String&quot;, # The error code.
157 },
158 ],
159 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
160 },
161 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#localinventoryCustomBatchResponseEntry`&quot;
162 },
163 ],
164 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#localinventoryCustomBatchResponse`&quot;.
165 }</pre>
166 </div>
167
168 <div class="method">
169 <code class="details" id="insert">insert(merchantId, productId, body=None, x__xgafv=None)</code>
170 <pre>Updates the local inventory of a product in your Merchant Center account.
171
172 Args:
173 merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
174 productId: string, The REST ID of the product for which to update local inventory. (required)
175 body: object, The request body.
176 The object takes the form of:
177
178 { # Local inventory resource. For accepted attribute values, see the local product inventory feed specification.
179 &quot;availability&quot;: &quot;A String&quot;, # The availability of the product. For accepted attribute values, see the local product inventory feed specification.
180 &quot;customAttributes&quot;: [ # 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, `{ &quot;name&quot;: &quot;size type&quot;, &quot;value&quot;: &quot;regular&quot; }`.
181 { # 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.
182 &quot;groupValues&quot;: [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
183 # Object with schema name: CustomAttribute
184 ],
185 &quot;name&quot;: &quot;A String&quot;, # The name of the attribute. Underscores will be replaced by spaces upon insertion.
186 &quot;value&quot;: &quot;A String&quot;, # The value of the attribute.
187 },
188 ],
189 &quot;instoreProductLocation&quot;: &quot;A String&quot;, # The in-store product location.
190 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#localInventory`&quot;
191 &quot;pickupMethod&quot;: &quot;A String&quot;, # The supported pickup method for this offer. Unless the value is &quot;not supported&quot;, this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed specification.
192 &quot;pickupSla&quot;: &quot;A String&quot;, # 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.
193 &quot;price&quot;: { # The price of the product.
194 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
195 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
196 },
197 &quot;quantity&quot;: 42, # The quantity of the product. Must be nonnegative.
198 &quot;salePrice&quot;: { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
199 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
200 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
201 },
202 &quot;salePriceEffectiveDate&quot;: &quot;A String&quot;, # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as &#x27;null&#x27; if undecided.
203 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The store code of this local inventory resource.
204 }
205
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211 Returns:
212 An object of the form:
213
214 { # Local inventory resource. For accepted attribute values, see the local product inventory feed specification.
215 &quot;availability&quot;: &quot;A String&quot;, # The availability of the product. For accepted attribute values, see the local product inventory feed specification.
216 &quot;customAttributes&quot;: [ # 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, `{ &quot;name&quot;: &quot;size type&quot;, &quot;value&quot;: &quot;regular&quot; }`.
217 { # 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.
218 &quot;groupValues&quot;: [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
219 # Object with schema name: CustomAttribute
220 ],
221 &quot;name&quot;: &quot;A String&quot;, # The name of the attribute. Underscores will be replaced by spaces upon insertion.
222 &quot;value&quot;: &quot;A String&quot;, # The value of the attribute.
223 },
224 ],
225 &quot;instoreProductLocation&quot;: &quot;A String&quot;, # The in-store product location.
226 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#localInventory`&quot;
227 &quot;pickupMethod&quot;: &quot;A String&quot;, # The supported pickup method for this offer. Unless the value is &quot;not supported&quot;, this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed specification.
228 &quot;pickupSla&quot;: &quot;A String&quot;, # 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.
229 &quot;price&quot;: { # The price of the product.
230 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
231 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
232 },
233 &quot;quantity&quot;: 42, # The quantity of the product. Must be nonnegative.
234 &quot;salePrice&quot;: { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
235 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
236 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
237 },
238 &quot;salePriceEffectiveDate&quot;: &quot;A String&quot;, # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as &#x27;null&#x27; if undecided.
239 &quot;storeCode&quot;: &quot;A String&quot;, # Required. The store code of this local inventory resource.
240 }</pre>
241 </div>
242
243 </body></html>