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

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

[diff] [blame]

141

overwrite: boolean, Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

142

143

Returns:

144

An object of the form:

145

146

{

Bu Sun Kim

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

[diff] [blame]

147

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

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

152

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

153

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

157

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

158

<pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

159

160

Args:

Dan O'Meara

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

[diff] [blame]

161

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

162

The object takes the form of:

163

164

{

Bu Sun Kim

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

[diff] [blame]

165

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

Craig Citro

e633be1

2015-03-02 13:40:36 -0800

[diff] [blame]

166

{ # A batch entry encoding a single non-batch accounts request.

Bu Sun Kim

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

[diff] [blame]

167

"account": { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. # The account to create or update. Only defined if the method is `insert` or `update`.

168

"adultContent": True or False, # Indicates whether the merchant sells adult content.

169

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

170

{

171

"adwordsId": "A String", # Customer ID of the AdWords account.

172

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

173

#

174

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

175

# - "`active`"

176

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

177

},

Bu Sun Kim

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

[diff] [blame]

178

],

179

"businessInformation": { # The business information of the account.

180

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

181

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

182

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

183

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

184

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

185

"streetAddress": "A String", # Street-level part of the address.

186

},

187

"customerService": { # The customer service information of the business.

188

"email": "A String", # Customer service email.

189

"phoneNumber": "A String", # Customer service phone number.

190

"url": "A String", # Customer service URL.

191

},

192

"phoneNumber": "A String", # The phone number of the business.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

193

},

Bu Sun Kim

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

[diff] [blame]

194

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

195

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

196

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

197

#

198

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

203

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

204

"name": "A String", # Required. Display name for the account.

205

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

206

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

207

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

208

{

209

"admin": True or False, # Whether user is an admin.

210

"emailAddress": "A String", # User's email address.

211

"orderManager": True or False, # Whether user is an order manager.

212

"paymentsAnalyst": True or False, # Whether user can access payment statements.

213

"paymentsManager": True or False, # Whether user can manage payment settings.

214

},

215

],

216

"websiteUrl": "A String", # The merchant's website.

217

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

218

{

219

"channelId": "A String", # Channel ID.

220

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

},

],

},

"accountId": "A String", # The ID of the targeted account. Only defined if the method is not `insert`.

225

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

226

"force": True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.

Dmitry Frenkel

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

[diff] [blame]

227

"labelIds": [ # Label IDs for the 'updatelabels' request.

228

"A String",

229

],

Bu Sun Kim

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

[diff] [blame]

230

"linkRequest": { # Details about the `link` request.

231

"action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants.

232

#

233

# Acceptable values are:

# - "`approve`"

# - "`remove`"

# - "`request`"

"linkType": "A String", # Type of the link between the two accounts.

238

#

239

# Acceptable values are:

240

# - "`channelPartner`"

241

# - "`eCommercePlatform`"

242

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

243

},

244

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

245

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

Dan O'Meara

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

[diff] [blame]

246

#

247

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`claimWebsite`"

# - "`delete`"

# - "`get`"

# - "`insert`"

# - "`link`"

# - "`update`"

"overwrite": True or False, # Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

259

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

260

261

Returns:

262

An object of the form:

263

264

{

Bu Sun Kim

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

[diff] [blame]

265

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

Craig Citro

e633be1

2015-03-02 13:40:36 -0800

[diff] [blame]

266

{ # A batch entry encoding a single non-batch accounts response.

Bu Sun Kim

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

[diff] [blame]

267

"account": { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. # The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`.

268

"adultContent": True or False, # Indicates whether the merchant sells adult content.

269

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

270

{

271

"adwordsId": "A String", # Customer ID of the AdWords account.

272

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

273

#

274

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

275

# - "`active`"

276

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

277

},

Bu Sun Kim

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

[diff] [blame]

278

],

279

"businessInformation": { # The business information of the account.

280

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

281

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

282

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

283

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

284

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

285

"streetAddress": "A String", # Street-level part of the address.

286

},

287

"customerService": { # The customer service information of the business.

288

"email": "A String", # Customer service email.

289

"phoneNumber": "A String", # Customer service phone number.

290

"url": "A String", # Customer service URL.

291

},

292

"phoneNumber": "A String", # The phone number of the business.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

293

},

Bu Sun Kim

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

[diff] [blame]

294

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

295

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

296

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

297

#

298

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

303

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

304

"name": "A String", # Required. Display name for the account.

305

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

306

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

307

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

308

{

309

"admin": True or False, # Whether user is an admin.

310

"emailAddress": "A String", # User's email address.

311

"orderManager": True or False, # Whether user is an order manager.

312

"paymentsAnalyst": True or False, # Whether user can access payment statements.

313

"paymentsManager": True or False, # Whether user can manage payment settings.

314

},

315

],

