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

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

[diff] [blame]

137

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

Sai Cheemalapati

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

[diff] [blame]

138

139

Args:

Dan O'Meara

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

[diff] [blame]

140

merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)

Sai Cheemalapati

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

[diff] [blame]

141

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

Dan O'Meara

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

[diff] [blame]

142

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

Bu Sun Kim

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

[diff] [blame]

143

x__xgafv: string, V1 error format.

144

Allowed values

145

1 - v1 error format

146

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

147

148

Returns:

149

An object of the form:

150

151

{

Yoshi Automation Bot

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

[diff] [blame]

152

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

153

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

157

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

158

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

162

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

Craig Citro

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

[diff] [blame]

163

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

164

165

Args:

Dan O'Meara

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

[diff] [blame]

166

body: object, The request body.

Craig Citro

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

[diff] [blame]

167

The object takes the form of:

168

169

{

Yoshi Automation Bot

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

[diff] [blame]

170

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

171

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

172

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

173

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

174

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

175

{

176

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

177

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

178

},

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

179

],

Yoshi Automation Bot

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

[diff] [blame]

180

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

181

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

182

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

183

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

184

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

185

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

186

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

Yoshi Automation Bot

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

[diff] [blame]

187

},

Yoshi Automation Bot

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

[diff] [blame]

188

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

189

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

190

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

191

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

Yoshi Automation Bot

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

[diff] [blame]

192

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

193

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

194

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

Yoshi Automation Bot

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

[diff] [blame]

195

},

Yoshi Automation Bot

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

[diff] [blame]

196

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

197

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

198

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

199

},

200

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

201

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

202

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

203

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

204

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

205

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

206

{

207

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

208

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

209

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

210

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

211

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

212

},

213

],

214

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

215

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

216

{

217

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

218

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

219

},

220

],

Craig Citro

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

[diff] [blame]

221

},

Yoshi Automation Bot

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

[diff] [blame]

222

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

223

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

224

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

225

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

226

"A String",

227

],

228

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

229

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

230

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

231

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

232

},

233

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

234

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

235

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

236

},

237

],

238

}

Craig Citro

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

[diff] [blame]

239

Bu Sun Kim

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

[diff] [blame]

240

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]

241

x__xgafv: string, V1 error format.

242

Allowed values

243

1 - v1 error format

244

2 - v2 error format

Craig Citro

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

[diff] [blame]

245

246

Returns:

247

An object of the form:

248

249

{

Yoshi Automation Bot

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

[diff] [blame]

250

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

251

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

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

253

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

254

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

255

{

256

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

257

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

258

},

Yoshi Automation Bot

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

[diff] [blame]

259

],

260

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

261

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

262

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

263

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

264

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

265

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

266

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

Yoshi Automation Bot

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

[diff] [blame]

267

},

Yoshi Automation Bot

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

[diff] [blame]

268

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

269

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

270

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

271

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

272

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

273

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

274

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

Bu Sun Kim

6502091

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

[diff] [blame]

275

},

Yoshi Automation Bot

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

[diff] [blame]

276

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

277

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

278

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

Yoshi Automation Bot

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

[diff] [blame]

279

},

Yoshi Automation Bot

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

[diff] [blame]

280

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

281

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

282

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

283

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

284

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

285

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

286

{

287

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

288

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

289

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

290

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

291

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

292

},

293

],

294

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

295

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

296

{

297

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

298

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

299

},

300

],

Craig Citro

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

[diff] [blame]

301

},

Yoshi Automation Bot

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

[diff] [blame]

302

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

303

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

304

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

305

"errors": [ # A list of errors.

306

{ # An error returned by the API.

307

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

308

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

309

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

310

},

311

],

312

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

313

},

314

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

315

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

316

},

317

],

318

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

319

}</pre>

Craig Citro

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

323

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

324

<pre>Deletes a Merchant Center sub-account.

Craig Citro

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

[diff] [blame]

325

326

Args:

Bu Sun Kim

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

[diff] [blame]

327

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]

328

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

Yoshi Automation Bot

b6971b0

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

[diff] [blame]

