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

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

[diff] [blame]

127

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

Yoshi Automation Bot

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

[diff] [blame^]

128

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

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-24 15:48:03 -0800

[diff] [blame^]

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

},

Dmitry Frenkel

3e17f89

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

[diff] [blame]

181

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

182

"A String",

183

],

Bu Sun Kim

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

[diff] [blame]

184

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

Yoshi Automation Bot

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

[diff] [blame^]

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

Bu Sun Kim

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

[diff] [blame]

193

},

Yoshi Automation Bot

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

[diff] [blame^]

194

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

195

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

196

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

197

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

198

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

199

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

Bu Sun Kim

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

[diff] [blame]

200

},

Yoshi Automation Bot

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

[diff] [blame^]

201

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

Bu Sun Kim

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

[diff] [blame]

202

},

Yoshi Automation Bot

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

[diff] [blame^]

203

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

204

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

205

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

206

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

207

},

208

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

209

{

210

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

211

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

212

},

213

],

214

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

215

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

216

{

217

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

218

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

219

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

220

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

221

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

222

},

223

],

224

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

225

{

226

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

227

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

228

},

229

],

230

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

231

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

232

},

Bu Sun Kim

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

[diff] [blame]

233

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

234

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

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.

252

"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-24 15:48:03 -0800

[diff] [blame^]

253

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

Bu Sun Kim

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

[diff] [blame]

254

"errors": [ # A list of errors.

255

{ # An error returned by the API.

Yoshi Automation Bot

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

[diff] [blame^]

256

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

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

Bu Sun Kim

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

[diff] [blame]

259

},

260

],

261

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

Yoshi Automation Bot

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

[diff] [blame^]

262

},

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

},

275

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

276

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

277

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

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

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

280

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

281

},

282

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

283

},

284

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

285

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

286

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

287

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

288

},

289

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

290

{

291

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

292

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

293

},

294

],

295

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

296

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

297

{

298

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

299

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

300

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

301

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

302

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

303

},

304

],

305

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

306

{

307

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

308

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

309

},

310

],

311

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

312

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

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

],

Bu Sun Kim

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

[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-24 15:48: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)

Bu Sun Kim

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

[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-11-24 15:48: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-11-24 15:48:03 -0800

[diff] [blame^]

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

},

Yoshi Automation Bot

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

[diff] [blame^]

361

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

362

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

363

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

364

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

365

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

366

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

Bu Sun Kim

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

[diff] [blame]

367

},

Yoshi Automation Bot

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

[diff] [blame^]

368

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

369

},

370

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

371

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

372

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

373

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

374

},

375

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

376

{

377

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

378

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

379

},

380

],

381

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

382

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

383

{

384

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

385

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

386

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

387

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

388

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

389

},

390

],

391

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

392

{

393

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

394

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

395

},

396

],

397

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

398

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

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-24 15:48:03 -0800

[diff] [blame^]

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

Bu Sun Kim

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

[diff] [blame]

420

},

Yoshi Automation Bot

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

[diff] [blame^]

421

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

422

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

423

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

424

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

425

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

426

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

Bu Sun Kim

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

[diff] [blame]

427

},

Yoshi Automation Bot

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

[diff] [blame^]

428

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

429

},

430

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

431

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

432

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

433

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

434

},

435

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

436

{

437

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

438

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

439

},

440

],

441

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

442

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

443

{

444

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

445

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

446

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

447

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

448

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

449

},

450

],

451

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

452

{

453

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

454

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

455

},

456

],

457

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

458

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

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-24 15:48:03 -0800

[diff] [blame^]

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

Bu Sun Kim

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

[diff] [blame]

479

},

Yoshi Automation Bot

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

[diff] [blame^]

480

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

481

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

482

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

483

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

484

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

485

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

Bu Sun Kim

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

[diff] [blame]

486

},

Yoshi Automation Bot

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

[diff] [blame^]

487

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

488

},

489

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

490

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

491

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

492

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

493

},

494

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

495

{

496

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

497

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

498

},

499

],

500

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

501

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

502

{

503

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

504

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

505

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

506

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

507

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

508

},

509

],

510

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

511

{

512

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

513

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

514

},

515

],

516

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

517

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

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

{

Bu Sun Kim

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

[diff] [blame]

532

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

Yoshi Automation Bot

2020-11-24 15:48: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

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

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>

Bu Sun Kim

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

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

Bu Sun Kim

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

[diff] [blame]

556

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

Bu Sun Kim

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

[diff] [blame]

557

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

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

{

Bu Sun Kim

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

[diff] [blame]

567

"resources": [

Dan O'Meara

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

[diff] [blame]

568

{ # 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-24 15:48:03 -0800

[diff] [blame^]

569

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

570

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

571

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

572

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

573

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

574

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

575

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

576

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

Bu Sun Kim

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

[diff] [blame]

577

},

Yoshi Automation Bot

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

[diff] [blame^]

578

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

579

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

580

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

581

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

582

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

583

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

Bu Sun Kim

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

[diff] [blame]

584

},

Yoshi Automation Bot

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

[diff] [blame^]

585

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

Craig Citro

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

[diff] [blame]

586

},

Yoshi Automation Bot

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

[diff] [blame^]

587

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

588

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

589

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

590

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

591

},

592

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

593

{

594

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

595

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

596

},

597

],

598

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

599

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

600

{

601

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

602

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

603

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

604

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

605

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

606

},

607

],

608

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

609

{

610

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

611

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

612

},

613

],

614

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

615

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

616

},

Craig Citro

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

[diff] [blame]

617

],

Yoshi Automation Bot

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

[diff] [blame^]

618

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

Bu Sun Kim

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

[diff] [blame]

619

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

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-24 15:48:03 -0800

[diff] [blame^]

648

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

649

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

650

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

651

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

652

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

653

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

654

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

655

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

Bu Sun Kim

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

[diff] [blame]

656

},

Yoshi Automation Bot

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

[diff] [blame^]

657

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

658

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

659

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

660

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

661

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

662

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

Bu Sun Kim

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

[diff] [blame]

663

},

Yoshi Automation Bot

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

[diff] [blame^]

664

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

665

},

666

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

667

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

668

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

669

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

670

},

671

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

672

{

673

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

674

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

675

},

676

],

677

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

678

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

679

{

680

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

681

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

682

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

683

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

684

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

685

},

686

],

687

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

688

{

689

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

690

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

691

},

692

],

693

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

694

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

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-24 15:48:03 -0800

[diff] [blame^]

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

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

Bu Sun Kim

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

[diff] [blame]

715

},

Yoshi Automation Bot

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

[diff] [blame^]

716

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

717

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

718

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

719

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

720

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

721

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

Bu Sun Kim

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

[diff] [blame]

722

},

Yoshi Automation Bot