316

"websiteUrl": "A String", # The merchant's website.

317

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

318

{

319

"channelId": "A String", # Channel ID.

320

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

321

},

322

],

323

},

Bu Sun Kim

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

[diff] [blame]

324

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

325

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

326

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

327

"errors": [ # A list of errors.

328

{ # An error returned by the API.

329

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

330

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

331

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

332

},

333

],

334

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

335

},

336

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

337

"linkStatus": "A String", # Deprecated. This field is never set.

Dan O'Meara

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

[diff] [blame]

338

#

339

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

340

# - "`active`"

341

# - "`inactive`"

342

# - "`pending`"

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

343

},

344

],

Bu Sun Kim

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

[diff] [blame]

345

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

350

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

Bu Sun Kim

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

[diff] [blame]

351

<pre>Deletes a Merchant Center sub-account.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

352

353

Args:

Bu Sun Kim

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

[diff] [blame]

354

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

355

accountId: string, The ID of the account. (required)

Bu Sun Kim

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

[diff] [blame]

356

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-05-20 12:08:20 -0700

[diff] [blame]

357

force: boolean, Flag to delete sub-accounts with products. The default value is false.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

363

<pre>Retrieves a Merchant Center account.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

364

365

Args:

Dan O'Meara

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

[diff] [blame]

366

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)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

367

accountId: string, The ID of the account. (required)

368

369

Returns:

370

An object of the form:

371

Dan O'Meara

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

[diff] [blame]

372

{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Bu Sun Kim

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

[diff] [blame]

373

"adultContent": True or False, # Indicates whether the merchant sells adult content.

374

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

375

{

376

"adwordsId": "A String", # Customer ID of the AdWords account.

377

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

378

#

379

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

380

# - "`active`"

381

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

382

},

Bu Sun Kim

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

[diff] [blame]

383

],

384

"businessInformation": { # The business information of the account.

385

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

386

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

387

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

388

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

389

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

390

"streetAddress": "A String", # Street-level part of the address.

391

},

392

"customerService": { # The customer service information of the business.

393

"email": "A String", # Customer service email.

394

"phoneNumber": "A String", # Customer service phone number.

395

"url": "A String", # Customer service URL.

396

},

397

"phoneNumber": "A String", # The phone number of the business.

398

},

399

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

400

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

401

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

402

#

403

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

408

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

409

"name": "A String", # Required. Display name for the account.

410

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

411

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

412

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

413

{

414

"admin": True or False, # Whether user is an admin.

415

"emailAddress": "A String", # User's email address.

416

"orderManager": True or False, # Whether user is an order manager.

417

"paymentsAnalyst": True or False, # Whether user can access payment statements.

418

"paymentsManager": True or False, # Whether user can manage payment settings.

419

},

420

],

421

"websiteUrl": "A String", # The merchant's website.

422

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

423

{

424

"channelId": "A String", # Channel ID.

425

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

426

},

427

],

428

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

432

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

Bu Sun Kim

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

[diff] [blame]

433

<pre>Creates a Merchant Center sub-account.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

434

435

Args:

Bu Sun Kim

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

[diff] [blame]

436

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

Dan O'Meara

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

[diff] [blame]

437

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

438

The object takes the form of:

439

Dan O'Meara

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

[diff] [blame]

440

{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Bu Sun Kim

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

[diff] [blame]

441

"adultContent": True or False, # Indicates whether the merchant sells adult content.

442

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

443

{

444

"adwordsId": "A String", # Customer ID of the AdWords account.

445

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

446

#

447

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

448

# - "`active`"

449

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

450

},

Bu Sun Kim

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

[diff] [blame]

451

],

452

"businessInformation": { # The business information of the account.

453

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

454

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

455

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

456

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

457

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

458

"streetAddress": "A String", # Street-level part of the address.

459

},

460

"customerService": { # The customer service information of the business.

461

"email": "A String", # Customer service email.

462

"phoneNumber": "A String", # Customer service phone number.

463

"url": "A String", # Customer service URL.

464

},

465

"phoneNumber": "A String", # The phone number of the business.

466

},

467

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

468

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

469

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

470

#

471

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

476

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

477

"name": "A String", # Required. Display name for the account.

478

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

479

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

480

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

481

