1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.liasettings.html">liasettings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves and/or updates the LIA settings of multiple accounts in a single request.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, accountId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the LIA settings of the account.</p>
<p class="toc_element">
<code><a href="#getaccessiblegmbaccounts">getaccessiblegmbaccounts(merchantId, accountId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the list of accessible Business Profiles.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the LIA settings of the sub-accounts in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#listposdataproviders">listposdataproviders(x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the list of POS data providers that have active settings for the all eiligible countries.</p>
<p class="toc_element">
<code><a href="#requestgmbaccess">requestgmbaccess(merchantId, accountId, gmbEmail, x__xgafv=None)</a></code></p>
<p class="firstline">Requests access to a specified Business Profile.</p>
<p class="toc_element">
<code><a href="#requestinventoryverification">requestinventoryverification(merchantId, accountId, country, x__xgafv=None)</a></code></p>
<p class="firstline">Requests inventory validation for the specified country.</p>
<p class="toc_element">
<code><a href="#setinventoryverificationcontact">setinventoryverificationcontact(merchantId, accountId, country, language, contactName, contactEmail, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the inventory verification contact for the specified country.</p>
<p class="toc_element">
<code><a href="#setomnichannelexperience">setomnichannelexperience(merchantId, accountId, country=None, lsfType=None, pickupTypes=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the omnichannel experience for the specified country. Only supported for merchants whose POS data provider is trusted to enable the corresponding experience. For more context, see these help articles [about LFP](https://support.google.com/merchants/answer/7676652) and [how to get started](https://support.google.com/merchants/answer/7676578) with it.</p>
<p class="toc_element">
<code><a href="#setposdataprovider">setposdataprovider(merchantId, accountId, country, posDataProviderId=None, posExternalAccountId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the POS data provider for the specified country.</p>
<p class="toc_element">
<code><a href="#update">update(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code>
<pre>Retrieves and/or updates the LIA settings of multiple accounts in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{
"accountId": "A String", # The ID of the account for which to get/update account LIA settings.
"batchId": 42, # An entry ID, unique within the batch request.
"contactEmail": "A String", # Inventory validation contact email. Required only for SetInventoryValidationContact.
"contactName": "A String", # Inventory validation contact name. Required only for SetInventoryValidationContact.
"country": "A String", # The country code. Required only for RequestInventoryVerification.
"gmbEmail": "A String", # The Business Profile. Required only for RequestGmbAccess.
"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`.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Supported values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (for example, "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"omnichannelExperience": { # Omnichannel experience details. # The omnichannel experience configured for this country.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
},
"merchantId": "A String", # The ID of the managing account.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`get`" - "`getAccessibleGmbAccounts`" - "`requestGmbAccess`" - "`requestInventoryVerification`" - "`setInventoryVerificationContact`" - "`update`"
"omnichannelExperience": { # Omnichannel experience details. # The omnichannel experience for a country. Required only for SetOmnichannelExperience.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"posDataProviderId": "A String", # The ID of POS data provider. Required only for SetPosProvider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS provider.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{
"batchId": 42, # The ID of the request entry to which this entry responds.
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
"reason": "A String", # The error code.
},
],
"message": "A String", # The message of the first error in `errors`.
},
"gmbAccounts": { # The list of accessible Business Profiles.
"accountId": "A String", # The ID of the Merchant Center account.
"gmbAccounts": [ # A list of Business Profiles which are available to the merchant.
{
"email": "A String", # The email which identifies the Business Profile.
"listingCount": "A String", # Number of listings under this account.
"name": "A String", # The name of the Business Profile.
"type": "A String", # The type of the Business Profile (User or Business).
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsCustomBatchResponseEntry`"
"liaSettings": { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The retrieved or updated Lia settings.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Supported values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (for example, "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"omnichannelExperience": { # Omnichannel experience details. # The omnichannel experience configured for this country.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
},
"omnichannelExperience": { # Omnichannel experience details. # The updated omnichannel experience for a country.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"posDataProviders": [ # The list of POS data providers.
{
"country": "A String", # Country code.
"posDataProviders": [ # A list of POS data providers.
{
"displayName": "A String", # The display name of Pos data Provider.
"fullName": "A String", # The full name of this POS data Provider.
"providerId": "A String", # The ID of the account.
},
],
},
],
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsCustomBatchResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, accountId, x__xgafv=None)</code>
<pre>Retrieves the LIA settings of the account.
Args:
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)
accountId: string, The ID of the account for which to get or update LIA settings. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Supported values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (for example, "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"omnichannelExperience": { # Omnichannel experience details. # The omnichannel experience configured for this country.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
}</pre>
</div>
<div class="method">
<code class="details" id="getaccessiblegmbaccounts">getaccessiblegmbaccounts(merchantId, accountId, x__xgafv=None)</code>
<pre>Retrieves the list of accessible Business Profiles.
Args:
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)
accountId: string, The ID of the account for which to retrieve accessible Business Profiles. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"accountId": "A String", # The ID of the Merchant Center account.
"gmbAccounts": [ # A list of Business Profiles which are available to the merchant.
{
"email": "A String", # The email which identifies the Business Profile.
"listingCount": "A String", # Number of listings under this account.
"name": "A String", # The name of the Business Profile.
"type": "A String", # The type of the Business Profile (User or Business).
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsGetAccessibleGmbAccountsResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the LIA settings of the sub-accounts in your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
maxResults: integer, The maximum number of LIA settings to return in the response, used for paging.
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsListResponse`".
"nextPageToken": "A String", # The token for the retrieval of the next page of LIA settings.
"resources": [
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Supported values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (for example, "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"omnichannelExperience": { # Omnichannel experience details. # The omnichannel experience configured for this country.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="listposdataproviders">listposdataproviders(x__xgafv=None)</code>
<pre>Retrieves the list of POS data providers that have active settings for the all eiligible countries.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsListPosDataProvidersResponse`".
"posDataProviders": [ # The list of POS data providers for each eligible country
{
"country": "A String", # Country code.
"posDataProviders": [ # A list of POS data providers.
{
"displayName": "A String", # The display name of Pos data Provider.
"fullName": "A String", # The full name of this POS data Provider.
"providerId": "A String", # The ID of the account.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="requestgmbaccess">requestgmbaccess(merchantId, accountId, gmbEmail, x__xgafv=None)</code>
<pre>Requests access to a specified Business Profile.
Args:
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)
accountId: string, The ID of the account for which Business Profile access is requested. (required)
gmbEmail: string, The email of the Business Profile. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsRequestGmbAccessResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="requestinventoryverification">requestinventoryverification(merchantId, accountId, country, x__xgafv=None)</code>
<pre>Requests inventory validation for the specified country.
Args:
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)
accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
country: string, The country for which inventory validation is requested. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsRequestInventoryVerificationResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="setinventoryverificationcontact">setinventoryverificationcontact(merchantId, accountId, country, language, contactName, contactEmail, x__xgafv=None)</code>
<pre>Sets the inventory verification contact for the specified country.
Args:
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)
accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
country: string, The country for which inventory verification is requested. (required)
language: string, The language for which inventory verification is requested. (required)
contactName: string, The name of the inventory verification contact. (required)
contactEmail: string, The email of the inventory verification contact. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsSetInventoryVerificationContactResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="setomnichannelexperience">setomnichannelexperience(merchantId, accountId, country=None, lsfType=None, pickupTypes=None, x__xgafv=None)</code>
<pre>Sets the omnichannel experience for the specified country. Only supported for merchants whose POS data provider is trusted to enable the corresponding experience. For more context, see these help articles [about LFP](https://support.google.com/merchants/answer/7676652) and [how to get started](https://support.google.com/merchants/answer/7676578) with it.
Args:
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)
accountId: string, The ID of the account for which to retrieve accessible Business Profiles. (required)
country: string, The CLDR country code (for example, "US") for which the omnichannel experience is selected.
lsfType: string, The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
pickupTypes: string, The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`" (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Omnichannel experience details.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="setposdataprovider">setposdataprovider(merchantId, accountId, country, posDataProviderId=None, posExternalAccountId=None, x__xgafv=None)</code>
<pre>Sets the POS data provider for the specified country.
Args:
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)
accountId: string, The ID of the account for which to retrieve accessible Business Profiles. (required)
country: string, The country for which the POS data provider is selected. (required)
posDataProviderId: string, The ID of POS data provider.
posExternalAccountId: string, The account ID by which this merchant is known to the POS data provider.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsSetPosDataProviderResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.
Args:
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)
accountId: string, The ID of the account for which to get or update LIA settings. (required)
body: object, The request body.
The object takes the form of:
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Supported values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (for example, "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"omnichannelExperience": { # Omnichannel experience details. # The omnichannel experience configured for this country.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Supported values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (for example, "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"omnichannelExperience": { # Omnichannel experience details. # The omnichannel experience configured for this country.
"country": "A String", # The CLDR country code (for example, "US").
"lsfType": "A String", # The Local Store Front (LSF) type for this country. Acceptable values are: - "`ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.
"pickupTypes": [ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "`pickupLater`"
"A String",
],
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
}</pre>
</div>
</body></html>
|
