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

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

[diff] [blame]

137

<pre>Claims the website of a Merchant Center sub-account.

Sai Cheemalapati

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

[diff] [blame]

138

139

Args:

Dan O'Meara

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

[diff] [blame]

140

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)

Sai Cheemalapati

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

[diff] [blame]

141

accountId: string, The ID of the account whose website is claimed. (required)

Dan O'Meara

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

[diff] [blame]

142

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.

Bu Sun Kim

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

[diff] [blame]

143

x__xgafv: string, V1 error format.

144

Allowed values

145

1 - v1 error format

146

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

147

148

Returns:

149

An object of the form:

150

151

{

Yoshi Automation Bot

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

[diff] [blame]

152

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

153

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

157

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

158

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

162

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

Craig Citro

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

[diff] [blame]

163

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

164

165

Args:

Dan O'Meara

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

[diff] [blame]

166

body: object, The request body.

Craig Citro

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

[diff] [blame]

167

The object takes the form of:

168

169

{

Yoshi Automation Bot

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

[diff] [blame]

170

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

171

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

172

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

173

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

174

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

175

{

176

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

177

"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. Acceptable values are: - "`active`" - "`pending`"

178

},

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

179

],

Yoshi Automation Bot

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

[diff] [blame]

180

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

181

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

182

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

183

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

184

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

185

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

186

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

Yoshi Automation Bot

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

[diff] [blame]

187

},

Yoshi Automation Bot

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

[diff] [blame]

188

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

189

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

190

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

191

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

Yoshi Automation Bot

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

[diff] [blame]

192

},

Yoshi Automation Bot

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

[diff] [blame]

193

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

Yoshi Automation Bot

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

[diff] [blame]

194

},

Yoshi Automation Bot

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

[diff] [blame]

195

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

196

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

197

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

198

},

199

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

200

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

201

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

202

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

203

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

204

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

205

{

206

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

207

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

208

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

209

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

210

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

211

},

212

],

213

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

214

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

215

{

216

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

217

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

218

},

219

],

Craig Citro

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

[diff] [blame]

220

},

Yoshi Automation Bot

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

[diff] [blame]

221

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

222

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

223

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

224

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

225

"A String",

226

],

227

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

228

"action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"

229

"linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`"

230

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

231

},

232

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

233

"method": "A String", # The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`"

234

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

235

},

236

],

237

}

Craig Citro

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

[diff] [blame]

238

Bu Sun Kim

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

[diff] [blame]

239

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]

240

x__xgafv: string, V1 error format.

241

Allowed values

242

1 - v1 error format

243

2 - v2 error format

Craig Citro

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

[diff] [blame]

244

245

Returns:

246

An object of the form:

247

248

{

Yoshi Automation Bot

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

[diff] [blame]

249

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

250

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

251

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

252

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

253

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

254

{

255

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

256

"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. Acceptable values are: - "`active`" - "`pending`"

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

257

},

Yoshi Automation Bot

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

[diff] [blame]

258

],

259

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

260

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

261

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

262

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

263

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

264

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

265

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

Yoshi Automation Bot

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

[diff] [blame]

266

},

Yoshi Automation Bot

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

[diff] [blame]

267

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

268

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

269

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

270

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

271

},

272

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

Bu Sun Kim

6502091

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

[diff] [blame]

273

},

Yoshi Automation Bot

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

[diff] [blame]

274

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

275

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

276

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

Yoshi Automation Bot

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

[diff] [blame]

277

},

Yoshi Automation Bot

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

[diff] [blame]

278

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

279

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

280

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

281

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

282

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

283

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

284

{

285

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

286

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

287

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

288

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

289

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

290

},

291

],

292

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

293

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

294

{

295

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

296

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

297

},

298

],

Craig Citro

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

[diff] [blame]

299

},

Yoshi Automation Bot

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

[diff] [blame]

300

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

301

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

302

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

303

"errors": [ # A list of errors.

304

{ # An error returned by the API.

305

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

306

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

307

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

308

},

309

],

310

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

311

},

312

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

313

"linkStatus": "A String", # Deprecated. This field is never set. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"

314

},

315

],

316

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

317

}</pre>

Craig Citro

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

321

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

Bu Sun Kim

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

[diff] [blame]

322

<pre>Deletes a Merchant Center sub-account.

Craig Citro

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

[diff] [blame]

