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

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

[diff] [blame]

127

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

Yoshi Automation Bot

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

[diff] [blame]

128

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

Nathaniel Manista

5cbe5ba

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

[diff] [blame]

129

},

130

],

Yoshi Automation Bot

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

[diff] [blame]

131

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

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.

173

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

174

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

Yoshi Automation Bot

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

[diff] [blame^]

175

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

Yoshi Automation Bot

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

[diff] [blame]

176

},

Yoshi Automation Bot

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

[diff] [blame^]

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

},

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

},

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

},

204

},

205

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

206

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

207

{

208

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

209

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

210

},

211

],

212

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

213

{

214

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

215

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

216

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

217

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

218

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

219

},

220

],

221

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

222

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

223

{

224

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

225

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

},

],

},

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

230

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

Yoshi Automation Bot

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

[diff] [blame]

231

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

232

"A String",

233

],

234

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

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

{

Bu Sun Kim

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

[diff] [blame]

249

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

Craig Citro

e633be1

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

[diff] [blame]

250

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

Bu Sun Kim

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

[diff] [blame]

251

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

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

[diff] [blame^]

253

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

254

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

255

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

256

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

Bu Sun Kim

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

[diff] [blame]

257

},

Yoshi Automation Bot

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

[diff] [blame^]

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

},

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

},

Yoshi Automation Bot

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

[diff] [blame]

276

},

Yoshi Automation Bot

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

[diff] [blame^]

277

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

278

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

279

{

280

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

281

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

282

},

283

],

284

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

285

{

286

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

287

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

288

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

289

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

290

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

291

},

292

],

293

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

294

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

295

{

296

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

297

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

298

},

299

],

Yoshi Automation Bot

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

[diff] [blame]

300

},

Yoshi Automation Bot

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

[diff] [blame^]

301

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

302

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

Yoshi Automation Bot

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

[diff] [blame]

303

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

Yoshi Automation Bot

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

[diff] [blame]

304

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

305

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

Yoshi Automation Bot

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

[diff] [blame^]

306

"errors": [ # A list of errors.

307

{ # An error returned by the API.

308

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

309

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

310

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

311

},

312

],

Bu Sun Kim

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

[diff] [blame]

313

},

Craig Citro

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

[diff] [blame]

314

},

315

],

Yoshi Automation Bot

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

[diff] [blame^]

316

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

Craig Citro

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame^]

321

<code class="details" id="delete">delete(merchantId, accountId, force=None, dryRun=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-24 15:48:03 -0800

[diff] [blame]

327

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

Yoshi Automation Bot

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

[diff] [blame^]

328

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]

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

[diff] [blame^]

352

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

353

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

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

},

Yoshi Automation Bot

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

[diff] [blame^]

357

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

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

},

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

},

Yoshi Automation Bot

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

[diff] [blame]

375

},

Yoshi Automation Bot

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

[diff] [blame^]

376

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

377

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

378

{

379

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

380

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

381

},

382

],

383

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

384

{

385

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

386

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

387

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

388

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

389

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

390

},

391

],

392

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

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

[diff] [blame^]

412

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

413

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

414

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

415

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

Bu Sun Kim

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

[diff] [blame]

416

},

Yoshi Automation Bot

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

[diff] [blame^]

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

},

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

},

Yoshi Automation Bot

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

[diff] [blame]

435

},

Yoshi Automation Bot

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

[diff] [blame^]

436

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

437

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

438

{

439

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

440

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

441

},

442

],

443

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

444

{

445

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

446

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

447

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

448

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

449

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

450

},

451

],

452

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

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

],

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

[diff] [blame^]

471

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

472

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

473

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

474

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

Bu Sun Kim

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

[diff] [blame]

475

},

Yoshi Automation Bot

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

[diff] [blame^]

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

},

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

},

Yoshi Automation Bot

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

[diff] [blame]

494

},

Yoshi Automation Bot

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

[diff] [blame^]

495

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

496

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

497

{

498

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

499

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

500

},

501

],

502

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

503

{

504

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

505

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

506

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

507

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

508

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

509

},

510

],

511

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

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

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

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

534

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

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

Bu Sun Kim

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

[diff] [blame]

556

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

Yoshi Automation Bot

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

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

Bu Sun Kim

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

[diff] [blame]

568

"resources": [

Dan O'Meara

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

[diff] [blame]

569

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

[diff] [blame^]

570

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

571

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

572

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

573

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

Bu Sun Kim

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

[diff] [blame]

574

},

Yoshi Automation Bot

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

[diff] [blame^]

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

},

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

},

Yoshi Automation Bot

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

[diff] [blame]

593

},

Yoshi Automation Bot

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

[diff] [blame^]

594

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

595

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

596

{

597

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

598

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

599

},

600

],

601

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

602

{

603

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

604

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

605

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

606

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

607

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

608

},

609

],

610

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

611

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

612

{

613

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

614

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

615

},

616

],

Yoshi Automation Bot

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

[diff] [blame]

617

},

Craig Citro

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

[diff] [blame]

618

],

Yoshi Automation Bot

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

[diff] [blame]

619

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

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

[diff] [blame^]

648

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

649

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

650

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

651

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

Bu Sun Kim

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

[diff] [blame]

652

},

Yoshi Automation Bot

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

[diff] [blame^]

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

},

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

},

Yoshi Automation Bot

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

[diff] [blame]

671

},

Yoshi Automation Bot

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

[diff] [blame^]

672

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

673

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

674

{

675

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

676

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

677

},

678

],

679

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

680

{

681

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

682

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

683

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

684

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

685

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

686

},

687

],

688

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

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

],

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

[diff] [blame^]

707

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

708

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

709

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

710

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

Bu Sun Kim

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

[diff] [blame]

711

},

Yoshi Automation Bot

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

[diff] [blame^]

712

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

713

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

714

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

715

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

716

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

717

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

718

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

719

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

720

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

721

},

722

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

723

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

724

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

725

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

726

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

727

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

728

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

729

},

Yoshi Automation Bot

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

[diff] [blame]

730

},

Yoshi Automation Bot

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

[diff] [blame^]

731

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

732

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

733

{

734

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

735

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

736

},

737

],

738

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

739

{

740

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

741

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

742

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

743

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

744

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

745

},

746

],

747

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

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