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

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

[diff] [blame]

128

"merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.

Yoshi Automation Bot

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

[diff] [blame^]

129

"aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).

Nathaniel Manista

5cbe5ba

2015-03-10 23:29:22 +0000

[diff] [blame]

},

],

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

136

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

Bu Sun Kim

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

{

Bu Sun Kim

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

[diff] [blame]

152

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

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

{

Bu Sun Kim

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

[diff] [blame]

170

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

Craig Citro

e633be1

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

[diff] [blame]

171

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

Yoshi Automation Bot

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

[diff] [blame]

172

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

Yoshi Automation Bot

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

[diff] [blame]

173

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

Yoshi Automation Bot

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

[diff] [blame^]

174

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

175

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

Yoshi Automation Bot

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

[diff] [blame]

176

},

Yoshi Automation Bot

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

[diff] [blame^]

177

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

Yoshi Automation Bot

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

[diff] [blame]

178

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

Yoshi Automation Bot

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

[diff] [blame]

179

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

180

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

Yoshi Automation Bot

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

[diff] [blame]

181

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

182

"A String",

183

],

Yoshi Automation Bot

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

[diff] [blame^]

184

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

185

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

186

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

187

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

188

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

189

{

190

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

191

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

192

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

193

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

194

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

195

},

196

],

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

},

207

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

208

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

209

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

210

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

211

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

212

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

213

},

214

},

215

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

216

{

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

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

219

},

220

],

221

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

222

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

223

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

224

},

225

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

226

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

227

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

228

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

229

{

230

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

231

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

232

},

233

],

234

},

Craig Citro

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

[diff] [blame]

},

],

}

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

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

[diff] [blame^]

249

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

Bu Sun Kim

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

[diff] [blame]

250

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

Craig Citro

e633be1

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

[diff] [blame]

251

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

Yoshi Automation Bot

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

[diff] [blame]

252

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

Yoshi Automation Bot

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

[diff] [blame^]

253

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

254

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

255

{

256

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

257

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

258

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

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

},

Yoshi Automation Bot

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

[diff] [blame^]

262

],

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

Yoshi Automation Bot

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

[diff] [blame]

272

},

Yoshi Automation Bot

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

[diff] [blame^]

273

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

274

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

275

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

276

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

277

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

278

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

279

},

Yoshi Automation Bot

c2228be

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

[diff] [blame]

280

},

Yoshi Automation Bot

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

[diff] [blame^]

281

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

282

{

283

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

284

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

285

},

286

],

287

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

288

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

289

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

290

},

291

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

292

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

293

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

294

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

295

{

296

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

297

"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-11-26 17:16:03 -0800

[diff] [blame]

298

},

299

],

Bu Sun Kim

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

[diff] [blame]

300

},

Yoshi Automation Bot

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

[diff] [blame^]

301

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

302

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

303

"errors": [ # A list of errors.

304

{ # An error returned by the API.

305

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

306

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

307

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

308

},

309

],

310

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

311

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

312

},

313

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

314

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

Craig Citro

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

[diff] [blame]

},

],

}</pre>

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

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

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

[diff] [blame^]

352

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

353

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

354

{

355

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

356

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

357

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

358

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

},

Yoshi Automation Bot

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

[diff] [blame^]

361

],

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

Yoshi Automation Bot

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

[diff] [blame]

371

},

Yoshi Automation Bot

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

[diff] [blame^]

372

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

373

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

374

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

375

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

376

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

377

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

378

},

379

},

380

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

381

{

382

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

383

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

384

},

385

],

386

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

387

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

388

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

389

},

390

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

391

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

392

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

393

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

394

{

395

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

396

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

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

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

413

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

414

{

415

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

416

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

417

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

418

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

419

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

Bu Sun Kim

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

[diff] [blame]

420

},

Yoshi Automation Bot

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

[diff] [blame^]

421

],

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

Yoshi Automation Bot

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

[diff] [blame]

431

},

Yoshi Automation Bot

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

[diff] [blame^]