{

482

"admin": True or False, # Whether user is an admin.

483

"emailAddress": "A String", # User's email address.

484

"orderManager": True or False, # Whether user is an order manager.

485

"paymentsAnalyst": True or False, # Whether user can access payment statements.

486

"paymentsManager": True or False, # Whether user can manage payment settings.

487

},

488

],

489

"websiteUrl": "A String", # The merchant's website.

490

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

491

{

492

"channelId": "A String", # Channel ID.

493

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

494

},

495

],

496

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

497

Bu Sun Kim

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

[diff] [blame]

498

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

499

500

Returns:

501

An object of the form:

502

Dan O'Meara

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

[diff] [blame]

503

{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Bu Sun Kim

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

[diff] [blame]

504

"adultContent": True or False, # Indicates whether the merchant sells adult content.

505

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

506

{

507

"adwordsId": "A String", # Customer ID of the AdWords account.

508

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

509

#

510

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

511

# - "`active`"

512

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

513

},

Bu Sun Kim

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

[diff] [blame]

514

],

515

"businessInformation": { # The business information of the account.

516

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

517

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

518

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

519

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

520

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

521

"streetAddress": "A String", # Street-level part of the address.

522

},

523

"customerService": { # The customer service information of the business.

524

"email": "A String", # Customer service email.

525

"phoneNumber": "A String", # Customer service phone number.

526

"url": "A String", # Customer service URL.

527

},

528

"phoneNumber": "A String", # The phone number of the business.

529

},

530

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

531

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

532

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

533

#

534

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

539

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

540

"name": "A String", # Required. Display name for the account.

541

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

542

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

543

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

544

{

545

"admin": True or False, # Whether user is an admin.

546

"emailAddress": "A String", # User's email address.

547

"orderManager": True or False, # Whether user is an order manager.

548

"paymentsAnalyst": True or False, # Whether user can access payment statements.

549

"paymentsManager": True or False, # Whether user can manage payment settings.

550

},

551

],

552

"websiteUrl": "A String", # The merchant's website.

553

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

554

{

555

"channelId": "A String", # Channel ID.

556

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

557

},

558

],

559

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

563

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

Bu Sun Kim

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

[diff] [blame]

564

<pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

565

566

Args:

Dan O'Meara

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

[diff] [blame]

567

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]

568

accountId: string, The ID of the account that should be linked. (required)

Dan O'Meara

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

[diff] [blame]

569

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

570

The object takes the form of:

571

572

{

Bu Sun Kim

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

[diff] [blame]

573

"action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants.

Dan O'Meara

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

[diff] [blame]

574

#

575

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`approve`"

# - "`remove`"

# - "`request`"

"linkType": "A String", # Type of the link between the two accounts.

Dan O'Meara

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

[diff] [blame]

580

#

581

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

582

# - "`channelPartner`"

583

# - "`eCommercePlatform`"

584

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

Bu Sun Kim

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

[diff] [blame]

}

Returns:

An object of the form:

590

591

{

Bu Sun Kim

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

[diff] [blame]

592

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

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]

597

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

Bu Sun Kim

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

[diff] [blame]

598

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

599

600

Args:

601

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

602

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

Bu Sun Kim

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

[diff] [blame]

603

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

604

605

Returns:

606

An object of the form:

607

608

{

Bu Sun Kim

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

[diff] [blame]

609

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

610

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

611

"resources": [

Dan O'Meara

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

[diff] [blame]

612

{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Bu Sun Kim

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

[diff] [blame]

613

"adultContent": True or False, # Indicates whether the merchant sells adult content.

614

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

615

{

616

"adwordsId": "A String", # Customer ID of the AdWords account.

617

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

618

#

619

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

620

# - "`active`"

621

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

622

},

Bu Sun Kim

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

[diff] [blame]

623

],

624

"businessInformation": { # The business information of the account.

625

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

626

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

627

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

628

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

629

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

630

"streetAddress": "A String", # Street-level part of the address.

631

},

632

"customerService": { # The customer service information of the business.

633

"email": "A String", # Customer service email.

634

"phoneNumber": "A String", # Customer service phone number.

635

"url": "A String", # Customer service URL.

636

},

637

"phoneNumber": "A String", # The phone number of the business.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

638

},

Bu Sun Kim

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

[diff] [blame]

639

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

640

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

641

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

642

#

643

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

648

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

649

"name": "A String", # Required. Display name for the account.

650

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

651

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

652

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

653

{

654

"admin": True or False, # Whether user is an admin.

655

"emailAddress": "A String", # User's email address.

656

"orderManager": True or False, # Whether user is an order manager.

657

"paymentsAnalyst": True or False, # Whether user can access payment statements.

658

"paymentsManager": True or False, # Whether user can manage payment settings.

659

},

660

],

