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.regions.html">regions</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="#create">create(merchantId, body=None, regionId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a region definition in your Merchant Center account.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(merchantId, regionId, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a region definition from your Merchant Center account.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(merchantId, regionId, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a region defined in your Merchant Center account.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the regions in your Merchant Center account.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(merchantId, regionId, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a region definition in your Merchant Center account.</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="create">create(merchantId, body=None, regionId=None, x__xgafv=None)</code> 106 <pre>Creates a region definition in your Merchant Center account. 107 108Args: 109 merchantId: string, Required. The id of the merchant for which to create region definition. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. 114 "displayName": "A String", # The display name of the region. 115 "geotargetArea": { # A list of geotargets that defines the region area. # A list of geotargets that defines the region area. 116 "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). 117 "A String", 118 ], 119 }, 120 "merchantId": "A String", # Output only. Immutable. Merchant that owns the region. 121 "postalCodeArea": { # A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource. # A list of postal codes that defines the region area. 122 "postalCodes": [ # Required. A range of postal codes. 123 { # A range of postal codes that defines the region area. 124 "begin": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". 125 "end": "A String", # Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. 126 }, 127 ], 128 "regionCode": "A String", # Required. CLDR territory code or the country the postal code group applies to. 129 }, 130 "regionId": "A String", # Output only. Immutable. The ID uniquely identifying each region. 131 "regionalInventoryEligible": True or False, # Output only. Indicates if the region is eligible to use in the Regional Inventory configuration. 132 "shippingEligible": True or False, # Output only. Indicates if the region is eligible to use in the Shipping Services configuration. 133} 134 135 regionId: string, Required. The id of the region to create. 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. 145 "displayName": "A String", # The display name of the region. 146 "geotargetArea": { # A list of geotargets that defines the region area. # A list of geotargets that defines the region area. 147 "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). 148 "A String", 149 ], 150 }, 151 "merchantId": "A String", # Output only. Immutable. Merchant that owns the region. 152 "postalCodeArea": { # A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource. # A list of postal codes that defines the region area. 153 "postalCodes": [ # Required. A range of postal codes. 154 { # A range of postal codes that defines the region area. 155 "begin": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". 156 "end": "A String", # Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. 157 }, 158 ], 159 "regionCode": "A String", # Required. CLDR territory code or the country the postal code group applies to. 160 }, 161 "regionId": "A String", # Output only. Immutable. The ID uniquely identifying each region. 162 "regionalInventoryEligible": True or False, # Output only. Indicates if the region is eligible to use in the Regional Inventory configuration. 163 "shippingEligible": True or False, # Output only. Indicates if the region is eligible to use in the Shipping Services configuration. 164}</pre> 165</div> 166 167<div class="method"> 168 <code class="details" id="delete">delete(merchantId, regionId, x__xgafv=None)</code> 169 <pre>Deletes a region definition from your Merchant Center account. 170 171Args: 172 merchantId: string, Required. The id of the merchant for which to delete region definition. (required) 173 regionId: string, Required. The id of the region to delete. (required) 174 x__xgafv: string, V1 error format. 175 Allowed values 176 1 - v1 error format 177 2 - v2 error format 178</pre> 179</div> 180 181<div class="method"> 182 <code class="details" id="get">get(merchantId, regionId, x__xgafv=None)</code> 183 <pre>Retrieves a region defined in your Merchant Center account. 184 185Args: 186 merchantId: string, Required. The id of the merchant for which to retrieve region definition. (required) 187 regionId: string, Required. The id of the region to retrieve. (required) 188 x__xgafv: string, V1 error format. 189 Allowed values 190 1 - v1 error format 191 2 - v2 error format 192 193Returns: 194 An object of the form: 195 196 { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. 197 "displayName": "A String", # The display name of the region. 198 "geotargetArea": { # A list of geotargets that defines the region area. # A list of geotargets that defines the region area. 199 "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). 200 "A String", 201 ], 202 }, 203 "merchantId": "A String", # Output only. Immutable. Merchant that owns the region. 204 "postalCodeArea": { # A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource. # A list of postal codes that defines the region area. 205 "postalCodes": [ # Required. A range of postal codes. 206 { # A range of postal codes that defines the region area. 207 "begin": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". 208 "end": "A String", # Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. 209 }, 210 ], 211 "regionCode": "A String", # Required. CLDR territory code or the country the postal code group applies to. 212 }, 213 "regionId": "A String", # Output only. Immutable. The ID uniquely identifying each region. 214 "regionalInventoryEligible": True or False, # Output only. Indicates if the region is eligible to use in the Regional Inventory configuration. 215 "shippingEligible": True or False, # Output only. Indicates if the region is eligible to use in the Shipping Services configuration. 216}</pre> 217</div> 218 219<div class="method"> 220 <code class="details" id="list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</code> 221 <pre>Lists the regions in your Merchant Center account. 222 223Args: 224 merchantId: string, Required. The id of the merchant for which to list region definitions. (required) 225 pageSize: integer, The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. 226 pageToken: string, A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token. 227 x__xgafv: string, V1 error format. 228 Allowed values 229 1 - v1 error format 230 2 - v2 error format 231 232Returns: 233 An object of the form: 234 235 { # Response message for the `ListRegions` method. 236 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 237 "regions": [ # The regions from the specified merchant. 238 { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. 239 "displayName": "A String", # The display name of the region. 240 "geotargetArea": { # A list of geotargets that defines the region area. # A list of geotargets that defines the region area. 241 "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). 242 "A String", 243 ], 244 }, 245 "merchantId": "A String", # Output only. Immutable. Merchant that owns the region. 246 "postalCodeArea": { # A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource. # A list of postal codes that defines the region area. 247 "postalCodes": [ # Required. A range of postal codes. 248 { # A range of postal codes that defines the region area. 249 "begin": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". 250 "end": "A String", # Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. 251 }, 252 ], 253 "regionCode": "A String", # Required. CLDR territory code or the country the postal code group applies to. 254 }, 255 "regionId": "A String", # Output only. Immutable. The ID uniquely identifying each region. 256 "regionalInventoryEligible": True or False, # Output only. Indicates if the region is eligible to use in the Regional Inventory configuration. 257 "shippingEligible": True or False, # Output only. Indicates if the region is eligible to use in the Shipping Services configuration. 258 }, 259 ], 260}</pre> 261</div> 262 263<div class="method"> 264 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 265 <pre>Retrieves the next page of results. 266 267Args: 268 previous_request: The request for the previous page. (required) 269 previous_response: The response from the request for the previous page. (required) 270 271Returns: 272 A request object that you can call 'execute()' on to request the next 273 page. Returns None if there are no more items in the collection. 274 </pre> 275</div> 276 277<div class="method"> 278 <code class="details" id="patch">patch(merchantId, regionId, body=None, updateMask=None, x__xgafv=None)</code> 279 <pre>Updates a region definition in your Merchant Center account. 280 281Args: 282 merchantId: string, Required. The id of the merchant for which to update region definition. (required) 283 regionId: string, Required. The id of the region to update. (required) 284 body: object, The request body. 285 The object takes the form of: 286 287{ # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. 288 "displayName": "A String", # The display name of the region. 289 "geotargetArea": { # A list of geotargets that defines the region area. # A list of geotargets that defines the region area. 290 "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). 291 "A String", 292 ], 293 }, 294 "merchantId": "A String", # Output only. Immutable. Merchant that owns the region. 295 "postalCodeArea": { # A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource. # A list of postal codes that defines the region area. 296 "postalCodes": [ # Required. A range of postal codes. 297 { # A range of postal codes that defines the region area. 298 "begin": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". 299 "end": "A String", # Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. 300 }, 301 ], 302 "regionCode": "A String", # Required. CLDR territory code or the country the postal code group applies to. 303 }, 304 "regionId": "A String", # Output only. Immutable. The ID uniquely identifying each region. 305 "regionalInventoryEligible": True or False, # Output only. Indicates if the region is eligible to use in the Regional Inventory configuration. 306 "shippingEligible": True or False, # Output only. Indicates if the region is eligible to use in the Shipping Services configuration. 307} 308 309 updateMask: string, Optional. The comma-separated field mask indicating the fields to update. Example: `"displayName,postalCodeArea.regionCode"`. 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314 315Returns: 316 An object of the form: 317 318 { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. 319 "displayName": "A String", # The display name of the region. 320 "geotargetArea": { # A list of geotargets that defines the region area. # A list of geotargets that defines the region area. 321 "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). 322 "A String", 323 ], 324 }, 325 "merchantId": "A String", # Output only. Immutable. Merchant that owns the region. 326 "postalCodeArea": { # A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource. # A list of postal codes that defines the region area. 327 "postalCodes": [ # Required. A range of postal codes. 328 { # A range of postal codes that defines the region area. 329 "begin": "A String", # Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". 330 "end": "A String", # Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. 331 }, 332 ], 333 "regionCode": "A String", # Required. CLDR territory code or the country the postal code group applies to. 334 }, 335 "regionId": "A String", # Output only. Immutable. The ID uniquely identifying each region. 336 "regionalInventoryEligible": True or False, # Output only. Indicates if the region is eligible to use in the Regional Inventory configuration. 337 "shippingEligible": True or False, # Output only. Indicates if the region is eligible to use in the Shipping Services configuration. 338}</pre> 339</div> 340 341</body></html>