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