323

324

Args:

Bu Sun Kim

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

[diff] [blame]

325

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]

326

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

Yoshi Automation Bot

b6971b0

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

[diff] [blame]

327

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

Yoshi Automation Bot

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

[diff] [blame]

328

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

Bu Sun Kim

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

[diff] [blame]

329

x__xgafv: string, V1 error format.

330

Allowed values

331

1 - v1 error format

332

2 - v2 error format

Craig Citro

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

[diff] [blame]

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

337

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

Bu Sun Kim

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

[diff] [blame]

338

<pre>Retrieves a Merchant Center account.

Craig Citro

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

[diff] [blame]

339

340

Args:

Dan O'Meara

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

[diff] [blame]

341

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]

342

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

Bu Sun Kim

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

[diff] [blame]

343

x__xgafv: string, V1 error format.

344

Allowed values

345

1 - v1 error format

346

2 - v2 error format

Craig Citro

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

[diff] [blame]

347

348

Returns:

349

An object of the form:

350

Dan O'Meara

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

[diff] [blame]

351

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

Yoshi Automation Bot

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

[diff] [blame]

352

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

353

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

354

{

355

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

356

"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. Acceptable values are: - "`active`" - "`pending`"

Yoshi Automation Bot

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

[diff] [blame]

357

},

Yoshi Automation Bot

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

[diff] [blame]

358

],

359

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

360

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

361

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

362

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

363

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

364

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

365

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

Yoshi Automation Bot

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

[diff] [blame]

366

},

Yoshi Automation Bot

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

[diff] [blame]

367

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

368

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

369

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

370

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

371

},

372

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

373

},

374

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

375

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

376

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

377

},

378

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

379

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

380

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

381

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

382

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

383

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

384

{

385

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

386

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

387

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

388

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

389

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

390

},

391

],

392

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

393

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

394

{

395

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

396

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

397

},

398

],

399

}</pre>

Craig Citro

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

403

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

Bu Sun Kim

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

[diff] [blame]

404

<pre>Creates a Merchant Center sub-account.

Craig Citro

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

[diff] [blame]

405

406

Args:

Bu Sun Kim

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

[diff] [blame]

407

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]

408

body: object, The request body.

Craig Citro

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

[diff] [blame]

409

The object takes the form of:

410

Dan O'Meara

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

[diff] [blame]

411

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

Yoshi Automation Bot

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

[diff] [blame]

412

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

413

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

414

{

415

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

416

"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. Acceptable values are: - "`active`" - "`pending`"

417

},

418

],

Yoshi Automation Bot

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

[diff] [blame]

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

},

427

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

428

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

429

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

430

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

431

},

432

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

433

},

434

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

435

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

436

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

437

},

438

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

439

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

440

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

441

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

442

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

443

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

444

{

445

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

446

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

447

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

448

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

449

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

450

},

451

],

452

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

453

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

454

{

455

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

456

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

457

},

458

],

Yoshi Automation Bot

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

[diff] [blame]

459

}

Craig Citro

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

[diff] [blame]

460

Bu Sun Kim

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

[diff] [blame]

461

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]

462

x__xgafv: string, V1 error format.

463

Allowed values

464

1 - v1 error format

465

2 - v2 error format

Craig Citro

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

[diff] [blame]

466

467

Returns:

468

An object of the form:

469

Dan O'Meara

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

[diff] [blame]

470

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

Yoshi Automation Bot

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

[diff] [blame]

471

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

472

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

473

{

474

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

475

"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. Acceptable values are: - "`active`" - "`pending`"

Yoshi Automation Bot

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

[diff] [blame]

476

},

Yoshi Automation Bot

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

[diff] [blame]

477

],

478

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

479

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

480

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

481

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

482

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

483

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

484

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

Yoshi Automation Bot

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

[diff] [blame]

485

},

Yoshi Automation Bot

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

[diff] [blame]

486

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

487

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

488

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

489

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

490

},

491

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

492

},

493

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

494

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

495

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

496

},

497

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

498

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

499

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

500

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

501

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

502

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

503

{

504

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

505

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

506

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

507

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

508

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

509

},

510

],

511

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

512

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

513

{

514

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

515

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

516

},

517

],

518

}</pre>

Craig Citro

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

522

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

Bu Sun Kim

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

[diff] [blame]

523

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

524

525

Args:

