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

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

[diff] [blame]

127

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

Yoshi Automation Bot

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

[diff] [blame]

128

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

Nathaniel Manista

5cbe5ba

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

[diff] [blame]

129

},

130

],

Yoshi Automation Bot

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

[diff] [blame]

131

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

Nathaniel Manista

5cbe5ba

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

136

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

Bu Sun Kim

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

[diff] [blame]

137

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

Sai Cheemalapati

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

[diff] [blame]

138

139

Args:

Dan O'Meara

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

[diff] [blame]

140

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

Sai Cheemalapati

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

[diff] [blame]

141

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

Dan O'Meara

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

[diff] [blame]

142

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

Bu Sun Kim

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

[diff] [blame]

143

x__xgafv: string, V1 error format.

144

Allowed values

145

1 - v1 error format

146

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

147

148

Returns:

149

An object of the form:

150

151

{

Bu Sun Kim

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

[diff] [blame]

152

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

157

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

158

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

162

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

Craig Citro

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

[diff] [blame]

163

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

164

165

Args:

Dan O'Meara

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

[diff] [blame]

166

body: object, The request body.

Craig Citro

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

[diff] [blame]

167

The object takes the form of:

168

169

{

Bu Sun Kim

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

[diff] [blame]

170

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

Craig Citro

e633be1

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

[diff] [blame]

171

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

Yoshi Automation Bot

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

[diff] [blame]

172

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

Yoshi Automation Bot

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

[diff] [blame]

173

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

Bu Sun Kim

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

[diff] [blame]

174

"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-25 07:50:41 -0800

[diff] [blame]

175

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

176

{

177

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

178

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

Bu Sun Kim

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

[diff] [blame]

179

},

Yoshi Automation Bot

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

[diff] [blame]

180

],

Yoshi Automation Bot

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

[diff] [blame]

181

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

Yoshi Automation Bot

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

[diff] [blame]

182

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

183

{

184

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

185

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

186

},

187

],

188

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

189

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

190

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

191

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

192

{

193

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

194

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

195

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

196

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

197

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

198

},

199

],

Yoshi Automation Bot

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

[diff] [blame]

200

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

201

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

202

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

203

},

Yoshi Automation Bot

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

[diff] [blame]

204

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

Yoshi Automation Bot

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

[diff] [blame]

205

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

Yoshi Automation Bot

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

[diff] [blame]

206

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

Yoshi Automation Bot

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

[diff] [blame]

207

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

208

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

209

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

210

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

211

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

212

},

213

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

214

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

215

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

216

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

217

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

218

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

219

},

220

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

221

},

Yoshi Automation Bot

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

[diff] [blame]

222

},

Yoshi Automation Bot

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

[diff] [blame]

223

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

224

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

225

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

226

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

227

},

228

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

229

"A String",

230

],

231

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

Bu Sun Kim

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

[diff] [blame]

232

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

233

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

Yoshi Automation Bot

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

[diff] [blame]

234

"overwrite": True or False, # Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.

Craig Citro

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

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

239

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

Bu Sun Kim

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

[diff] [blame]

240

x__xgafv: string, V1 error format.

241

Allowed values

242

1 - v1 error format

243

2 - v2 error format

Craig Citro

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

[diff] [blame]

244

245

Returns:

246

An object of the form:

247

248

{

Yoshi Automation Bot

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

[diff] [blame]

249

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

Bu Sun Kim

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

[diff] [blame]

250

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

Craig Citro

e633be1

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

[diff] [blame]

251

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

Yoshi Automation Bot

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

[diff] [blame]

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

Yoshi Automation Bot

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

[diff] [blame]

254

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

255

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

256

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

257

{

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

},

261

],

Yoshi Automation Bot

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

[diff] [blame]

262

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

Yoshi Automation Bot

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

[diff] [blame]

263

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

264

{

265

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

266

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

267

},

268

],

269

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

270

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

271

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

272

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

273

{

274

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

275

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

276

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

277

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

278

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

279

},

280

],

Yoshi Automation Bot

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

[diff] [blame]

281

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

282

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

283

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

284

},

Yoshi Automation Bot

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

[diff] [blame]

285

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

Yoshi Automation Bot

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

[diff] [blame]

286

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

Yoshi Automation Bot

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

[diff] [blame]

287

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

Yoshi Automation Bot

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

[diff] [blame]

