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

2020-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 Kim

2019-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

Dan O'Meara

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

[diff] [blame]

112

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

Bu Sun Kim

2019-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

115

Args:

Dan O'Meara

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

[diff] [blame]

116

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

117

The object takes the form of:

118

119

{

Bu Sun Kim

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

[diff] [blame^]

120

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

Bu Sun Kim

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

[diff] [blame]

121

{

Bu Sun Kim

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

[diff] [blame^]

122

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

123

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

124

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

125

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

126

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

127

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

128

"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`.

129

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

130

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

Bu Sun Kim

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

[diff] [blame]

131

{

Bu Sun Kim

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

[diff] [blame^]

132

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

133

"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]

134

#

135

# 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]

140

},

Bu Sun Kim

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

[diff] [blame^]

141

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

142

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

143

"inventory": { # LIA inventory verification settings.

144

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

145

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

146

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

Dan O'Meara

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

[diff] [blame]

147

#

148

# 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]

153

#

154

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

160

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

161

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

Dan O'Meara

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

[diff] [blame]

162

#

163

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame^]

164

# - "`active`"

165

# - "`inactive`"

166

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

167

},

Bu Sun Kim

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

[diff] [blame^]

168

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

169

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

170

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

171

},

172

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

Bu Sun Kim

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

[diff] [blame]

173

},

174

],

Bu Sun Kim

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

[diff] [blame^]

175

"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]

176

},

Bu Sun Kim

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

[diff] [blame^]

177

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

178

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

Dan O'Meara

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

[diff] [blame]

179

#

180

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame^]

181

# - "`get`"

182

# - "`getAccessibleGmbAccounts`"

183

# - "`requestGmbAccess`"

184

# - "`requestInventoryVerification`"

185

# - "`setInventoryVerificationContact`"

186

# - "`update`"

187

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

188

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

194

195

Returns:

196

An object of the form:

197

198

{

Bu Sun Kim

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

[diff] [blame^]

199

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

Bu Sun Kim

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

[diff] [blame]

200

{

Bu Sun Kim

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

[diff] [blame^]

201

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

202

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

203

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

204

"errors": [ # A list of errors.

Bu Sun Kim

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

[diff] [blame]

205

{ # An error returned by the API.

Bu Sun Kim

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

[diff] [blame^]

206

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

207

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

208

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

Bu Sun Kim

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

[diff] [blame]

209

},

210

],

Bu Sun Kim

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

[diff] [blame^]

211

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

Bu Sun Kim

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

[diff] [blame]

212

},

Bu Sun Kim

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

[diff] [blame^]

213

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

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

{

Bu Sun Kim

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

[diff] [blame^]

217

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

218

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

219

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

220

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

Bu Sun Kim

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

[diff] [blame]

221

},

222

],

Bu Sun Kim

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

[diff] [blame]

223

},

Bu Sun Kim

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

[diff] [blame^]

224

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

225

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

226

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

227

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

228

{

229

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

230

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

231

#

232

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

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

237

},

238

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

239

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

240

"inventory": { # LIA inventory verification settings.

241

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

242

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

243

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

244

#

245

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

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

250

#

251

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

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

257

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

258

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

259

#

260

# Acceptable values are:

# - "`active`"

# - "`inactive`"

# - "`pending`"

},

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

266

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

267

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

268

},

269

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

270

},

271

],

272

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

273

},

274

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

Bu Sun Kim

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

[diff] [blame]

275

{

Bu Sun Kim

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

[diff] [blame^]

276

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

277

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

Bu Sun Kim

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

[diff] [blame]

278

{

Bu Sun Kim

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

[diff] [blame^]

279

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

280

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

281

"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]

286

},

287

],

Bu Sun Kim

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

[diff] [blame^]

288

"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>

294

<pre>Retrieves the LIA settings of the account.

295

296

Args:

Dan O'Meara

2020-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 Kim

2019-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

300

Returns:

301

An object of the form:

302

303

{ # 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^]

304

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

305

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

Bu Sun Kim

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

[diff] [blame]

306

{

Bu Sun Kim

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

[diff] [blame^]

307

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

308

"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]

309

#

310

# 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]

315

},

Bu Sun Kim

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

[diff] [blame^]

316

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

317

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

318

"inventory": { # LIA inventory verification settings.

319

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

320

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

321

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

Dan O'Meara

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

[diff] [blame]

322

#

323

# 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]

328

#

329

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

335

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

336

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

Dan O'Meara

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

[diff] [blame]

337

#

338

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame^]

339

# - "`active`"

340

# - "`inactive`"

341

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

342

},

Bu Sun Kim

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

[diff] [blame^]

343

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

344

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

345

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

346

},

347

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

Bu Sun Kim

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

[diff] [blame]

348

},

349

],

Bu Sun Kim

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

[diff] [blame^]

350

"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>

356

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

357

358

Args:

Dan O'Meara

2020-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 Kim

2019-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

362

Returns:

363

An object of the form:

364

365

{

Bu Sun Kim

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

[diff] [blame^]

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

{

Bu Sun Kim

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

[diff] [blame^]

369

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

370

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

371

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

372

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

Bu Sun Kim

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

[diff] [blame]

373

},

374

],