Dan O'Meara

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

[diff] [blame]

526

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]

527

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

Dan O'Meara

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

[diff] [blame]

528

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

529

The object takes the form of:

530

531

{

Yoshi Automation Bot

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

[diff] [blame]

532

"action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"

533

"linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`"

534

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

535

}

Bu Sun Kim

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

[diff] [blame]

536

Bu Sun Kim

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

[diff] [blame]

537

x__xgafv: string, V1 error format.

538

Allowed values

539

1 - v1 error format

540

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

541

542

Returns:

543

An object of the form:

544

545

{

Yoshi Automation Bot

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

[diff] [blame]

546

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

547

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

551

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

552

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

553

554

Args:

555

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

Yoshi Automation Bot

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

[diff] [blame]

556

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

Yoshi Automation Bot

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

[diff] [blame]

557

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

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

Craig Citro

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

[diff] [blame]

562

563

Returns:

564

An object of the form:

565

566

{

Yoshi Automation Bot

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

[diff] [blame]

567

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

568

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

569

"resources": [

570

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

571

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

572

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

573

{

574

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

575

"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. Acceptable values are: - "`active`" - "`pending`"

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

576

},

Yoshi Automation Bot

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

[diff] [blame]

577

],

578

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

579

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

580

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

581

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

582

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

583

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

584

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

Yoshi Automation Bot

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

[diff] [blame]

585

},

Yoshi Automation Bot

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

[diff] [blame]

586

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

587

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

588

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

589

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

590

},

591

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

Yoshi Automation Bot

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

[diff] [blame]

592

},

Yoshi Automation Bot

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

[diff] [blame]

593

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

594

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

595

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

596

},

597

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

598

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

599

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

600

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

601

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

602

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

603

{

604

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

605

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

606

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

607

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

608

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

609

},

610

],

611

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

612

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

613

{

614

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

615

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

},

],

},

],

}</pre>

Craig Citro

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

[diff] [blame]

</div>

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

625

<pre>Retrieves the next page of results.

626

627

Args:

628

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

629

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

630

631

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

632

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

Craig Citro

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

[diff] [blame]

633

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]

638

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

639

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

640

641

Args:

Dan O'Meara

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

[diff] [blame]

642

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]

643

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

Dan O'Meara

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

[diff] [blame]

644

body: object, The request body.

Craig Citro

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

[diff] [blame]

645

The object takes the form of:

646

Dan O'Meara

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

[diff] [blame]

647

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

Yoshi Automation Bot

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

[diff] [blame]

648

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

649

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

650

{

651

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

652

"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. Acceptable values are: - "`active`" - "`pending`"

653

},

654

],

Yoshi Automation Bot

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

[diff] [blame]

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

},

663

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

664

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

665

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

666

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

667

},

668

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

669

},

670

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

671

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

672

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

673

},

674

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

675

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

676

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

677

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

678

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

679

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

680

{

681

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

682

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

683

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

684

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

685

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

686

},

687

],

688

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

689

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

690

{

691

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

692

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

693

},

694

],

Yoshi Automation Bot

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

[diff] [blame]

695

}

Craig Citro

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

[diff] [blame]

696

Bu Sun Kim

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

[diff] [blame]

697

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]

698

x__xgafv: string, V1 error format.

699

Allowed values

700

1 - v1 error format

701

2 - v2 error format

Craig Citro

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

[diff] [blame]

702

703

Returns:

704

An object of the form:

705

Dan O'Meara

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

[diff] [blame]

706

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

Yoshi Automation Bot

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

[diff] [blame]

707

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

708

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

709

{

710

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

711

"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. Acceptable values are: - "`active`" - "`pending`"

Yoshi Automation Bot

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

[diff] [blame]

712

},

Yoshi Automation Bot

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

[diff] [blame]

713

],

714

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

715

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

716

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

717

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

718

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

719

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

720

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

Yoshi Automation Bot

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

[diff] [blame]

721

},

Yoshi Automation Bot

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

[diff] [blame]

722

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

723

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

724

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

725

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

726

},

727

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

728

},

729

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

730

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

731

"status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"

732

},

733

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

734

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

735

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

736

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

737

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

738

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

739

{

740

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

741

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

742

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

743

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

744

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

745

},

746

],

747

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

748

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

749

{

750

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

751

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

752

},

753

],

754

}</pre>

Craig Citro