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