Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame^] | 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.html">Content API for Shopping</a> . <a href="content_v2.liasettings.html">liasettings</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p> |
| 79 | <p class="firstline">Retrieves and/or updates the LIA settings of multiple accounts in a single request.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(merchantId, accountId)</a></code></p> |
| 82 | <p class="firstline">Retrieves the LIA settings of the account.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#getaccessiblegmbaccounts">getaccessiblegmbaccounts(merchantId, accountId)</a></code></p> |
| 85 | <p class="firstline">Retrieves the list of accessible Google My Business accounts.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p> |
| 88 | <p class="firstline">Lists the LIA settings of the sub-accounts in your Merchant Center account.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#listposdataproviders">listposdataproviders()</a></code></p> |
| 94 | <p class="firstline">Retrieves the list of POS data providers that have active settings for the all eiligible countries.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p> |
| 97 | <p class="firstline">Updates the LIA settings of the account. This method supports patch semantics.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#requestgmbaccess">requestgmbaccess(merchantId, accountId, gmbEmail)</a></code></p> |
| 100 | <p class="firstline">Requests access to a specified Google My Business account.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#requestinventoryverification">requestinventoryverification(merchantId, accountId, country)</a></code></p> |
| 103 | <p class="firstline">Requests inventory validation for the specified country.</p> |
| 104 | <p class="toc_element"> |
| 105 | <code><a href="#setinventoryverificationcontact">setinventoryverificationcontact(merchantId, accountId, contactEmail, contactName, country, language)</a></code></p> |
| 106 | <p class="firstline">Sets the inventory verification contract for the specified country.</p> |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="#setposdataprovider">setposdataprovider(merchantId, accountId, country, posDataProviderId=None, posExternalAccountId=None)</a></code></p> |
| 109 | <p class="firstline">Sets the POS data provider for the specified country.</p> |
| 110 | <p class="toc_element"> |
| 111 | <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p> |
| 112 | <p class="firstline">Updates the LIA settings of the account.</p> |
| 113 | <h3>Method Details</h3> |
| 114 | <div class="method"> |
| 115 | <code class="details" id="custombatch">custombatch(body, dryRun=None)</code> |
| 116 | <pre>Retrieves and/or updates the LIA settings of multiple accounts in a single request. |
| 117 | |
| 118 | Args: |
| 119 | body: object, The request body. (required) |
| 120 | The object takes the form of: |
| 121 | |
| 122 | { |
| 123 | "entries": [ # The request entries to be processed in the batch. |
| 124 | { |
| 125 | "contactEmail": "A String", # Inventory validation contact email. Required only for SetInventoryValidationContact. |
| 126 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS provider. |
| 127 | "liaSettings": { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The account Lia settings to update. Only defined if the method is update. |
| 128 | "countrySettings": [ # The LIA settings for each country. |
| 129 | { |
| 130 | "about": { # The settings for the About page. |
| 131 | "status": "A String", # The status of the verification process for the About page. |
| 132 | "url": "A String", # The URL for the About page. |
| 133 | }, |
| 134 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 135 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 136 | "status": "A String", # The status of the ?On display to order? feature. |
| 137 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 138 | }, |
| 139 | "country": "A String", # CLDR country code (e.g. "US"). |
| 140 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 141 | "posDataProvider": { # The POS data provider linked with this country. |
| 142 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 143 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 144 | }, |
| 145 | "inventory": { # LIA inventory verification settings. |
| 146 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 147 | "status": "A String", # The status of the inventory verification process. |
| 148 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 149 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 150 | }, |
| 151 | }, |
| 152 | ], |
| 153 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 154 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 155 | }, |
| 156 | "gmbEmail": "A String", # The GMB account. Required only for RequestGmbAccess. |
| 157 | "country": "A String", # The country code. Required only for RequestInventoryVerification. |
| 158 | "method": "A String", |
| 159 | "batchId": 42, # An entry ID, unique within the batch request. |
| 160 | "contactName": "A String", # Inventory validation contact name. Required only for SetInventoryValidationContact. |
| 161 | "posDataProviderId": "A String", # The ID of POS data provider. Required only for SetPosProvider. |
| 162 | "merchantId": "A String", # The ID of the managing account. |
| 163 | "accountId": "A String", # The ID of the account for which to get/update account shipping settings. |
| 164 | }, |
| 165 | ], |
| 166 | } |
| 167 | |
| 168 | dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). |
| 169 | |
| 170 | Returns: |
| 171 | An object of the form: |
| 172 | |
| 173 | { |
| 174 | "kind": "content#liasettingsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse". |
| 175 | "entries": [ # The result of the execution of the batch requests. |
| 176 | { |
| 177 | "kind": "content#liasettingsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry". |
| 178 | "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed. |
| 179 | "message": "A String", # The message of the first error in errors. |
| 180 | "code": 42, # The HTTP status of the first error in errors. |
| 181 | "errors": [ # A list of errors. |
| 182 | { # An error returned by the API. |
| 183 | "reason": "A String", # The error code. |
| 184 | "domain": "A String", # The domain of the error. |
| 185 | "message": "A String", # A description of the error. |
| 186 | }, |
| 187 | ], |
| 188 | }, |
| 189 | "gmbAccounts": { # The the list of accessible GMB accounts. |
| 190 | "gmbAccounts": [ # A list of GMB accounts which are available to the merchant. |
| 191 | { |
| 192 | "listingCount": "A String", # Number of listings under this account. |
| 193 | "type": "A String", # The type of the GMB account (User or Business). |
| 194 | "email": "A String", # The email which identifies the GMB account. |
| 195 | "name": "A String", # The name of the GMB account. |
| 196 | }, |
| 197 | ], |
| 198 | "accountId": "A String", # The ID of the account. |
| 199 | }, |
| 200 | "batchId": 42, # The ID of the request entry to which this entry responds. |
| 201 | "posDataProviders": [ # The list of POS data providers. |
| 202 | { |
| 203 | "country": "A String", # Country code. |
| 204 | "posDataProviders": [ # A list of POS data providers. |
| 205 | { |
| 206 | "fullName": "A String", # The full name of this POS data Provider. |
| 207 | "displayName": "A String", # The display name of Pos data Provider. |
| 208 | "providerId": "A String", # The ID of the account. |
| 209 | }, |
| 210 | ], |
| 211 | }, |
| 212 | ], |
| 213 | "liaSettings": { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The retrieved or updated Lia settings. |
| 214 | "countrySettings": [ # The LIA settings for each country. |
| 215 | { |
| 216 | "about": { # The settings for the About page. |
| 217 | "status": "A String", # The status of the verification process for the About page. |
| 218 | "url": "A String", # The URL for the About page. |
| 219 | }, |
| 220 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 221 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 222 | "status": "A String", # The status of the ?On display to order? feature. |
| 223 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 224 | }, |
| 225 | "country": "A String", # CLDR country code (e.g. "US"). |
| 226 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 227 | "posDataProvider": { # The POS data provider linked with this country. |
| 228 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 229 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 230 | }, |
| 231 | "inventory": { # LIA inventory verification settings. |
| 232 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 233 | "status": "A String", # The status of the inventory verification process. |
| 234 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 235 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 236 | }, |
| 237 | }, |
| 238 | ], |
| 239 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 240 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 241 | }, |
| 242 | }, |
| 243 | ], |
| 244 | }</pre> |
| 245 | </div> |
| 246 | |
| 247 | <div class="method"> |
| 248 | <code class="details" id="get">get(merchantId, accountId)</code> |
| 249 | <pre>Retrieves the LIA settings of the account. |
| 250 | |
| 251 | Args: |
| 252 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 253 | accountId: string, The ID of the account for which to get or update LIA settings. (required) |
| 254 | |
| 255 | Returns: |
| 256 | An object of the form: |
| 257 | |
| 258 | { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. |
| 259 | "countrySettings": [ # The LIA settings for each country. |
| 260 | { |
| 261 | "about": { # The settings for the About page. |
| 262 | "status": "A String", # The status of the verification process for the About page. |
| 263 | "url": "A String", # The URL for the About page. |
| 264 | }, |
| 265 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 266 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 267 | "status": "A String", # The status of the ?On display to order? feature. |
| 268 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 269 | }, |
| 270 | "country": "A String", # CLDR country code (e.g. "US"). |
| 271 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 272 | "posDataProvider": { # The POS data provider linked with this country. |
| 273 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 274 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 275 | }, |
| 276 | "inventory": { # LIA inventory verification settings. |
| 277 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 278 | "status": "A String", # The status of the inventory verification process. |
| 279 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 280 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 281 | }, |
| 282 | }, |
| 283 | ], |
| 284 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 285 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 286 | }</pre> |
| 287 | </div> |
| 288 | |
| 289 | <div class="method"> |
| 290 | <code class="details" id="getaccessiblegmbaccounts">getaccessiblegmbaccounts(merchantId, accountId)</code> |
| 291 | <pre>Retrieves the list of accessible Google My Business accounts. |
| 292 | |
| 293 | Args: |
| 294 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 295 | accountId: string, The ID of the account for which to retrieve accessible Google My Business accounts. (required) |
| 296 | |
| 297 | Returns: |
| 298 | An object of the form: |
| 299 | |
| 300 | { |
| 301 | "gmbAccounts": [ # A list of GMB accounts which are available to the merchant. |
| 302 | { |
| 303 | "listingCount": "A String", # Number of listings under this account. |
| 304 | "type": "A String", # The type of the GMB account (User or Business). |
| 305 | "email": "A String", # The email which identifies the GMB account. |
| 306 | "name": "A String", # The name of the GMB account. |
| 307 | }, |
| 308 | ], |
| 309 | "kind": "content#liasettingsGetAccessibleGmbAccountsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse". |
| 310 | "accountId": "A String", # The ID of the account. |
| 311 | }</pre> |
| 312 | </div> |
| 313 | |
| 314 | <div class="method"> |
| 315 | <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code> |
| 316 | <pre>Lists the LIA settings of the sub-accounts in your Merchant Center account. |
| 317 | |
| 318 | Args: |
| 319 | merchantId: string, The ID of the managing account. This must be a multi-client account. (required) |
| 320 | pageToken: string, The token returned by the previous request. |
| 321 | maxResults: integer, The maximum number of LIA settings to return in the response, used for paging. |
| 322 | |
| 323 | Returns: |
| 324 | An object of the form: |
| 325 | |
| 326 | { |
| 327 | "nextPageToken": "A String", # The token for the retrieval of the next page of LIA settings. |
| 328 | "kind": "content#liasettingsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse". |
| 329 | "resources": [ |
| 330 | { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. |
| 331 | "countrySettings": [ # The LIA settings for each country. |
| 332 | { |
| 333 | "about": { # The settings for the About page. |
| 334 | "status": "A String", # The status of the verification process for the About page. |
| 335 | "url": "A String", # The URL for the About page. |
| 336 | }, |
| 337 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 338 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 339 | "status": "A String", # The status of the ?On display to order? feature. |
| 340 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 341 | }, |
| 342 | "country": "A String", # CLDR country code (e.g. "US"). |
| 343 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 344 | "posDataProvider": { # The POS data provider linked with this country. |
| 345 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 346 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 347 | }, |
| 348 | "inventory": { # LIA inventory verification settings. |
| 349 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 350 | "status": "A String", # The status of the inventory verification process. |
| 351 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 352 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 353 | }, |
| 354 | }, |
| 355 | ], |
| 356 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 357 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 358 | }, |
| 359 | ], |
| 360 | }</pre> |
| 361 | </div> |
| 362 | |
| 363 | <div class="method"> |
| 364 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 365 | <pre>Retrieves the next page of results. |
| 366 | |
| 367 | Args: |
| 368 | previous_request: The request for the previous page. (required) |
| 369 | previous_response: The response from the request for the previous page. (required) |
| 370 | |
| 371 | Returns: |
| 372 | A request object that you can call 'execute()' on to request the next |
| 373 | page. Returns None if there are no more items in the collection. |
| 374 | </pre> |
| 375 | </div> |
| 376 | |
| 377 | <div class="method"> |
| 378 | <code class="details" id="listposdataproviders">listposdataproviders()</code> |
| 379 | <pre>Retrieves the list of POS data providers that have active settings for the all eiligible countries. |
| 380 | |
| 381 | Args: |
| 382 | |
| 383 | Returns: |
| 384 | An object of the form: |
| 385 | |
| 386 | { |
| 387 | "kind": "content#liasettingsListPosDataProvidersResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse". |
| 388 | "posDataProviders": [ # The list of POS data providers for each eligible country |
| 389 | { |
| 390 | "country": "A String", # Country code. |
| 391 | "posDataProviders": [ # A list of POS data providers. |
| 392 | { |
| 393 | "fullName": "A String", # The full name of this POS data Provider. |
| 394 | "displayName": "A String", # The display name of Pos data Provider. |
| 395 | "providerId": "A String", # The ID of the account. |
| 396 | }, |
| 397 | ], |
| 398 | }, |
| 399 | ], |
| 400 | }</pre> |
| 401 | </div> |
| 402 | |
| 403 | <div class="method"> |
| 404 | <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code> |
| 405 | <pre>Updates the LIA settings of the account. This method supports patch semantics. |
| 406 | |
| 407 | Args: |
| 408 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 409 | accountId: string, The ID of the account for which to get or update LIA settings. (required) |
| 410 | body: object, The request body. (required) |
| 411 | The object takes the form of: |
| 412 | |
| 413 | { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. |
| 414 | "countrySettings": [ # The LIA settings for each country. |
| 415 | { |
| 416 | "about": { # The settings for the About page. |
| 417 | "status": "A String", # The status of the verification process for the About page. |
| 418 | "url": "A String", # The URL for the About page. |
| 419 | }, |
| 420 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 421 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 422 | "status": "A String", # The status of the ?On display to order? feature. |
| 423 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 424 | }, |
| 425 | "country": "A String", # CLDR country code (e.g. "US"). |
| 426 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 427 | "posDataProvider": { # The POS data provider linked with this country. |
| 428 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 429 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 430 | }, |
| 431 | "inventory": { # LIA inventory verification settings. |
| 432 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 433 | "status": "A String", # The status of the inventory verification process. |
| 434 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 435 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 436 | }, |
| 437 | }, |
| 438 | ], |
| 439 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 440 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 441 | } |
| 442 | |
| 443 | dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). |
| 444 | |
| 445 | Returns: |
| 446 | An object of the form: |
| 447 | |
| 448 | { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. |
| 449 | "countrySettings": [ # The LIA settings for each country. |
| 450 | { |
| 451 | "about": { # The settings for the About page. |
| 452 | "status": "A String", # The status of the verification process for the About page. |
| 453 | "url": "A String", # The URL for the About page. |
| 454 | }, |
| 455 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 456 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 457 | "status": "A String", # The status of the ?On display to order? feature. |
| 458 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 459 | }, |
| 460 | "country": "A String", # CLDR country code (e.g. "US"). |
| 461 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 462 | "posDataProvider": { # The POS data provider linked with this country. |
| 463 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 464 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 465 | }, |
| 466 | "inventory": { # LIA inventory verification settings. |
| 467 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 468 | "status": "A String", # The status of the inventory verification process. |
| 469 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 470 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 471 | }, |
| 472 | }, |
| 473 | ], |
| 474 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 475 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 476 | }</pre> |
| 477 | </div> |
| 478 | |
| 479 | <div class="method"> |
| 480 | <code class="details" id="requestgmbaccess">requestgmbaccess(merchantId, accountId, gmbEmail)</code> |
| 481 | <pre>Requests access to a specified Google My Business account. |
| 482 | |
| 483 | Args: |
| 484 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 485 | accountId: string, The ID of the account for which GMB access is requested. (required) |
| 486 | gmbEmail: string, The email of the Google My Business account. (required) |
| 487 | |
| 488 | Returns: |
| 489 | An object of the form: |
| 490 | |
| 491 | { |
| 492 | "kind": "content#liasettingsRequestGmbAccessResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse". |
| 493 | }</pre> |
| 494 | </div> |
| 495 | |
| 496 | <div class="method"> |
| 497 | <code class="details" id="requestinventoryverification">requestinventoryverification(merchantId, accountId, country)</code> |
| 498 | <pre>Requests inventory validation for the specified country. |
| 499 | |
| 500 | Args: |
| 501 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 502 | accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| 503 | country: string, The country for which inventory validation is requested. (required) |
| 504 | |
| 505 | Returns: |
| 506 | An object of the form: |
| 507 | |
| 508 | { |
| 509 | "kind": "content#liasettingsRequestInventoryVerificationResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse". |
| 510 | }</pre> |
| 511 | </div> |
| 512 | |
| 513 | <div class="method"> |
| 514 | <code class="details" id="setinventoryverificationcontact">setinventoryverificationcontact(merchantId, accountId, contactEmail, contactName, country, language)</code> |
| 515 | <pre>Sets the inventory verification contract for the specified country. |
| 516 | |
| 517 | Args: |
| 518 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 519 | accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required) |
| 520 | contactEmail: string, The email of the inventory verification contact. (required) |
| 521 | contactName: string, The name of the inventory verification contact. (required) |
| 522 | country: string, The country for which inventory verification is requested. (required) |
| 523 | language: string, The language for which inventory verification is requested. (required) |
| 524 | |
| 525 | Returns: |
| 526 | An object of the form: |
| 527 | |
| 528 | { |
| 529 | "kind": "content#liasettingsSetInventoryVerificationContactResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse". |
| 530 | }</pre> |
| 531 | </div> |
| 532 | |
| 533 | <div class="method"> |
| 534 | <code class="details" id="setposdataprovider">setposdataprovider(merchantId, accountId, country, posDataProviderId=None, posExternalAccountId=None)</code> |
| 535 | <pre>Sets the POS data provider for the specified country. |
| 536 | |
| 537 | Args: |
| 538 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 539 | accountId: string, The ID of the account for which to retrieve accessible Google My Business accounts. (required) |
| 540 | country: string, The country for which the POS data provider is selected. (required) |
| 541 | posDataProviderId: string, The ID of POS data provider. |
| 542 | posExternalAccountId: string, The account ID by which this merchant is known to the POS data provider. |
| 543 | |
| 544 | Returns: |
| 545 | An object of the form: |
| 546 | |
| 547 | { |
| 548 | "kind": "content#liasettingsSetPosDataProviderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse". |
| 549 | }</pre> |
| 550 | </div> |
| 551 | |
| 552 | <div class="method"> |
| 553 | <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code> |
| 554 | <pre>Updates the LIA settings of the account. |
| 555 | |
| 556 | Args: |
| 557 | merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required) |
| 558 | accountId: string, The ID of the account for which to get or update LIA settings. (required) |
| 559 | body: object, The request body. (required) |
| 560 | The object takes the form of: |
| 561 | |
| 562 | { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. |
| 563 | "countrySettings": [ # The LIA settings for each country. |
| 564 | { |
| 565 | "about": { # The settings for the About page. |
| 566 | "status": "A String", # The status of the verification process for the About page. |
| 567 | "url": "A String", # The URL for the About page. |
| 568 | }, |
| 569 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 570 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 571 | "status": "A String", # The status of the ?On display to order? feature. |
| 572 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 573 | }, |
| 574 | "country": "A String", # CLDR country code (e.g. "US"). |
| 575 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 576 | "posDataProvider": { # The POS data provider linked with this country. |
| 577 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 578 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 579 | }, |
| 580 | "inventory": { # LIA inventory verification settings. |
| 581 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 582 | "status": "A String", # The status of the inventory verification process. |
| 583 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 584 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 585 | }, |
| 586 | }, |
| 587 | ], |
| 588 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 589 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 590 | } |
| 591 | |
| 592 | dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). |
| 593 | |
| 594 | Returns: |
| 595 | An object of the form: |
| 596 | |
| 597 | { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. |
| 598 | "countrySettings": [ # The LIA settings for each country. |
| 599 | { |
| 600 | "about": { # The settings for the About page. |
| 601 | "status": "A String", # The status of the verification process for the About page. |
| 602 | "url": "A String", # The URL for the About page. |
| 603 | }, |
| 604 | "hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature. |
| 605 | "onDisplayToOrder": { # LIA "On Display To Order" settings. |
| 606 | "status": "A String", # The status of the ?On display to order? feature. |
| 607 | "shippingCostPolicyUrl": "A String", # Shipping cost and policy URL. |
| 608 | }, |
| 609 | "country": "A String", # CLDR country code (e.g. "US"). |
| 610 | "storePickupActive": True or False, # The status of the "Store pickup" feature. |
| 611 | "posDataProvider": { # The POS data provider linked with this country. |
| 612 | "posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider. |
| 613 | "posDataProviderId": "A String", # The ID of the POS data provider. |
| 614 | }, |
| 615 | "inventory": { # LIA inventory verification settings. |
| 616 | "inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process. |
| 617 | "status": "A String", # The status of the inventory verification process. |
| 618 | "inventoryVerificationContactStatus": "A String", # The status of the verification contact. |
| 619 | "inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process. |
| 620 | }, |
| 621 | }, |
| 622 | ], |
| 623 | "kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". |
| 624 | "accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. |
| 625 | }</pre> |
| 626 | </div> |
| 627 | |
| 628 | </body></html> |