432

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

433

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

434

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

435

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

436

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

437

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

438

},

439

},

440

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

441

{

442

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

443

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

444

},

445

],

446

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

447

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

448

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

449

},

450

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

451

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

452

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

453

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

454

{

455

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

456

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

457

},

458

],

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

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

[diff] [blame^]

471

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

472

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

473

{

474

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

475

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

476

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

477

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

478

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

Bu Sun Kim

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

[diff] [blame]

479

},

Yoshi Automation Bot

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

[diff] [blame^]

480

],

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

Yoshi Automation Bot

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

[diff] [blame]

490

},

Yoshi Automation Bot

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

[diff] [blame^]

491

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

492

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

493

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

494

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

495

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

496

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

497

},

498

},

499

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

500

{

501

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

502

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

503

},

504

],

505

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

506

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

507

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

508

},

509

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

510

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

511

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

512

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

513

{

514

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

515

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

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

c2228be

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

[diff] [blame]

532

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

Yoshi Automation Bot

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

[diff] [blame]

533

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

Yoshi Automation Bot

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

[diff] [blame^]

534

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

Bu Sun Kim

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

[diff] [blame]

535

}

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

{

Bu Sun Kim

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

[diff] [blame]

546

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

Yoshi Automation Bot

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

[diff] [blame^]

551

<code class="details" id="list">list(merchantId, pageToken=None, maxResults=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-11-26 17:16:03 -0800

[diff] [blame]

556

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

Yoshi Automation Bot

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

[diff] [blame^]

557

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

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

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

[diff] [blame]

567

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

Yoshi Automation Bot

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

[diff] [blame^]

568

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

Bu Sun Kim

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

[diff] [blame]

569

"resources": [

Dan O'Meara

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

[diff] [blame]

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.

Yoshi Automation Bot

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

[diff] [blame^]

571

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

572

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

573

{

574

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

575

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

576

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

577

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

578

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

Bu Sun Kim

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

[diff] [blame]

579

},

Yoshi Automation Bot

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

[diff] [blame^]

580

],

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

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

Yoshi Automation Bot

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

[diff] [blame]

590

},

Yoshi Automation Bot

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

[diff] [blame^]

591

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

592

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

593

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

594

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

595

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

596

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

597

},

Yoshi Automation Bot

c2228be

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

[diff] [blame]

598

},

Yoshi Automation Bot

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

[diff] [blame^]

599

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

600

{

601

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

602

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

603

},

604

],

605

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

606

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

607

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

608

},

609

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

610

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

611

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

612

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

613

{

614

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

615

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

616

},

617

],

618

},

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>

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

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

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

649

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

650

{

651

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

652

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

653

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

654

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

655

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

Bu Sun Kim

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

[diff] [blame]

656

},

Yoshi Automation Bot

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

[diff] [blame^]

657

],

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

Yoshi Automation Bot

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

[diff] [blame]

667

},

Yoshi Automation Bot

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

[diff] [blame^]

668

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

669

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

670

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

671

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

672

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

673

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

674

},

675

},

676

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

677

{

678

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

679

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

680

},

681

],

682

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

683

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

684

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

685

},

686

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

687

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

688

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

689

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

690

{

691

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

692

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

693

},

694

],

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

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

[diff] [blame^]

707

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

708

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

709

{

710

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

711

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

712

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

713

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

714

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

Bu Sun Kim

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

[diff] [blame]

715

},

Yoshi Automation Bot

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

[diff] [blame^]

716

],

717

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

718

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

719

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

720

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

721

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

722

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

723

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

724

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

725

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

Yoshi Automation Bot

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

[diff] [blame]

726

},

Yoshi Automation Bot

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

[diff] [blame^]

727

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

728

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

729

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

730

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

731

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

732

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

733

},

734

},

735

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

736

{

737

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

738

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

739

},

740

],

741

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

742

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

743

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

744

},

745

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

746

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

747

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

748

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

749

{

750

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

751

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

752

},

753

],

754

}</pre>

Craig Citro