Debian Codegraph @

docs/dyn/content_v2.liasettings.html

raw
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 &quot;entries&quot;: [ # The request entries to be processed in the batch.
129 {
130 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account for which to get/update account LIA settings.
131 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
132 &quot;contactEmail&quot;: &quot;A String&quot;, # Inventory validation contact email. Required only for SetInventoryValidationContact.
133 &quot;contactName&quot;: &quot;A String&quot;, # Inventory validation contact name. Required only for SetInventoryValidationContact.
134 &quot;country&quot;: &quot;A String&quot;, # The country code. Required only for RequestInventoryVerification.
135 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB account. Required only for RequestGmbAccess.
136 &quot;liaSettings&quot;: { # 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 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
138 &quot;countrySettings&quot;: [ # The LIA settings for each country.
139 {
140 &quot;about&quot;: { # The settings for the About page.
141 &quot;status&quot;: &quot;A String&quot;, # The status of the verification process for the About page. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
142 &quot;url&quot;: &quot;A String&quot;, # The URL for the About page.
143 },
144 &quot;country&quot;: &quot;A String&quot;, # Required. CLDR country code (e.g. &quot;US&quot;).
145 &quot;hostedLocalStorefrontActive&quot;: True or False, # The status of the &quot;Merchant hosted local storefront&quot; feature.
146 &quot;inventory&quot;: { # LIA inventory verification settings.
147 &quot;inventoryVerificationContactEmail&quot;: &quot;A String&quot;, # The email of the contact for the inventory verification process.
148 &quot;inventoryVerificationContactName&quot;: &quot;A String&quot;, # The name of the contact for the inventory verification process.
149 &quot;inventoryVerificationContactStatus&quot;: &quot;A String&quot;, # The status of the verification contact. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
150 &quot;status&quot;: &quot;A String&quot;, # The status of the inventory verification process. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
151 },
152 &quot;onDisplayToOrder&quot;: { # LIA &quot;On Display To Order&quot; settings.
153 &quot;shippingCostPolicyUrl&quot;: &quot;A String&quot;, # Shipping cost and policy URL.
154 &quot;status&quot;: &quot;A String&quot;, # The status of the ?On display to order? feature. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
155 },
156 &quot;posDataProvider&quot;: { # The POS data provider linked with this country.
157 &quot;posDataProviderId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
158 &quot;posExternalAccountId&quot;: &quot;A String&quot;, # The account ID by which this merchant is known to the POS data provider.
159 },
160 &quot;storePickupActive&quot;: True or False, # The status of the &quot;Store pickup&quot; feature.
161 },
162 ],
163 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#liaSettings`&quot;
164 },
165 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
166 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry. Acceptable values are: - &quot;`get`&quot; - &quot;`getAccessibleGmbAccounts`&quot; - &quot;`requestGmbAccess`&quot; - &quot;`requestInventoryVerification`&quot; - &quot;`setInventoryVerificationContact`&quot; - &quot;`update`&quot;
167 &quot;posDataProviderId&quot;: &quot;A String&quot;, # The ID of POS data provider. Required only for SetPosProvider.
168 &quot;posExternalAccountId&quot;: &quot;A String&quot;, # 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 &quot;entries&quot;: [ # The result of the execution of the batch requests.
184 {
185 &quot;batchId&quot;: 42, # The ID of the request entry to which this entry responds.
186 &quot;errors&quot;: { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
187 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
188 &quot;errors&quot;: [ # A list of errors.
189 { # An error returned by the API.
190 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
191 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
192 &quot;reason&quot;: &quot;A String&quot;, # The error code.
193 },
194 ],
195 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
196 },
197 &quot;gmbAccounts&quot;: { # The list of accessible GMB accounts.
198 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the Merchant Center account.
199 &quot;gmbAccounts&quot;: [ # A list of GMB accounts which are available to the merchant.
200 {
201 &quot;email&quot;: &quot;A String&quot;, # The email which identifies the GMB account.
202 &quot;listingCount&quot;: &quot;A String&quot;, # Number of listings under this account.
203 &quot;name&quot;: &quot;A String&quot;, # The name of the GMB account.
204 &quot;type&quot;: &quot;A String&quot;, # The type of the GMB account (User or Business).
205 },
206 ],
207 },
208 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#liasettingsCustomBatchResponseEntry`&quot;
209 &quot;liaSettings&quot;: { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The retrieved or updated Lia settings.
210 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
211 &quot;countrySettings&quot;: [ # The LIA settings for each country.
212 {
213 &quot;about&quot;: { # The settings for the About page.
214 &quot;status&quot;: &quot;A String&quot;, # The status of the verification process for the About page. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
215 &quot;url&quot;: &quot;A String&quot;, # The URL for the About page.
216 },
217 &quot;country&quot;: &quot;A String&quot;, # Required. CLDR country code (e.g. &quot;US&quot;).
218 &quot;hostedLocalStorefrontActive&quot;: True or False, # The status of the &quot;Merchant hosted local storefront&quot; feature.
219 &quot;inventory&quot;: { # LIA inventory verification settings.
220 &quot;inventoryVerificationContactEmail&quot;: &quot;A String&quot;, # The email of the contact for the inventory verification process.
221 &quot;inventoryVerificationContactName&quot;: &quot;A String&quot;, # The name of the contact for the inventory verification process.
222 &quot;inventoryVerificationContactStatus&quot;: &quot;A String&quot;, # The status of the verification contact. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
223 &quot;status&quot;: &quot;A String&quot;, # The status of the inventory verification process. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
224 },
225 &quot;onDisplayToOrder&quot;: { # LIA &quot;On Display To Order&quot; settings.
226 &quot;shippingCostPolicyUrl&quot;: &quot;A String&quot;, # Shipping cost and policy URL.
227 &quot;status&quot;: &quot;A String&quot;, # The status of the ?On display to order? feature. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
228 },
229 &quot;posDataProvider&quot;: { # The POS data provider linked with this country.
230 &quot;posDataProviderId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
231 &quot;posExternalAccountId&quot;: &quot;A String&quot;, # The account ID by which this merchant is known to the POS data provider.
232 },
233 &quot;storePickupActive&quot;: True or False, # The status of the &quot;Store pickup&quot; feature.
234 },
235 ],
236 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#liaSettings`&quot;
237 },
238 &quot;posDataProviders&quot;: [ # The list of POS data providers.
239 {
240 &quot;country&quot;: &quot;A String&quot;, # Country code.
241 &quot;posDataProviders&quot;: [ # A list of POS data providers.
242 {
243 &quot;displayName&quot;: &quot;A String&quot;, # The display name of Pos data Provider.
244 &quot;fullName&quot;: &quot;A String&quot;, # The full name of this POS data Provider.
245 &quot;providerId&quot;: &quot;A String&quot;, # The ID of the account.
246 },
247 ],
248 },
249 ],
250 },
251 ],
252 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsCustomBatchResponse&quot;.
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 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
273 &quot;countrySettings&quot;: [ # The LIA settings for each country.
274 {
275 &quot;about&quot;: { # The settings for the About page.
276 &quot;status&quot;: &quot;A String&quot;, # The status of the verification process for the About page. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
277 &quot;url&quot;: &quot;A String&quot;, # The URL for the About page.
278 },
279 &quot;country&quot;: &quot;A String&quot;, # Required. CLDR country code (e.g. &quot;US&quot;).
280 &quot;hostedLocalStorefrontActive&quot;: True or False, # The status of the &quot;Merchant hosted local storefront&quot; feature.
281 &quot;inventory&quot;: { # LIA inventory verification settings.
282 &quot;inventoryVerificationContactEmail&quot;: &quot;A String&quot;, # The email of the contact for the inventory verification process.
283 &quot;inventoryVerificationContactName&quot;: &quot;A String&quot;, # The name of the contact for the inventory verification process.
284 &quot;inventoryVerificationContactStatus&quot;: &quot;A String&quot;, # The status of the verification contact. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
285 &quot;status&quot;: &quot;A String&quot;, # The status of the inventory verification process. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
286 },
287 &quot;onDisplayToOrder&quot;: { # LIA &quot;On Display To Order&quot; settings.
288 &quot;shippingCostPolicyUrl&quot;: &quot;A String&quot;, # Shipping cost and policy URL.
289 &quot;status&quot;: &quot;A String&quot;, # The status of the ?On display to order? feature. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
290 },
291 &quot;posDataProvider&quot;: { # The POS data provider linked with this country.
292 &quot;posDataProviderId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
293 &quot;posExternalAccountId&quot;: &quot;A String&quot;, # The account ID by which this merchant is known to the POS data provider.
294 },
295 &quot;storePickupActive&quot;: True or False, # The status of the &quot;Store pickup&quot; feature.
296 },
297 ],
298 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#liaSettings`&quot;
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 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the Merchant Center account.
319 &quot;gmbAccounts&quot;: [ # A list of GMB accounts which are available to the merchant.
320 {
321 &quot;email&quot;: &quot;A String&quot;, # The email which identifies the GMB account.
322 &quot;listingCount&quot;: &quot;A String&quot;, # Number of listings under this account.
323 &quot;name&quot;: &quot;A String&quot;, # The name of the GMB account.
324 &quot;type&quot;: &quot;A String&quot;, # The type of the GMB account (User or Business).
325 },
326 ],
327 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsGetAccessibleGmbAccountsResponse&quot;.
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 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsListResponse&quot;.
349 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of LIA settings.
350 &quot;resources&quot;: [
351 { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
352 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
353 &quot;countrySettings&quot;: [ # The LIA settings for each country.
354 {
355 &quot;about&quot;: { # The settings for the About page.
356 &quot;status&quot;: &quot;A String&quot;, # The status of the verification process for the About page. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
357 &quot;url&quot;: &quot;A String&quot;, # The URL for the About page.
358 },
359 &quot;country&quot;: &quot;A String&quot;, # Required. CLDR country code (e.g. &quot;US&quot;).
360 &quot;hostedLocalStorefrontActive&quot;: True or False, # The status of the &quot;Merchant hosted local storefront&quot; feature.
361 &quot;inventory&quot;: { # LIA inventory verification settings.
362 &quot;inventoryVerificationContactEmail&quot;: &quot;A String&quot;, # The email of the contact for the inventory verification process.
363 &quot;inventoryVerificationContactName&quot;: &quot;A String&quot;, # The name of the contact for the inventory verification process.
364 &quot;inventoryVerificationContactStatus&quot;: &quot;A String&quot;, # The status of the verification contact. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
365 &quot;status&quot;: &quot;A String&quot;, # The status of the inventory verification process. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
366 },
367 &quot;onDisplayToOrder&quot;: { # LIA &quot;On Display To Order&quot; settings.
368 &quot;shippingCostPolicyUrl&quot;: &quot;A String&quot;, # Shipping cost and policy URL.
369 &quot;status&quot;: &quot;A String&quot;, # The status of the ?On display to order? feature. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
370 },
371 &quot;posDataProvider&quot;: { # The POS data provider linked with this country.
372 &quot;posDataProviderId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
373 &quot;posExternalAccountId&quot;: &quot;A String&quot;, # The account ID by which this merchant is known to the POS data provider.
374 },
375 &quot;storePickupActive&quot;: True or False, # The status of the &quot;Store pickup&quot; feature.
376 },
377 ],
378 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#liaSettings`&quot;
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 &#x27;execute()&#x27; 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 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsListPosDataProvidersResponse&quot;.
413 &quot;posDataProviders&quot;: [ # The list of POS data providers for each eligible country
414 {
415 &quot;country&quot;: &quot;A String&quot;, # Country code.
416 &quot;posDataProviders&quot;: [ # A list of POS data providers.
417 {
418 &quot;displayName&quot;: &quot;A String&quot;, # The display name of Pos data Provider.
419 &quot;fullName&quot;: &quot;A String&quot;, # The full name of this POS data Provider.
420 &quot;providerId&quot;: &quot;A String&quot;, # 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 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsRequestGmbAccessResponse&quot;.
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 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsRequestInventoryVerificationResponse&quot;.
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 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsSetInventoryVerificationContactResponse&quot;.
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 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#liasettingsSetPosDataProviderResponse&quot;.
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 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
529 &quot;countrySettings&quot;: [ # The LIA settings for each country.
530 {
531 &quot;about&quot;: { # The settings for the About page.
532 &quot;status&quot;: &quot;A String&quot;, # The status of the verification process for the About page. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
533 &quot;url&quot;: &quot;A String&quot;, # The URL for the About page.
534 },
535 &quot;country&quot;: &quot;A String&quot;, # Required. CLDR country code (e.g. &quot;US&quot;).
536 &quot;hostedLocalStorefrontActive&quot;: True or False, # The status of the &quot;Merchant hosted local storefront&quot; feature.
537 &quot;inventory&quot;: { # LIA inventory verification settings.
538 &quot;inventoryVerificationContactEmail&quot;: &quot;A String&quot;, # The email of the contact for the inventory verification process.
539 &quot;inventoryVerificationContactName&quot;: &quot;A String&quot;, # The name of the contact for the inventory verification process.
540 &quot;inventoryVerificationContactStatus&quot;: &quot;A String&quot;, # The status of the verification contact. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
541 &quot;status&quot;: &quot;A String&quot;, # The status of the inventory verification process. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
542 },
543 &quot;onDisplayToOrder&quot;: { # LIA &quot;On Display To Order&quot; settings.
544 &quot;shippingCostPolicyUrl&quot;: &quot;A String&quot;, # Shipping cost and policy URL.
545 &quot;status&quot;: &quot;A String&quot;, # The status of the ?On display to order? feature. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
546 },
547 &quot;posDataProvider&quot;: { # The POS data provider linked with this country.
548 &quot;posDataProviderId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
549 &quot;posExternalAccountId&quot;: &quot;A String&quot;, # The account ID by which this merchant is known to the POS data provider.
550 },
551 &quot;storePickupActive&quot;: True or False, # The status of the &quot;Store pickup&quot; feature.
552 },
553 ],
554 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#liaSettings`&quot;
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 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
568 &quot;countrySettings&quot;: [ # The LIA settings for each country.
569 {
570 &quot;about&quot;: { # The settings for the About page.
571 &quot;status&quot;: &quot;A String&quot;, # The status of the verification process for the About page. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
572 &quot;url&quot;: &quot;A String&quot;, # The URL for the About page.
573 },
574 &quot;country&quot;: &quot;A String&quot;, # Required. CLDR country code (e.g. &quot;US&quot;).
575 &quot;hostedLocalStorefrontActive&quot;: True or False, # The status of the &quot;Merchant hosted local storefront&quot; feature.
576 &quot;inventory&quot;: { # LIA inventory verification settings.
577 &quot;inventoryVerificationContactEmail&quot;: &quot;A String&quot;, # The email of the contact for the inventory verification process.
578 &quot;inventoryVerificationContactName&quot;: &quot;A String&quot;, # The name of the contact for the inventory verification process.
579 &quot;inventoryVerificationContactStatus&quot;: &quot;A String&quot;, # The status of the verification contact. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
580 &quot;status&quot;: &quot;A String&quot;, # The status of the inventory verification process. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
581 },
582 &quot;onDisplayToOrder&quot;: { # LIA &quot;On Display To Order&quot; settings.
583 &quot;shippingCostPolicyUrl&quot;: &quot;A String&quot;, # Shipping cost and policy URL.
584 &quot;status&quot;: &quot;A String&quot;, # The status of the ?On display to order? feature. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
585 },
586 &quot;posDataProvider&quot;: { # The POS data provider linked with this country.
587 &quot;posDataProviderId&quot;: &quot;A String&quot;, # The ID of the POS data provider.
588 &quot;posExternalAccountId&quot;: &quot;A String&quot;, # The account ID by which this merchant is known to the POS data provider.
589 },
590 &quot;storePickupActive&quot;: True or False, # The status of the &quot;Store pickup&quot; feature.
591 },
592 ],
593 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#liaSettings`&quot;
594 }</pre>
595 </div>
596
597 </body></html>