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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
<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.returnaddress.html">returnaddress</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">Batches multiple return address related calls in a single request.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, returnAddressId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a return address for the given Merchant Center account.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, returnAddressId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a return address of the Merchant Center account.</p>
<p class="toc_element">
<code><a href="#insert">insert(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a return address for the Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, country=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the return addresses of the Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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>Batches multiple return address related calls 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.
{
"batchId": 42, # An entry ID, unique within the batch request.
"merchantId": "A String", # The Merchant Center account ID.
"method": "A String", # Method of the batch request entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`"
"returnAddress": { # Return address resource. # The return address to submit. This should be set only if the method is `insert`.
"address": { # Required. The address.
"country": "A String", # CLDR country code (for example, "US").
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"recipientName": "A String", # Name of the recipient to address returns to.
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element.
"A String",
],
},
"country": "A String", # Required. The country of sale where the return address is applicable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`"
"label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default".
"phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return.
"returnAddressId": "A String", # Return address ID generated by Google.
},
"returnAddressId": "A String", # The return address ID. This should be set only if the method is `delete` or `get`.
},
],
}
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.
{
"batchId": 42, # The ID of the request entry to which this entry responds.
"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#returnaddressCustomBatchResponseEntry`"
"returnAddress": { # Return address resource. # The retrieved return address.
"address": { # Required. The address.
"country": "A String", # CLDR country code (for example, "US").
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"recipientName": "A String", # Name of the recipient to address returns to.
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element.
"A String",
],
},
"country": "A String", # Required. The country of sale where the return address is applicable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`"
"label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default".
"phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return.
"returnAddressId": "A String", # Return address ID generated by Google.
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressCustomBatchResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, returnAddressId, x__xgafv=None)</code>
<pre>Deletes a return address for the given Merchant Center account.
Args:
merchantId: string, The Merchant Center account from which to delete the given return address. (required)
returnAddressId: string, Return address ID generated by Google. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, returnAddressId, x__xgafv=None)</code>
<pre>Gets a return address of the Merchant Center account.
Args:
merchantId: string, The Merchant Center account to get a return address for. (required)
returnAddressId: string, Return address ID generated by Google. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Return address resource.
"address": { # Required. The address.
"country": "A String", # CLDR country code (for example, "US").
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"recipientName": "A String", # Name of the recipient to address returns to.
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element.
"A String",
],
},
"country": "A String", # Required. The country of sale where the return address is applicable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`"
"label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default".
"phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return.
"returnAddressId": "A String", # Return address ID generated by Google.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, body=None, x__xgafv=None)</code>
<pre>Inserts a return address for the Merchant Center account.
Args:
merchantId: string, The Merchant Center account to insert a return address for. (required)
body: object, The request body.
The object takes the form of:
{ # Return address resource.
"address": { # Required. The address.
"country": "A String", # CLDR country code (for example, "US").
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"recipientName": "A String", # Name of the recipient to address returns to.
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element.
"A String",
],
},
"country": "A String", # Required. The country of sale where the return address is applicable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`"
"label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default".
"phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return.
"returnAddressId": "A String", # Return address ID generated by Google.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Return address resource.
"address": { # Required. The address.
"country": "A String", # CLDR country code (for example, "US").
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"recipientName": "A String", # Name of the recipient to address returns to.
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element.
"A String",
],
},
"country": "A String", # Required. The country of sale where the return address is applicable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`"
"label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default".
"phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return.
"returnAddressId": "A String", # Return address ID generated by Google.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, country=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the return addresses of the Merchant Center account.
Args:
merchantId: string, The Merchant Center account to list return addresses for. (required)
country: string, List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.
maxResults: integer, The maximum number of addresses in the response, used for paging.
pageToken: string, The token returned by the previous request.
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#returnaddressListResponse`".
"nextPageToken": "A String", # The token for the retrieval of the next page of addresses.
"resources": [
{ # Return address resource.
"address": { # Required. The address.
"country": "A String", # CLDR country code (for example, "US").
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"recipientName": "A String", # Name of the recipient to address returns to.
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element.
"A String",
],
},
"country": "A String", # Required. The country of sale where the return address is applicable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`"
"label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default".
"phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return.
"returnAddressId": "A String", # Return address ID generated by Google.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