Bu Sun Kim

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

[diff] [blame^]

375

"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^]

380

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

Bu Sun Kim

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

[diff] [blame]

381

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

382

383

Args:

384

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]

385

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^]

386

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

Bu Sun Kim

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

[diff] [blame]

387

388

Returns:

389

An object of the form:

390

391

{

Bu Sun Kim

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

[diff] [blame^]

392

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

393

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

394

"resources": [

Bu Sun Kim

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

[diff] [blame]

395

{ # 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^]

396

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

397

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

Bu Sun Kim

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

[diff] [blame]

398

{

Bu Sun Kim

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

[diff] [blame^]

399

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

400

"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]

401

#

402

# 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]

407

},

Bu Sun Kim

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

[diff] [blame^]

408

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

409

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

410

"inventory": { # LIA inventory verification settings.

411

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

412

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

413

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

Dan O'Meara

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

[diff] [blame]

414

#

415

# 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]

420

#

421

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

427

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

428

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

Dan O'Meara

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

[diff] [blame]

429

#

430

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame^]

431

# - "`active`"

432

# - "`inactive`"

433

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

434

},

Bu Sun Kim

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

[diff] [blame^]

435

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

436

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

437

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

438

},

439

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

Bu Sun Kim

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

[diff] [blame]

440

},

441

],

Bu Sun Kim

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

[diff] [blame^]

442

"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>

450

<pre>Retrieves the next page of results.

451

452

Args:

453

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

454

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

455

456

Returns:

Bu Sun Kim

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

[diff] [blame^]

457

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]

458

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

</pre>

</div>

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

Args:

Returns:

An object of the form:

470

471

{

Bu Sun Kim

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

[diff] [blame^]

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

Bu Sun Kim

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

[diff] [blame]

474

{

Bu Sun Kim

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

[diff] [blame^]

475

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

476

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

Bu Sun Kim

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

[diff] [blame]

477

{

Bu Sun Kim

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

[diff] [blame^]

478

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

479

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

480

"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]

489

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

490

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

491

492

Args:

Dan O'Meara

2020-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 Kim

2019-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

497

Returns:

498

An object of the form:

499

500

{

Bu Sun Kim

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

[diff] [blame^]

501

"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>

507

<pre>Requests inventory validation for the specified country.

508

509

Args:

Dan O'Meara

2020-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 Kim

2019-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

514

Returns:

515

An object of the form:

516

517

{

Bu Sun Kim

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

[diff] [blame^]

518

"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>

524

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

525

526

Args:

Dan O'Meara

2020-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 Kim

2019-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

534

Returns:

535

An object of the form:

536

537

{

Bu Sun Kim

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

[diff] [blame^]

538

"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>

544

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

545

546

Args:

Dan O'Meara

2020-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 Kim

2019-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

553

Returns:

554

An object of the form:

555

556

{

Bu Sun Kim

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

[diff] [blame^]

557

"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]

562

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

Bu Sun Kim

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

[diff] [blame]

563

<pre>Updates the LIA settings of the account.

564

565

Args:

Dan O'Meara

2020-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 Kim

2019-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'Meara

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

[diff] [blame]

568

body: object, The request body.

Bu Sun Kim

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

Bu Sun Kim

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

[diff] [blame^]

572

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

573

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

Bu Sun Kim

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

[diff] [blame]

574

{

Bu Sun Kim

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

[diff] [blame^]

575

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

576

"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]

577

#

578

# 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]

583

},

Bu Sun Kim

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

[diff] [blame^]

584

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

585

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

586

"inventory": { # LIA inventory verification settings.

587

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

588

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

589

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

Dan O'Meara

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

[diff] [blame]

590

#

591

# 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]

596

#

597

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

603

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

604

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

Dan O'Meara

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

[diff] [blame]

605

#

606

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame^]

607

# - "`active`"

608

# - "`inactive`"

609

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

610

},

Bu Sun Kim

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

[diff] [blame^]

611

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

612

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

613

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

614

},

615

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

Bu Sun Kim

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

[diff] [blame]

616

},

617

],

Bu Sun Kim

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

[diff] [blame^]

618

"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]

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

623

Returns:

624

An object of the form:

625

626

{ # 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^]

627

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

628

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

Bu Sun Kim

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

[diff] [blame]

629

{

Bu Sun Kim

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

[diff] [blame^]

630

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

631

"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]

632

#

633

# 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]

638

},

Bu Sun Kim

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

[diff] [blame^]

639

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

640

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

641

"inventory": { # LIA inventory verification settings.

642

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

643

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

644

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

Dan O'Meara

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

[diff] [blame]

645

#

646

# 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]

651

#

652

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

658

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

659

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

Dan O'Meara

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

[diff] [blame]

660

#

661

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame^]

662

# - "`active`"

663

# - "`inactive`"

664

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

665

},

Bu Sun Kim

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

[diff] [blame^]

666

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

667

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

668

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

669

},

670

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

Bu Sun Kim

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

[diff] [blame]

671

},

672

],

Bu Sun Kim

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

[diff] [blame^]

673

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

Bu Sun Kim