288

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

289

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

290

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

291

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

292

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

293

},

294

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

295

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

296

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

297

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

298

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

299

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

300

},

301

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

302

},

303

},

304

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

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

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

Bu Sun Kim

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

[diff] [blame]

314

},

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-25 07:50:41 -0800

[diff] [blame]

352

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

353

{

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

},

Yoshi Automation Bot

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

[diff] [blame]

357

],

Yoshi Automation Bot

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

[diff] [blame]

358

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

Yoshi Automation Bot

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

[diff] [blame]

359

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

360

{

361

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

362

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

363

},

364

],

365

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

366

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

367

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

368

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

369

{

370

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

371

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

372

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

373

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

374

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

375

},

376

],

Yoshi Automation Bot

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

[diff] [blame]

377

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

378

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

379

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

380

},

Yoshi Automation Bot

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

[diff] [blame]

381

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

Yoshi Automation Bot

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

[diff] [blame]

382

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

Yoshi Automation Bot

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

[diff] [blame]

383

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

Yoshi Automation Bot

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

[diff] [blame]

384

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

385

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

386

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

387

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

388

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

389

},

390

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

391

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

392

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

393

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

394

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

395

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

396

},

397

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

398

},

Yoshi Automation Bot

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

[diff] [blame]

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-25 07:50:41 -0800

[diff] [blame]

412

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

413

{

414

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

415

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

Bu Sun Kim

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

[diff] [blame]

416

},

Yoshi Automation Bot

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

[diff] [blame]

417

],

Yoshi Automation Bot

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

[diff] [blame]

418

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

Yoshi Automation Bot

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

[diff] [blame]

419

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

420

{

421

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

422

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

423

},

424

],

425

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

426

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

427

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

428

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

429

{

430

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

431

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

432

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

433

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

434

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

435

},

436

],

Yoshi Automation Bot

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

[diff] [blame]

437

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

438

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

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

},

Yoshi Automation Bot

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

[diff] [blame]

441

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

Yoshi Automation Bot

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

[diff] [blame]

442

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

Yoshi Automation Bot

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

[diff] [blame]

443

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

Yoshi Automation Bot

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

[diff] [blame]

444

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

445

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

446

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

447

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

448

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

449

},

450

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

451

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

452

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

453

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

454

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

455

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

456

},

457

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

458

},

Yoshi Automation Bot

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

[diff] [blame]

459

}

Craig Citro

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

[diff] [blame]

460

Bu Sun Kim

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

[diff] [blame]

461

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

Bu Sun Kim

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

[diff] [blame]

462

x__xgafv: string, V1 error format.

463

Allowed values

464

1 - v1 error format

465

2 - v2 error format

Craig Citro

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

[diff] [blame]

466

467

Returns:

468

An object of the form:

469

Dan O'Meara

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

[diff] [blame]

470

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

Yoshi Automation Bot

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

[diff] [blame]

471

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

472

{

473

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

474

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

Bu Sun Kim

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

[diff] [blame]

475

},

Yoshi Automation Bot

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

[diff] [blame]

476

],

Yoshi Automation Bot

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

[diff] [blame]

477

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

Yoshi Automation Bot

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

[diff] [blame]

478

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

479

{

480

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

481

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

482

},

483

],

484

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

485

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

486

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

487

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

488

{

489

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

490

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

491

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

492

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

493

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

494

},

495

],

Yoshi Automation Bot

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

[diff] [blame]

496

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

497

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

498

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

499

},

Yoshi Automation Bot

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

[diff] [blame]

500

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

Yoshi Automation Bot

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

[diff] [blame]

501

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

Yoshi Automation Bot

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

[diff] [blame]

502

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

Yoshi Automation Bot

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

[diff] [blame]

503

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

504

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

505

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

506

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

507

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

508

},

509

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

510

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

511

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

512

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

513

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

514

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

515

},

516

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

517

},

Yoshi Automation Bot

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

[diff] [blame]

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

{

Yoshi Automation Bot

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

[diff] [blame]

567

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

Bu Sun Kim

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

[diff] [blame]

568

"resources": [

Dan O'Meara

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

[diff] [blame]

569

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

Yoshi Automation Bot

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

[diff] [blame]

570

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

571

{

572

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

573

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

Bu Sun Kim

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

[diff] [blame]

574

},

Yoshi Automation Bot

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

[diff] [blame]

575

],

Yoshi Automation Bot

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

[diff] [blame]

576

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

Yoshi Automation Bot

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

[diff] [blame]

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

581

},