329

dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Yoshi Automation Bot

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

[diff] [blame]

330

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]

331

x__xgafv: string, V1 error format.

332

Allowed values

333

1 - v1 error format

334

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]

339

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

Bu Sun Kim

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

[diff] [blame]

340

<pre>Retrieves a Merchant Center account.

Craig Citro

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

[diff] [blame]

341

342

Args:

Dan O'Meara

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

[diff] [blame]

343

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]

344

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

Bu Sun Kim

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

[diff] [blame]

345

x__xgafv: string, V1 error format.

346

Allowed values

347

1 - v1 error format

348

2 - v2 error format

Craig Citro

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

[diff] [blame]

349

350

Returns:

351

An object of the form:

352

Dan O'Meara

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

[diff] [blame]

353

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

Yoshi Automation Bot

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

[diff] [blame]

354

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

355

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

356

{

357

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

358

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

Yoshi Automation Bot

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

[diff] [blame]

359

},

Yoshi Automation Bot

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

[diff] [blame]

360

],

361

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

362

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

363

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

364

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

365

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

366

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

367

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

Yoshi Automation Bot

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

[diff] [blame]

368

},

Yoshi Automation Bot

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

[diff] [blame]

369

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

370

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

371

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

372

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

373

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

374

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

375

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

376

},

377

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

378

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

379

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

380

},

381

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

382

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

383

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

384

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

385

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

386

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

387

{

388

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

389

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

390

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

391

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

392

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

393

},

394

],

395

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

396

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

397

{

398

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

399

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

400

},

401

],

402

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

406

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

407

<pre>Creates a Merchant Center sub-account.

Craig Citro

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

[diff] [blame]

408

409

Args:

Bu Sun Kim

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

[diff] [blame]

410

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]

411

body: object, The request body.

Craig Citro

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

[diff] [blame]

412

The object takes the form of:

413

Dan O'Meara

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

[diff] [blame]

414

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

Yoshi Automation Bot

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

[diff] [blame]

415

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

416

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

417

{

418

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

419

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

420

},

421

],

Yoshi Automation Bot

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

[diff] [blame]

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

},

430

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

431

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

432

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

433

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

434

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

435

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

436

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

437

},

438

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

439

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

440

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

441

},

442

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

443

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

444

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

445

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

446

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

447

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

448

{

449

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

450

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

451

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

452

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

453

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

454

},

455

],

456

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

457

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

458

{

459

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

460

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

461

},

462

],

Yoshi Automation Bot

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

[diff] [blame]

463

}

Craig Citro

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

[diff] [blame]

464

Bu Sun Kim

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

[diff] [blame]

465

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]

466

x__xgafv: string, V1 error format.

467

Allowed values

468

1 - v1 error format

469

2 - v2 error format

Craig Citro

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

[diff] [blame]

470

471

Returns:

472

An object of the form:

473

Dan O'Meara

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

[diff] [blame]

474

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

Yoshi Automation Bot

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

[diff] [blame]

475

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

476

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

477

{

478

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

479

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

Yoshi Automation Bot

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

[diff] [blame]

480

},

Yoshi Automation Bot

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

[diff] [blame]

481

],

482

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

483

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

484

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

485

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

486

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

487

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

488

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

Yoshi Automation Bot

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

[diff] [blame]

489

},

Yoshi Automation Bot

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

[diff] [blame]

490

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

491

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

492

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

493

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

494

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

495

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

496

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

497

},

498

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

499

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

500

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

501

},

502

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

503

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

504

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

505

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

506

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

507

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

508

{

509

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

510

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

511

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

512

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

513

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

514

},

515

],

516

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

517

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

518

{

519

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

520

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

521

},

522

],

523

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

527

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

528

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

529

530

Args:

Dan O'Meara

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

[diff] [blame]

531

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]

532

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

Dan O'Meara

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

[diff] [blame]

533

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

534

The object takes the form of:

535

536

{

Yoshi Automation Bot

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

[diff] [blame]

537

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

538

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

539

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

540

}

Bu Sun Kim

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

[diff] [blame]

541

