Blame - docs/dyn/content_v2.liasettings.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

111

<code><a href="#update">update(merchantId, accountId, body=None, dryRun=None)</a></code></p>

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

112

<p class="firstline">Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

<h3>Method Details</h3>

114

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame^]

115

<code class="details" id="close">close()</code>

116

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

120

<code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

121

<pre>Retrieves and/or updates the LIA settings of multiple accounts in a single request.

122

123

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

124

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

125

The object takes the form of:

126

127

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

128

"entries": [ # The request entries to be processed in the batch.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

129

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

130

"accountId": "A String", # The ID of the account for which to get/update account LIA settings.

131

"batchId": 42, # An entry ID, unique within the batch request.

132

"contactEmail": "A String", # Inventory validation contact email. Required only for SetInventoryValidationContact.

133

"contactName": "A String", # Inventory validation contact name. Required only for SetInventoryValidationContact.

134

"country": "A String", # The country code. Required only for RequestInventoryVerification.

135

"gmbEmail": "A String", # The GMB account. Required only for RequestGmbAccess.

136

"liaSettings": { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The account Lia settings to update. Only defined if the method is `update`.

137

"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.

138

"countrySettings": [ # The LIA settings for each country.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

139

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

140

"about": { # The settings for the About page.

141

"status": "A String", # The status of the verification process for the About page.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

142

#

143

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"url": "A String", # The URL for the About page.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

148

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

149

"country": "A String", # Required. CLDR country code (e.g. "US").

150

"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.

151

"inventory": { # LIA inventory verification settings.

152

"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.

153

"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.

154

"inventoryVerificationContactStatus": "A String", # The status of the verification contact.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

155

#

156

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"status": "A String", # The status of the inventory verification process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

161

#

162

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

"onDisplayToOrder": { # LIA "On Display To Order" settings.

168

"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.

169

"status": "A String", # The status of the ?On display to order? feature.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

170

#

171

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

172

# - "`active`"

173

# - "`inactive`"

174

# - "`pending`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

175

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"posDataProvider": { # The POS data provider linked with this country.

177

"posDataProviderId": "A String", # The ID of the POS data provider.

178

"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.

179

},

180

"storePickupActive": True or False, # The status of the "Store pickup" feature.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

181

},

182

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

183

"kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

184

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

185

"merchantId": "A String", # The ID of the managing account.

186

"method": "A String", # The method of the batch entry.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

187

#

188

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

189

# - "`get`"

190

# - "`getAccessibleGmbAccounts`"

191

# - "`requestGmbAccess`"

192

# - "`requestInventoryVerification`"

193

# - "`setInventoryVerificationContact`"

194

# - "`update`"

195

"posDataProviderId": "A String", # The ID of POS data provider. Required only for SetPosProvider.

196

"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS provider.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}

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).

202

203

Returns:

204

An object of the form:

205

206

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

207

"entries": [ # The result of the execution of the batch requests.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

208

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

209

"batchId": 42, # The ID of the request entry to which this entry responds.

210

"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.

211

"code": 42, # The HTTP status of the first error in `errors`.

212

"errors": [ # A list of errors.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

213

{ # An error returned by the API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

214

"domain": "A String", # The domain of the error.

215

"message": "A String", # A description of the error.

216

"reason": "A String", # The error code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

217

},

218

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

219

"message": "A String", # The message of the first error in `errors`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

220

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

221

"gmbAccounts": { # The the list of accessible GMB accounts.

222

"accountId": "A String", # The ID of the Merchant Center account.

223

"gmbAccounts": [ # A list of GMB accounts which are available to the merchant.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

224

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

"email": "A String", # The email which identifies the GMB account.

226

"listingCount": "A String", # Number of listings under this account.

227

"name": "A String", # The name of the GMB account.

228

"type": "A String", # The type of the GMB account (User or Business).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

229

},

230

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

231

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

"kind": "content#liasettingsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsCustomBatchResponseEntry`"

233

"liaSettings": { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The retrieved or updated Lia settings.

234

"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.

235

"countrySettings": [ # The LIA settings for each country.

236

{

237

"about": { # The settings for the About page.

238

"status": "A String", # The status of the verification process for the About page.

239

#

240

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

"url": "A String", # The URL for the About page.

245

},

246

"country": "A String", # Required. CLDR country code (e.g. "US").

247

"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.

248

"inventory": { # LIA inventory verification settings.

249

"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.

250

"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.

251

"inventoryVerificationContactStatus": "A String", # The status of the verification contact.

252

#

253

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

"status": "A String", # The status of the inventory verification process.

258

#

259

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

"onDisplayToOrder": { # LIA "On Display To Order" settings.

265

"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.

266

"status": "A String", # The status of the ?On display to order? feature.

267

#

268

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

"posDataProvider": { # The POS data provider linked with this country.

274

"posDataProviderId": "A String", # The ID of the POS data provider.

275

"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.

276

},

277

"storePickupActive": True or False, # The status of the "Store pickup" feature.

278

},

279

],

280

"kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"

281

},

282

"posDataProviders": [ # The list of POS data providers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

283

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

284

"country": "A String", # Country code.

285

"posDataProviders": [ # A list of POS data providers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

286

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

287

"displayName": "A String", # The display name of Pos data Provider.

288

"fullName": "A String", # The full name of this POS data Provider.

289

"providerId": "A String", # The ID of the account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

294

},

295

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

296

"kind": "content#liasettingsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(merchantId, accountId)</code>

302

<pre>Retrieves the LIA settings of the account.

303

304

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

305

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

306

accountId: string, The ID of the account for which to get or update LIA settings. (required)

307

308

Returns:

309

An object of the form:

310

311

{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

312

"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.

313

"countrySettings": [ # The LIA settings for each country.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

314

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

315

"about": { # The settings for the About page.

316

"status": "A String", # The status of the verification process for the About page.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

317

#

318

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"url": "A String", # The URL for the About page.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

323

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

324

"country": "A String", # Required. CLDR country code (e.g. "US").

325

"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.

326

"inventory": { # LIA inventory verification settings.

327

"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.

328

"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.

329

"inventoryVerificationContactStatus": "A String", # The status of the verification contact.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

330

#

331

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"status": "A String", # The status of the inventory verification process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

336

#

337

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

"onDisplayToOrder": { # LIA "On Display To Order" settings.

343

"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.

344

"status": "A String", # The status of the ?On display to order? feature.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

345

#

346

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

347

# - "`active`"

348

# - "`inactive`"

349

# - "`pending`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

350

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

351

"posDataProvider": { # The POS data provider linked with this country.

352

"posDataProviderId": "A String", # The ID of the POS data provider.

353

"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.

354

},

355

"storePickupActive": True or False, # The status of the "Store pickup" feature.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

356

},

357

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

358

"kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getaccessiblegmbaccounts">getaccessiblegmbaccounts(merchantId, accountId)</code>

364

<pre>Retrieves the list of accessible Google My Business accounts.

365

366

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

367

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

368

accountId: string, The ID of the account for which to retrieve accessible Google My Business accounts. (required)

369

370

Returns:

371

An object of the form:

372

373

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

374

"accountId": "A String", # The ID of the Merchant Center account.

375

"gmbAccounts": [ # A list of GMB accounts which are available to the merchant.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

376

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

377

"email": "A String", # The email which identifies the GMB account.

378

"listingCount": "A String", # Number of listings under this account.

379

"name": "A String", # The name of the GMB account.

380

"type": "A String", # The type of the GMB account (User or Business).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

381

},

382

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

383

"kind": "content#liasettingsGetAccessibleGmbAccountsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

<code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

389

<pre>Lists the LIA settings of the sub-accounts in your Merchant Center account.

390

391

Args:

392

merchantId: string, The ID of the managing account. This must be a multi-client account. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

393

maxResults: integer, The maximum number of LIA settings to return in the response, used for paging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

394

pageToken: string, The token returned by the previous request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

395

396

Returns:

397

An object of the form:

398

399

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

400

"kind": "content#liasettingsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse".

401

"nextPageToken": "A String", # The token for the retrieval of the next page of LIA settings.

402

"resources": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

403

{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

404

"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.

405

"countrySettings": [ # The LIA settings for each country.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

406

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

407

"about": { # The settings for the About page.

408

"status": "A String", # The status of the verification process for the About page.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

409

#

410

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"url": "A String", # The URL for the About page.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

415

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

416

"country": "A String", # Required. CLDR country code (e.g. "US").

417

"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.

418

"inventory": { # LIA inventory verification settings.

419

"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.

420

"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.

421

"inventoryVerificationContactStatus": "A String", # The status of the verification contact.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

422

#

423

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"status": "A String", # The status of the inventory verification process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

428

#

429

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

"onDisplayToOrder": { # LIA "On Display To Order" settings.

435

"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.

436

"status": "A String", # The status of the ?On display to order? feature.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

437

#

438

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

# - "`active`"

440

# - "`inactive`"

441

# - "`pending`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

443

"posDataProvider": { # The POS data provider linked with this country.

444

"posDataProviderId": "A String", # The ID of the POS data provider.

445

"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.

446

},

447

"storePickupActive": True or False, # The status of the "Store pickup" feature.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

448

},

449

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

450

"kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

458

<pre>Retrieves the next page of results.

459

460

Args:

461

previous_request: The request for the previous page. (required)

462

previous_response: The response from the request for the previous page. (required)

463

464

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

466

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="listposdataproviders">listposdataproviders()</code>

472

<pre>Retrieves the list of POS data providers that have active settings for the all eiligible countries.

Args:

Returns:

An object of the form:

478

479

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

480

"kind": "content#liasettingsListPosDataProvidersResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse".

481

"posDataProviders": [ # The list of POS data providers for each eligible country

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

482

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

483

"country": "A String", # Country code.

484

"posDataProviders": [ # A list of POS data providers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

485

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

486

"displayName": "A String", # The display name of Pos data Provider.

487

"fullName": "A String", # The full name of this POS data Provider.

488

"providerId": "A String", # The ID of the account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

],

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

497

<code class="details" id="requestgmbaccess">requestgmbaccess(merchantId, accountId, gmbEmail)</code>

498

<pre>Requests access to a specified Google My Business account.

499

500

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

501

merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

502

accountId: string, The ID of the account for which GMB access is requested. (required)

503

gmbEmail: string, The email of the Google My Business account. (required)

504

505

Returns:

506

An object of the form:

507

508

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

509

"kind": "content#liasettingsRequestGmbAccessResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="requestinventoryverification">requestinventoryverification(merchantId, accountId, country)</code>

515

<pre>Requests inventory validation for the specified country.

516

517

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

518

merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

519

accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)

520

country: string, The country for which inventory validation is requested. (required)

521

522

Returns:

523

An object of the form:

524

525

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

526

"kind": "content#liasettingsRequestInventoryVerificationResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="setinventoryverificationcontact">setinventoryverificationcontact(merchantId, accountId, contactEmail, contactName, country, language)</code>

532

<pre>Sets the inventory verification contract for the specified country.

533

534

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

535

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

536

accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)

537

contactEmail: string, The email of the inventory verification contact. (required)

538

contactName: string, The name of the inventory verification contact. (required)

539

country: string, The country for which inventory verification is requested. (required)

540

language: string, The language for which inventory verification is requested. (required)

541

542

Returns:

543

An object of the form:

544

545

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

546

"kind": "content#liasettingsSetInventoryVerificationContactResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="setposdataprovider">setposdataprovider(merchantId, accountId, country, posDataProviderId=None, posExternalAccountId=None)</code>

552

<pre>Sets the POS data provider for the specified country.

553

554

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

555

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

556

accountId: string, The ID of the account for which to retrieve accessible Google My Business accounts. (required)

557

country: string, The country for which the POS data provider is selected. (required)

558

posDataProviderId: string, The ID of POS data provider.

559

posExternalAccountId: string, The account ID by which this merchant is known to the POS data provider.

560

561

Returns:

562

An object of the form:

563

564

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

565

"kind": "content#liasettingsSetPosDataProviderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

570

<code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None)</code>

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

571

<pre>Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

572

573

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

574

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

575

accountId: string, The ID of the account for which to get or update LIA settings. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

576

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

577

The object takes the form of:

578

579

{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

580

"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.

581

"countrySettings": [ # The LIA settings for each country.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

582

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

583

"about": { # The settings for the About page.

584

"status": "A String", # The status of the verification process for the About page.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

585

#

586

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"url": "A String", # The URL for the About page.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

591

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

592

"country": "A String", # Required. CLDR country code (e.g. "US").

593

"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.

594

"inventory": { # LIA inventory verification settings.

595

"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.

596

"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.

597

"inventoryVerificationContactStatus": "A String", # The status of the verification contact.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

598

#

599

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"status": "A String", # The status of the inventory verification process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

604

#

605

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

"onDisplayToOrder": { # LIA "On Display To Order" settings.

611

"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.

612

"status": "A String", # The status of the ?On display to order? feature.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

613

#

614

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

615

# - "`active`"

616

# - "`inactive`"

617

# - "`pending`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

618

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

619

"posDataProvider": { # The POS data provider linked with this country.

620

"posDataProviderId": "A String", # The ID of the POS data provider.

621

"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.

622

},

623

"storePickupActive": True or False, # The status of the "Store pickup" feature.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

624

},

625

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

626

"kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

627

}

628

629

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).

630

631

Returns:

632

An object of the form:

633

634

{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

635

"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.

636

"countrySettings": [ # The LIA settings for each country.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

637

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

638

"about": { # The settings for the About page.

639

"status": "A String", # The status of the verification process for the About page.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

640

#

641

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"url": "A String", # The URL for the About page.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

646

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

647

"country": "A String", # Required. CLDR country code (e.g. "US").

648

"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.

649

"inventory": { # LIA inventory verification settings.

650

"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.

651

"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.

652

"inventoryVerificationContactStatus": "A String", # The status of the verification contact.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

653

#

654

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

"status": "A String", # The status of the inventory verification process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

659

#

660

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

"onDisplayToOrder": { # LIA "On Display To Order" settings.

666

"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.

667

"status": "A String", # The status of the ?On display to order? feature.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

668

#

669

# Acceptable values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

670

# - "`active`"

671

# - "`inactive`"

672

# - "`pending`"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

673

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

674

"posDataProvider": { # The POS data provider linked with this country.

675

"posDataProviderId": "A String", # The ID of the POS data provider.

676

"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.

677

},

678

"storePickupActive": True or False, # The status of the "Store pickup" feature.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

679

},

680

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

681

"kind": "content#liaSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"

Bu Sun Kim