1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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.returnaddress.html">returnaddress</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">Batches multiple return address related calls in a single request.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(merchantId, returnAddressId, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a return address for the given Merchant Center account.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(merchantId, returnAddressId, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a return address of the Merchant Center account.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(merchantId, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Inserts a return address for the Merchant Center account.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(merchantId, country=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists the return addresses of the Merchant Center account.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code> 106 <pre>Batches multiple return address related calls in a single request. 107 108Args: 109 body: object, The request body. 110 The object takes the form of: 111 112{ 113 "entries": [ # The request entries to be processed in the batch. 114 { 115 "batchId": 42, # An entry ID, unique within the batch request. 116 "merchantId": "A String", # The Merchant Center account ID. 117 "method": "A String", # Method of the batch request entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" 118 "returnAddress": { # Return address resource. # The return address to submit. This should be set only if the method is `insert`. 119 "address": { # Required. The address. 120 "country": "A String", # CLDR country code (e.g. "US"). 121 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 122 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 123 "recipientName": "A String", # Name of the recipient to address returns to. 124 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 125 "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. 126 "A String", 127 ], 128 }, 129 "country": "A String", # Required. The country of sale where the return address is applicable. 130 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" 131 "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". 132 "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. 133 "returnAddressId": "A String", # Return address ID generated by Google. 134 }, 135 "returnAddressId": "A String", # The return address ID. This should be set only if the method is `delete` or `get`. 136 }, 137 ], 138} 139 140 x__xgafv: string, V1 error format. 141 Allowed values 142 1 - v1 error format 143 2 - v2 error format 144 145Returns: 146 An object of the form: 147 148 { 149 "entries": [ # The result of the execution of the batch requests. 150 { 151 "batchId": 42, # The ID of the request entry to which this entry responds. 152 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed. 153 "code": 42, # The HTTP status of the first error in `errors`. 154 "errors": [ # A list of errors. 155 { # An error returned by the API. 156 "domain": "A String", # The domain of the error. 157 "message": "A String", # A description of the error. 158 "reason": "A String", # The error code. 159 }, 160 ], 161 "message": "A String", # The message of the first error in `errors`. 162 }, 163 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressCustomBatchResponseEntry`" 164 "returnAddress": { # Return address resource. # The retrieved return address. 165 "address": { # Required. The address. 166 "country": "A String", # CLDR country code (e.g. "US"). 167 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 168 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 169 "recipientName": "A String", # Name of the recipient to address returns to. 170 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 171 "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. 172 "A String", 173 ], 174 }, 175 "country": "A String", # Required. The country of sale where the return address is applicable. 176 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" 177 "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". 178 "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. 179 "returnAddressId": "A String", # Return address ID generated by Google. 180 }, 181 }, 182 ], 183 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressCustomBatchResponse`". 184}</pre> 185</div> 186 187<div class="method"> 188 <code class="details" id="delete">delete(merchantId, returnAddressId, x__xgafv=None)</code> 189 <pre>Deletes a return address for the given Merchant Center account. 190 191Args: 192 merchantId: string, The Merchant Center account from which to delete the given return address. (required) 193 returnAddressId: string, Return address ID generated by Google. (required) 194 x__xgafv: string, V1 error format. 195 Allowed values 196 1 - v1 error format 197 2 - v2 error format 198</pre> 199</div> 200 201<div class="method"> 202 <code class="details" id="get">get(merchantId, returnAddressId, x__xgafv=None)</code> 203 <pre>Gets a return address of the Merchant Center account. 204 205Args: 206 merchantId: string, The Merchant Center account to get a return address for. (required) 207 returnAddressId: string, Return address ID generated by Google. (required) 208 x__xgafv: string, V1 error format. 209 Allowed values 210 1 - v1 error format 211 2 - v2 error format 212 213Returns: 214 An object of the form: 215 216 { # Return address resource. 217 "address": { # Required. The address. 218 "country": "A String", # CLDR country code (e.g. "US"). 219 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 220 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 221 "recipientName": "A String", # Name of the recipient to address returns to. 222 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 223 "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. 224 "A String", 225 ], 226 }, 227 "country": "A String", # Required. The country of sale where the return address is applicable. 228 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" 229 "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". 230 "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. 231 "returnAddressId": "A String", # Return address ID generated by Google. 232}</pre> 233</div> 234 235<div class="method"> 236 <code class="details" id="insert">insert(merchantId, body=None, x__xgafv=None)</code> 237 <pre>Inserts a return address for the Merchant Center account. 238 239Args: 240 merchantId: string, The Merchant Center account to insert a return address for. (required) 241 body: object, The request body. 242 The object takes the form of: 243 244{ # Return address resource. 245 "address": { # Required. The address. 246 "country": "A String", # CLDR country code (e.g. "US"). 247 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 248 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 249 "recipientName": "A String", # Name of the recipient to address returns to. 250 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 251 "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. 252 "A String", 253 ], 254 }, 255 "country": "A String", # Required. The country of sale where the return address is applicable. 256 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" 257 "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". 258 "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. 259 "returnAddressId": "A String", # Return address ID generated by Google. 260} 261 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 267Returns: 268 An object of the form: 269 270 { # Return address resource. 271 "address": { # Required. The address. 272 "country": "A String", # CLDR country code (e.g. "US"). 273 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 274 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 275 "recipientName": "A String", # Name of the recipient to address returns to. 276 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 277 "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. 278 "A String", 279 ], 280 }, 281 "country": "A String", # Required. The country of sale where the return address is applicable. 282 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" 283 "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". 284 "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. 285 "returnAddressId": "A String", # Return address ID generated by Google. 286}</pre> 287</div> 288 289<div class="method"> 290 <code class="details" id="list">list(merchantId, country=None, maxResults=None, pageToken=None, x__xgafv=None)</code> 291 <pre>Lists the return addresses of the Merchant Center account. 292 293Args: 294 merchantId: string, The Merchant Center account to list return addresses for. (required) 295 country: string, List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed. 296 maxResults: integer, The maximum number of addresses in the response, used for paging. 297 pageToken: string, The token returned by the previous request. 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 303Returns: 304 An object of the form: 305 306 { 307 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressListResponse`". 308 "nextPageToken": "A String", # The token for the retrieval of the next page of addresses. 309 "resources": [ 310 { # Return address resource. 311 "address": { # Required. The address. 312 "country": "A String", # CLDR country code (e.g. "US"). 313 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 314 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 315 "recipientName": "A String", # Name of the recipient to address returns to. 316 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 317 "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. 318 "A String", 319 ], 320 }, 321 "country": "A String", # Required. The country of sale where the return address is applicable. 322 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" 323 "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". 324 "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. 325 "returnAddressId": "A String", # Return address ID generated by Google. 326 }, 327 ], 328}</pre> 329</div> 330 331<div class="method"> 332 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 333 <pre>Retrieves the next page of results. 334 335Args: 336 previous_request: The request for the previous page. (required) 337 previous_response: The response from the request for the previous page. (required) 338 339Returns: 340 A request object that you can call 'execute()' on to request the next 341 page. Returns None if there are no more items in the collection. 342 </pre> 343</div> 344 345</body></html>