Bu Sun Kim

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

[diff] [blame]

542

x__xgafv: string, V1 error format.

543

Allowed values

544

1 - v1 error format

545

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

546

547

Returns:

548

An object of the form:

549

550

{

Yoshi Automation Bot

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

[diff] [blame]

551

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

552

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

556

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

557

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

558

559

Args:

560

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

Yoshi Automation Bot

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

[diff] [blame]

561

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

Yoshi Automation Bot

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

[diff] [blame]

562

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

Bu Sun Kim

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

[diff] [blame]

563

x__xgafv: string, V1 error format.

564

Allowed values

565

1 - v1 error format

566

2 - v2 error format

Craig Citro

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

[diff] [blame]

567

568

Returns:

569

An object of the form:

570

571

{

Yoshi Automation Bot

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

[diff] [blame]

572

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

573

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

574

"resources": [

575

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

576

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

577

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

578

{

579

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

580

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

581

},

Yoshi Automation Bot

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

[diff] [blame]

582

],

583

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

584

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

585

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

586

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

587

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

588

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

589

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

Yoshi Automation Bot

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

[diff] [blame]

590

},

Yoshi Automation Bot

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

[diff] [blame]

591

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

592

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

593

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

594

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

595

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

596

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

597

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

Yoshi Automation Bot

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

[diff] [blame]

598

},

Yoshi Automation Bot

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

[diff] [blame]

599

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

600

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

601

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

602

},

603

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

604

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

605

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

606

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

607

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

608

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

609

{

610

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

611

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

612

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

613

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

614

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

615

},

616

],

617

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

618

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

619

{

620

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

621

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

},

],

},

],

}</pre>

Craig Citro

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

[diff] [blame]

</div>

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

631

<pre>Retrieves the next page of results.

632

633

Args:

634

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

635

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

636

637

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

638

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

Craig Citro

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

[diff] [blame]

639

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]

644

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

645

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

646

647

Args:

Dan O'Meara

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

[diff] [blame]

648

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]

649

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

Dan O'Meara

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

[diff] [blame]

650

body: object, The request body.

Craig Citro

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

[diff] [blame]

651

The object takes the form of:

652

Dan O'Meara

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

[diff] [blame]

653

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

Yoshi Automation Bot

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

[diff] [blame]

654

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

655

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

656

{

657

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

658

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

659

},

660

],

Yoshi Automation Bot

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

[diff] [blame]

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

},

669

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

670

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

671

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

672

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

673

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

674

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

675

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

676

},

677

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

678

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

679

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

680

},

681

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

682

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

683

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

684

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

685

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

686

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

687

{

688

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

689

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

690

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

691

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

692

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

693

},

694

],

695

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

696

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

697

{

698

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

699

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

700

},

701

],

Yoshi Automation Bot

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

[diff] [blame]

702

}

Craig Citro

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

[diff] [blame]

703

Bu Sun Kim

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

[diff] [blame]

704

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]

705

x__xgafv: string, V1 error format.

706

Allowed values

707

1 - v1 error format

708

2 - v2 error format

Craig Citro

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

[diff] [blame]

709

710

Returns:

711

An object of the form:

712

Dan O'Meara

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

[diff] [blame]

713

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

Yoshi Automation Bot

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

[diff] [blame]

714

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

715

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

716

{

717

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

718

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

Yoshi Automation Bot

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

[diff] [blame]

719

},

Yoshi Automation Bot

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

[diff] [blame]

720

],

721

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

722

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

723

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

724

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

725

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

726

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

727

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

Yoshi Automation Bot

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

[diff] [blame]

728

},

Yoshi Automation Bot

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

[diff] [blame]

729

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

730

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

731

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

732

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

733

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

734

"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.

Yoshi Automation Bot

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

[diff] [blame]

735

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

736

},

737

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

738

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

739

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

740

},

741

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

742

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

743

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

744

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

745

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

746

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

747

{

748

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

749

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

750

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

751

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

752

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

753

},

754

],

755

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

756

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

757

{

758

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

759

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

760

},

761

],

762

}</pre>

Craig Citro