File: content_v2_1.regionalinventory.html

package info (click to toggle)
python-googleapi 2.187.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 562,316 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (254 lines) | stat: -rw-r--r-- 13,753 bytes parent folder | download | duplicates (2)
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
244
245
246
247
248
249
250
251
252
253
254
<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.regionalinventory.html">regionalinventory</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 regional inventory for multiple products or regions 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 regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.</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 regional inventory for multiple products or regions in a single request.

Args:
  body: object, The request body.
    The object takes the form of:

{
  &quot;entries&quot;: [ # The request entries to be processed in the batch.
    { # A batch entry encoding a single non-batch regional inventory request.
      &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
      &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
      &quot;method&quot;: &quot;A String&quot;, # Method of the batch request entry. Acceptable values are: - &quot;`insert`&quot;
      &quot;productId&quot;: &quot;A String&quot;, # The ID of the product for which to update price and availability.
      &quot;regionalInventory&quot;: { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
        &quot;availability&quot;: &quot;A String&quot;, # The availability of the product.
        &quot;customAttributes&quot;: [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
          { # 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.
            &quot;groupValues&quot;: [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
              # Object with schema name: CustomAttribute
            ],
            &quot;name&quot;: &quot;A String&quot;, # The name of the attribute. Underscores will be replaced by spaces upon insertion.
            &quot;value&quot;: &quot;A String&quot;, # The value of the attribute.
          },
        ],
        &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#regionalInventory`&quot;.
        &quot;price&quot;: { # The price of the product.
          &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
          &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
        },
        &quot;regionId&quot;: &quot;A String&quot;, # The ID uniquely identifying each region.
        &quot;salePrice&quot;: { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
          &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
          &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
        },
        &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 might be specified as &#x27;null&#x27; if undecided.
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;entries&quot;: [ # The result of the execution of the batch requests.
    { # A batch entry encoding a single non-batch regional inventory response.
      &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
      &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.
        &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
        &quot;errors&quot;: [ # A list of errors.
          { # An error returned by the API.
            &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
            &quot;message&quot;: &quot;A String&quot;, # A description of the error.
            &quot;reason&quot;: &quot;A String&quot;, # The error code.
          },
        ],
        &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
      },
      &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#regionalinventoryCustomBatchResponseEntry`&quot;.
      &quot;regionalInventory&quot;: { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. # Price and availability of the product.
        &quot;availability&quot;: &quot;A String&quot;, # The availability of the product.
        &quot;customAttributes&quot;: [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
          { # 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.
            &quot;groupValues&quot;: [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
              # Object with schema name: CustomAttribute
            ],
            &quot;name&quot;: &quot;A String&quot;, # The name of the attribute. Underscores will be replaced by spaces upon insertion.
            &quot;value&quot;: &quot;A String&quot;, # The value of the attribute.
          },
        ],
        &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#regionalInventory`&quot;.
        &quot;price&quot;: { # The price of the product.
          &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
          &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
        },
        &quot;regionId&quot;: &quot;A String&quot;, # The ID uniquely identifying each region.
        &quot;salePrice&quot;: { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
          &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
          &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
        },
        &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 might be specified as &#x27;null&#x27; if undecided.
      },
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#regionalinventoryCustomBatchResponse`&quot;.
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(merchantId, productId, body=None, x__xgafv=None)</code>
  <pre>Updates the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.

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 the regional inventory. (required)
  body: object, The request body.
    The object takes the form of:

{ # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
  &quot;availability&quot;: &quot;A String&quot;, # The availability of the product.
  &quot;customAttributes&quot;: [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
    { # 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.
      &quot;groupValues&quot;: [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
        # Object with schema name: CustomAttribute
      ],
      &quot;name&quot;: &quot;A String&quot;, # The name of the attribute. Underscores will be replaced by spaces upon insertion.
      &quot;value&quot;: &quot;A String&quot;, # The value of the attribute.
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#regionalInventory`&quot;.
  &quot;price&quot;: { # The price of the product.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;regionId&quot;: &quot;A String&quot;, # The ID uniquely identifying each region.
  &quot;salePrice&quot;: { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &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 might be specified as &#x27;null&#x27; if undecided.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
  &quot;availability&quot;: &quot;A String&quot;, # The availability of the product.
  &quot;customAttributes&quot;: [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
    { # 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.
      &quot;groupValues&quot;: [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
        # Object with schema name: CustomAttribute
      ],
      &quot;name&quot;: &quot;A String&quot;, # The name of the attribute. Underscores will be replaced by spaces upon insertion.
      &quot;value&quot;: &quot;A String&quot;, # The value of the attribute.
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#regionalInventory`&quot;.
  &quot;price&quot;: { # The price of the product.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;regionId&quot;: &quot;A String&quot;, # The ID uniquely identifying each region.
  &quot;salePrice&quot;: { # The sale price of the product. Mandatory if `sale_price_effective_date` is defined.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &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 might be specified as &#x27;null&#x27; if undecided.
}</pre>
</div>

</body></html>