582

],

583

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

584

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

585

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

586

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

587

{

588

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

589

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

590

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

591

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

592

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

593

},

594

],

Yoshi Automation Bot

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

[diff] [blame]

595

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

596

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

597

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

598

},

Yoshi Automation Bot

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

[diff] [blame]

599

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

Yoshi Automation Bot

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

[diff] [blame]

600

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

Yoshi Automation Bot

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

[diff] [blame]

601

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

Yoshi Automation Bot

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

[diff] [blame]

602

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

603

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

604

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

605

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

606

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

607

},

608

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

609

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

610

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

611

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

612

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

613

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

614

},

615

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

616

},

Yoshi Automation Bot

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

[diff] [blame]

617

},

Craig Citro

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

[diff] [blame]

618

],

Yoshi Automation Bot

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

[diff] [blame]

619

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

Craig Citro

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

[diff] [blame]

}</pre>

</div>

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

625

<pre>Retrieves the next page of results.

626

627

Args:

628

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

629

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

630

631

Returns:

Bu Sun Kim

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

[diff] [blame]

632

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

Craig Citro

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

[diff] [blame]

633

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

638

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

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

639

<pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.

Craig Citro

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

[diff] [blame]

640

641

Args:

Dan O'Meara

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

[diff] [blame]

642

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

Craig Citro

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

[diff] [blame]

643

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

Dan O'Meara

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

[diff] [blame]

644

body: object, The request body.

Craig Citro

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

[diff] [blame]

645

The object takes the form of:

646

Dan O'Meara

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

[diff] [blame]

647

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

Yoshi Automation Bot

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

[diff] [blame]

648

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

649

{

650

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

651

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

Bu Sun Kim

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

[diff] [blame]

652

},

Yoshi Automation Bot

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

[diff] [blame]

653

],

Yoshi Automation Bot

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

[diff] [blame]

654

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

Yoshi Automation Bot

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

[diff] [blame]

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

],

661

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

662

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

663

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

664

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

665

{

666

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

667

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

668

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

669

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

670

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

671

},

672

],

Yoshi Automation Bot

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

[diff] [blame]

673

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

674

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

675

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

676

},

Yoshi Automation Bot

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

[diff] [blame]

677

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

Yoshi Automation Bot

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

[diff] [blame]

678

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

Yoshi Automation Bot

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

[diff] [blame]

679

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

Yoshi Automation Bot

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

[diff] [blame]

680

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

681

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

682

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

683

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

684

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

685

},

686

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

687

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

688

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

689

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

690

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

691

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

692

},

693

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

694

},

Yoshi Automation Bot

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

[diff] [blame]

695

}

Craig Citro

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

[diff] [blame]

696

Bu Sun Kim

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

[diff] [blame]

697

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

Bu Sun Kim

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

[diff] [blame]

698

x__xgafv: string, V1 error format.

699

Allowed values

700

1 - v1 error format

701

2 - v2 error format

Craig Citro

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

[diff] [blame]

702

703

Returns:

704

An object of the form:

705

Dan O'Meara

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

[diff] [blame]

706

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

Yoshi Automation Bot

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

[diff] [blame]

707

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

708

{

709

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

710

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

Bu Sun Kim

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

[diff] [blame]

711

},

Yoshi Automation Bot

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

[diff] [blame]

712

],

Yoshi Automation Bot

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

[diff] [blame]

713

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

Yoshi Automation Bot

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

[diff] [blame]

714

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

715

{

716

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

717

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

718

},

719

],

720

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

721

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

722

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

723

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

724

{

725

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

726

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

727

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

728

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

729

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

730

},

731

],

Yoshi Automation Bot

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

[diff] [blame]

732

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

733

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

734

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

735

},

Yoshi Automation Bot

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

[diff] [blame]

736

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

Yoshi Automation Bot

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

[diff] [blame]

737

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

Yoshi Automation Bot

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

[diff] [blame]

738

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

Yoshi Automation Bot

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

[diff] [blame]

739

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

740

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

741

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

742

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

743

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

744

},

745

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

746

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

747

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

748

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

749

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

750

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

751

},

752

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

753

},

Yoshi Automation Bot