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

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

[diff] [blame]

106

<p class="firstline">Sets the inventory verification contract for the specified country.</p>

107

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

108

<code><a href="#setposdataprovider">setposdataprovider(merchantId, accountId, country, posDataProviderId=None, posExternalAccountId=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Sets the POS data provider for the specified country.</p>

110

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

111

<code><a href="#update">update(merchantId, accountId, body=None, dryRun=None, x__xgafv=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>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

120

<code class="details" id="custombatch">custombatch(body=None, dryRun=None, x__xgafv=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

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

128

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

129

{

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.

139

{

140

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

141

"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

142

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

143

},

144

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

145

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

146

"inventory": { # LIA inventory verification settings.

147

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

148

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

149

"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

150

"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

151

},

152

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

153

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

154

"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

155

},

156

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

157

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

158

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

159

},

160

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

161

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

162

],

163

"kind": "A String", # 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]

164

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

165

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

166

"method": "A String", # The method of the batch entry. Acceptable values are: - "`get`" - "`getAccessibleGmbAccounts`" - "`requestGmbAccess`" - "`requestInventoryVerification`" - "`setInventoryVerificationContact`" - "`update`"

167

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

168

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

169

},

170

],

171

}

Bu Sun Kim

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

[diff] [blame]

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

174

x__xgafv: string, V1 error format.

175

Allowed values

176

1 - v1 error format

177

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

178

179

Returns:

180

An object of the form:

181

182

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

183

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

184

{

185

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

186

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

187

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

188

"errors": [ # A list of errors.

189

{ # An error returned by the API.

190

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

191

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

192

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

193

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

194

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

195

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

196

},

197

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

198

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

199

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

200

{

201

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

202

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

203

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

204

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

},

],

},

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

209

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

210

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

211

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

212

{

213

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

214

"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

215

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

216

},

217

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

218

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

219

"inventory": { # LIA inventory verification settings.

220

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

221

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

222

"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

223

"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

224

},

225

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

226

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

227

"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

228

},

229

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

230

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

231

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

232

},

233

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

234

},

235

],

236

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

237

},

238

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

239

{

240

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

241

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

242

{

243

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

244

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

245

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

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

246

},

247

],

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

248

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

],

},

],

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

253

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

257

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

Bu Sun Kim

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

[diff] [blame]

258

<pre>Retrieves the LIA settings of the account.

259

260

Args:

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

262

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

263

x__xgafv: string, V1 error format.

264

Allowed values

265

1 - v1 error format

266

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

267

268

Returns:

269

An object of the form:

270

271

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

272

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

273

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

274

{

275

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

276

"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

277

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

278

},

279

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

280

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

281

"inventory": { # LIA inventory verification settings.

282

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

283

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

284

"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

285

"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

286

},

287

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

288

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

289

"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

290

},

291

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

292

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

293

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

294

},

295

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

296

},

297

],

298

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

299

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

303

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

Bu Sun Kim

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

[diff] [blame]

304

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

305

306

Args:

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

308

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

309

x__xgafv: string, V1 error format.

310

Allowed values

311

1 - v1 error format

312

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

313

314

Returns:

315

An object of the form:

316

317

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

318

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

319

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

320

{

321

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

322

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

323

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

324

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

325

},

326

],

327

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

328

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

332

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

Bu Sun Kim

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

[diff] [blame]

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)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

337

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

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

338

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

339

x__xgafv: string, V1 error format.

340

Allowed values

341

1 - v1 error format

342

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

343

344

Returns:

345

An object of the form:

346

347

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

348

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

349

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

350

"resources": [

351

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

352

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

353

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

354

{

355

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

356

"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

357

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

358

},

359

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

360

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

361

"inventory": { # LIA inventory verification settings.

362

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

363

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

364

"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

365

"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

366

},

367

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

368

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

369

"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

370

},

371

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

372

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

373

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

374

},

375

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

376

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

377

],

378

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

379

},

380

],

381

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</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:

Bu Sun Kim

6502091

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

[diff] [blame]

393

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]

394

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

</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

399

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

Bu Sun Kim

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

[diff] [blame]

400

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

401

402

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

403

x__xgafv: string, V1 error format.

404

Allowed values

405

1 - v1 error format

406

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

407

408

Returns:

409

An object of the form:

410

411

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

412

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

413

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

414

{

415

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

416

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

417

{

418

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

419

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

420

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

},

],

},

],

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

429

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

Bu Sun Kim

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

[diff] [blame]

430

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

431

432

Args:

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

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)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

436

x__xgafv: string, V1 error format.

437

Allowed values

438

1 - v1 error format

439

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

440

441

Returns:

442

An object of the form:

443

444

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

445

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

446

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

450

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

Bu Sun Kim

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

[diff] [blame]

451

<pre>Requests inventory validation for the specified country.

452

453

Args:

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

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)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

457

x__xgafv: string, V1 error format.

458

Allowed values

459

1 - v1 error format

460

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

461

462

Returns:

463

An object of the form:

464

465

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

466

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

467

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

473

474

Args:

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

476

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

Bu Sun Kim

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

[diff] [blame]

477

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

478

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

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

Bu Sun Kim

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

[diff] [blame]

485

486

Returns:

487

An object of the form:

488

489

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

490

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

491

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

495

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

Bu Sun Kim

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

[diff] [blame]

496

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

497

498

Args:

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

504

x__xgafv: string, V1 error format.

505

Allowed values

506

1 - v1 error format

507

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

508

509

Returns:

510

An object of the form:

511

512

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

513

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

514

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

518

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

519

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

520

521

Args:

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

523

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]

524

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

525

The object takes the form of:

526

527

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

528

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

529

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

530

{

531

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

532

"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

533

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

Bu Sun Kim

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

[diff] [blame]

534

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

535

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

536

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

537

"inventory": { # LIA inventory verification settings.

538

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

539

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

540

"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

541

"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

542

},

543

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

544

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

545

"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

546

},

547

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

548

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

549

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

550

},

551

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

552

},

553

],

554

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

555

}

Bu Sun Kim

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

[diff] [blame]

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

558

x__xgafv: string, V1 error format.

559

Allowed values

560

1 - v1 error format

561

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

562

563

Returns:

564

An object of the form:

565

566

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

Yoshi Automation Bot