661

"websiteUrl": "A String", # The merchant's website.

662

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

663

{

664

"channelId": "A String", # Channel ID.

665

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

666

},

667

],

668

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

],

}</pre>

</div>

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

675

<pre>Retrieves the next page of results.

676

677

Args:

678

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

679

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

680

681

Returns:

Bu Sun Kim

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

[diff] [blame]

682

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

683

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

688

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

689

<pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

690

691

Args:

Dan O'Meara

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

[diff] [blame]

692

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)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

693

accountId: string, The ID of the account. (required)

Dan O'Meara

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

[diff] [blame]

694

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

695

The object takes the form of:

696

Dan O'Meara

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

[diff] [blame]

697

{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Bu Sun Kim

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

[diff] [blame]

698

"adultContent": True or False, # Indicates whether the merchant sells adult content.

699

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

700

{

701

"adwordsId": "A String", # Customer ID of the AdWords account.

702

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

703

#

704

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

705

# - "`active`"

706

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

707

},

Bu Sun Kim

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

[diff] [blame]

708

],

709

"businessInformation": { # The business information of the account.

710

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

711

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

712

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

713

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

714

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

715

"streetAddress": "A String", # Street-level part of the address.

716

},

717

"customerService": { # The customer service information of the business.

718

"email": "A String", # Customer service email.

719

"phoneNumber": "A String", # Customer service phone number.

720

"url": "A String", # Customer service URL.

721

},

722

"phoneNumber": "A String", # The phone number of the business.

723

},

724

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

725

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

726

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

727

#

728

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

733

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

734

"name": "A String", # Required. Display name for the account.

735

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

736

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

737

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

738

{

739

"admin": True or False, # Whether user is an admin.

740

"emailAddress": "A String", # User's email address.

741

"orderManager": True or False, # Whether user is an order manager.

742

"paymentsAnalyst": True or False, # Whether user can access payment statements.

743

"paymentsManager": True or False, # Whether user can manage payment settings.

744

},

745

],

746

"websiteUrl": "A String", # The merchant's website.

747

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

748

{

749

"channelId": "A String", # Channel ID.

750

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

751

},

752

],

753

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

754

Bu Sun Kim

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

[diff] [blame]

755

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

756

757

Returns:

758

An object of the form:

759

Dan O'Meara

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

[diff] [blame]

760

{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Bu Sun Kim

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

[diff] [blame]

761

"adultContent": True or False, # Indicates whether the merchant sells adult content.

762

"adwordsLinks": [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.

763

{

764

"adwordsId": "A String", # Customer ID of the AdWords account.

765

"status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Dan O'Meara

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

[diff] [blame]

766

#

767

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

768

# - "`active`"

769

# - "`pending`"

Bu Sun Kim

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

[diff] [blame]

770

},

Bu Sun Kim

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

[diff] [blame]

771

],

772

"businessInformation": { # The business information of the account.

773

"address": { # The address of the business.

Dmitry Frenkel

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

[diff] [blame]

774

"country": "A String", # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.

Bu Sun Kim

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

[diff] [blame]

775

"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).

776

"postalCode": "A String", # Postal code or ZIP (e.g. "94043").

777

"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").

778

"streetAddress": "A String", # Street-level part of the address.

779

},

780

"customerService": { # The customer service information of the business.

781

"email": "A String", # Customer service email.

782

"phoneNumber": "A String", # Customer service phone number.

783

"url": "A String", # Customer service URL.

784

},

785

"phoneNumber": "A String", # The phone number of the business.

786

},

787

"googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.

788

"gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.

789

"status": "A String", # Status of the link between this Merchant Center account and the GMB account.

790

#

791

# Acceptable values are:

# - "`active`"

# - "`pending`"

},

"id": "A String", # Required for update. Merchant Center account ID.

796

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

797

"name": "A String", # Required. Display name for the account.

798

"reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.

799

"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.

800

"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.

801

{

802

"admin": True or False, # Whether user is an admin.

803

"emailAddress": "A String", # User's email address.

804

"orderManager": True or False, # Whether user is an order manager.

805

"paymentsAnalyst": True or False, # Whether user can access payment statements.

806

"paymentsManager": True or False, # Whether user can manage payment settings.

807

},

808

],

809

"websiteUrl": "A String", # The merchant's website.

810

"youtubeChannelLinks": [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.

811

{

812

"channelId": "A String", # Channel ID.

813

"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

814

},

815

],

816

}</pre>

Craig Citro