1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.accounts.html">accounts</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="content_v2_1.accounts.credentials.html">credentials()</a></code> 79</p> 80<p class="firstline">Returns the credentials Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="content_v2_1.accounts.labels.html">labels()</a></code> 84</p> 85<p class="firstline">Returns the labels Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="content_v2_1.accounts.returncarrier.html">returncarrier()</a></code> 89</p> 90<p class="firstline">Returns the returncarrier Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="#authinfo">authinfo(x__xgafv=None)</a></code></p> 94<p class="firstline">Returns information about the authenticated user.</p> 95<p class="toc_element"> 96 <code><a href="#claimwebsite">claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Claims the website of a Merchant Center sub-account.</p> 98<p class="toc_element"> 99 <code><a href="#close">close()</a></code></p> 100<p class="firstline">Close httplib2 connections.</p> 101<p class="toc_element"> 102 <code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p> 104<p class="toc_element"> 105 <code><a href="#delete">delete(merchantId, accountId, force=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Deletes a Merchant Center sub-account.</p> 107<p class="toc_element"> 108 <code><a href="#get">get(merchantId, accountId, view=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Retrieves a Merchant Center account.</p> 110<p class="toc_element"> 111 <code><a href="#insert">insert(merchantId, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Creates a Merchant Center sub-account.</p> 113<p class="toc_element"> 114 <code><a href="#link">link(merchantId, accountId, body=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.</p> 116<p class="toc_element"> 117 <code><a href="#list">list(merchantId, label=None, maxResults=None, name=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Lists the sub-accounts in your Merchant Center account.</p> 119<p class="toc_element"> 120 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 121<p class="firstline">Retrieves the next page of results.</p> 122<p class="toc_element"> 123 <code><a href="#listlinks">listlinks(merchantId, accountId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Returns the list of accounts linked to your Merchant Center account.</p> 125<p class="toc_element"> 126 <code><a href="#listlinks_next">listlinks_next(previous_request, previous_response)</a></code></p> 127<p class="firstline">Retrieves the next page of results.</p> 128<p class="toc_element"> 129 <code><a href="#requestphoneverification">requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)</a></code></p> 130<p class="firstline">Request verification code to start phone verification.</p> 131<p class="toc_element"> 132 <code><a href="#update">update(merchantId, accountId, body=None, x__xgafv=None)</a></code></p> 133<p class="firstline">Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.</p> 134<p class="toc_element"> 135 <code><a href="#updatelabels">updatelabels(merchantId, accountId, body=None, x__xgafv=None)</a></code></p> 136<p class="firstline">Updates labels that are assigned to the Merchant Center account by CSS user.</p> 137<p class="toc_element"> 138 <code><a href="#verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</a></code></p> 139<p class="firstline">Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. Only verified phone number will replace an existing verified phone number.</p> 140<h3>Method Details</h3> 141<div class="method"> 142 <code class="details" id="authinfo">authinfo(x__xgafv=None)</code> 143 <pre>Returns information about the authenticated user. 144 145Args: 146 x__xgafv: string, V1 error format. 147 Allowed values 148 1 - v1 error format 149 2 - v2 error format 150 151Returns: 152 An object of the form: 153 154 { 155 "accountIdentifiers": [ # The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. 156 { 157 "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount). 158 "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts. 159 }, 160 ], 161 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsAuthInfoResponse`". 162}</pre> 163</div> 164 165<div class="method"> 166 <code class="details" id="claimwebsite">claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)</code> 167 <pre>Claims the website of a Merchant Center sub-account. 168 169Args: 170 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) 171 accountId: string, The ID of the account whose website is claimed. (required) 172 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. 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { 182 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsClaimWebsiteResponse`". 183}</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="close">close()</code> 188 <pre>Close httplib2 connections.</pre> 189</div> 190 191<div class="method"> 192 <code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code> 193 <pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. 194 195Args: 196 body: object, The request body. 197 The object takes the form of: 198 199{ 200 "entries": [ # The request entries to be processed in the batch. 201 { # A batch entry encoding a single non-batch accounts request. 202 "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`. 203 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 204 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 205 { 206 "adsId": "A String", # Customer ID of the Ads account. 207 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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`" 208 }, 209 ], 210 "adultContent": True or False, # Indicates whether the merchant sells adult content. 211 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 212 "A String", 213 ], 214 "businessInformation": { # The business information of the account. 215 "address": { # The address of the business. 216 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 217 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 218 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 219 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 220 "streetAddress": "A String", # Street-level part of the address. 221 }, 222 "customerService": { # The customer service information of the business. 223 "email": "A String", # Customer service email. 224 "phoneNumber": "A String", # Customer service phone number. 225 "url": "A String", # Customer service URL. 226 }, 227 "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. 228 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 229 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 230 }, 231 "cssId": "A String", # ID of CSS the account belongs to. 232 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 233 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 234 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 235 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 236 }, 237 "id": "A String", # Required for update. Merchant Center account ID. 238 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 239 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 240 "A String", 241 ], 242 "name": "A String", # Required. Display name for the account. 243 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. 244 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. 245 { 246 "admin": True or False, # Whether user is an admin. 247 "emailAddress": "A String", # User's email address. 248 "orderManager": True or False, # Whether user is an order manager. 249 "paymentsAnalyst": True or False, # Whether user can access payment statements. 250 "paymentsManager": True or False, # Whether user can manage payment settings. 251 }, 252 ], 253 "websiteUrl": "A String", # The merchant's website. 254 "youtubeChannelLinks": [ # 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. 255 { 256 "channelId": "A String", # Channel ID. 257 "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. 258 }, 259 ], 260 }, 261 "accountId": "A String", # The ID of the targeted account. Only defined if the method is not `insert`. 262 "batchId": 42, # An entry ID, unique within the batch request. 263 "force": True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`. 264 "labelIds": [ # Label IDs for the 'updatelabels' request. 265 "A String", 266 ], 267 "linkRequest": { # Details about the `link` request. 268 "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`" 269 "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`" 270 "linkedAccountId": "A String", # The ID of the linked account. 271 "services": [ # Provided services. Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`" 272 "A String", 273 ], 274 }, 275 "merchantId": "A String", # The ID of the managing account. 276 "method": "A String", # The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`" 277 "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. 278 "view": "A String", # Controls which fields are visible. Only applicable if the method is 'get'. 279 }, 280 ], 281} 282 283 x__xgafv: string, V1 error format. 284 Allowed values 285 1 - v1 error format 286 2 - v2 error format 287 288Returns: 289 An object of the form: 290 291 { 292 "entries": [ # The result of the execution of the batch requests. 293 { # A batch entry encoding a single non-batch accounts response. 294 "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`. 295 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 296 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 297 { 298 "adsId": "A String", # Customer ID of the Ads account. 299 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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`" 300 }, 301 ], 302 "adultContent": True or False, # Indicates whether the merchant sells adult content. 303 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 304 "A String", 305 ], 306 "businessInformation": { # The business information of the account. 307 "address": { # The address of the business. 308 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 309 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 310 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 311 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 312 "streetAddress": "A String", # Street-level part of the address. 313 }, 314 "customerService": { # The customer service information of the business. 315 "email": "A String", # Customer service email. 316 "phoneNumber": "A String", # Customer service phone number. 317 "url": "A String", # Customer service URL. 318 }, 319 "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. 320 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 321 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 322 }, 323 "cssId": "A String", # ID of CSS the account belongs to. 324 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 325 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 326 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 327 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 328 }, 329 "id": "A String", # Required for update. Merchant Center account ID. 330 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 331 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 332 "A String", 333 ], 334 "name": "A String", # Required. Display name for the account. 335 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. 336 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. 337 { 338 "admin": True or False, # Whether user is an admin. 339 "emailAddress": "A String", # User's email address. 340 "orderManager": True or False, # Whether user is an order manager. 341 "paymentsAnalyst": True or False, # Whether user can access payment statements. 342 "paymentsManager": True or False, # Whether user can manage payment settings. 343 }, 344 ], 345 "websiteUrl": "A String", # The merchant's website. 346 "youtubeChannelLinks": [ # 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. 347 { 348 "channelId": "A String", # Channel ID. 349 "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. 350 }, 351 ], 352 }, 353 "batchId": 42, # The ID of the request entry this entry responds to. 354 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. 355 "code": 42, # The HTTP status of the first error in `errors`. 356 "errors": [ # A list of errors. 357 { # An error returned by the API. 358 "domain": "A String", # The domain of the error. 359 "message": "A String", # A description of the error. 360 "reason": "A String", # The error code. 361 }, 362 ], 363 "message": "A String", # The message of the first error in `errors`. 364 }, 365 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`" 366 }, 367 ], 368 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponse`". 369}</pre> 370</div> 371 372<div class="method"> 373 <code class="details" id="delete">delete(merchantId, accountId, force=None, x__xgafv=None)</code> 374 <pre>Deletes a Merchant Center sub-account. 375 376Args: 377 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) 378 accountId: string, The ID of the account. (required) 379 force: boolean, Flag to delete sub-accounts with products. The default value is false. 380 x__xgafv: string, V1 error format. 381 Allowed values 382 1 - v1 error format 383 2 - v2 error format 384</pre> 385</div> 386 387<div class="method"> 388 <code class="details" id="get">get(merchantId, accountId, view=None, x__xgafv=None)</code> 389 <pre>Retrieves a Merchant Center account. 390 391Args: 392 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) 393 accountId: string, The ID of the account. (required) 394 view: string, Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant". 395 Allowed values 396 MERCHANT - Default. View is populated with Merchant Center fields. 397 CSS - View is populated with Comparison Shopping Services fields. 398 x__xgafv: string, V1 error format. 399 Allowed values 400 1 - v1 error format 401 2 - v2 error format 402 403Returns: 404 An object of the form: 405 406 { # 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. 407 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 408 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 409 { 410 "adsId": "A String", # Customer ID of the Ads account. 411 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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`" 412 }, 413 ], 414 "adultContent": True or False, # Indicates whether the merchant sells adult content. 415 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 416 "A String", 417 ], 418 "businessInformation": { # The business information of the account. 419 "address": { # The address of the business. 420 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 421 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 422 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 423 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 424 "streetAddress": "A String", # Street-level part of the address. 425 }, 426 "customerService": { # The customer service information of the business. 427 "email": "A String", # Customer service email. 428 "phoneNumber": "A String", # Customer service phone number. 429 "url": "A String", # Customer service URL. 430 }, 431 "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. 432 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 433 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 434 }, 435 "cssId": "A String", # ID of CSS the account belongs to. 436 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 437 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 438 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 439 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 440 }, 441 "id": "A String", # Required for update. Merchant Center account ID. 442 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 443 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 444 "A String", 445 ], 446 "name": "A String", # Required. Display name for the account. 447 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. 448 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. 449 { 450 "admin": True or False, # Whether user is an admin. 451 "emailAddress": "A String", # User's email address. 452 "orderManager": True or False, # Whether user is an order manager. 453 "paymentsAnalyst": True or False, # Whether user can access payment statements. 454 "paymentsManager": True or False, # Whether user can manage payment settings. 455 }, 456 ], 457 "websiteUrl": "A String", # The merchant's website. 458 "youtubeChannelLinks": [ # 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. 459 { 460 "channelId": "A String", # Channel ID. 461 "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. 462 }, 463 ], 464}</pre> 465</div> 466 467<div class="method"> 468 <code class="details" id="insert">insert(merchantId, body=None, x__xgafv=None)</code> 469 <pre>Creates a Merchant Center sub-account. 470 471Args: 472 merchantId: string, The ID of the managing account. This must be a multi-client account. (required) 473 body: object, The request body. 474 The object takes the form of: 475 476{ # 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. 477 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 478 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 479 { 480 "adsId": "A String", # Customer ID of the Ads account. 481 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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 "adultContent": True or False, # Indicates whether the merchant sells adult content. 485 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 486 "A String", 487 ], 488 "businessInformation": { # The business information of the account. 489 "address": { # The address of the business. 490 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 491 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 492 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 493 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 494 "streetAddress": "A String", # Street-level part of the address. 495 }, 496 "customerService": { # The customer service information of the business. 497 "email": "A String", # Customer service email. 498 "phoneNumber": "A String", # Customer service phone number. 499 "url": "A String", # Customer service URL. 500 }, 501 "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. 502 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 503 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 504 }, 505 "cssId": "A String", # ID of CSS the account belongs to. 506 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 507 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 508 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 509 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 510 }, 511 "id": "A String", # Required for update. Merchant Center account ID. 512 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 513 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 514 "A String", 515 ], 516 "name": "A String", # Required. Display name for the account. 517 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. 518 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. 519 { 520 "admin": True or False, # Whether user is an admin. 521 "emailAddress": "A String", # User's email address. 522 "orderManager": True or False, # Whether user is an order manager. 523 "paymentsAnalyst": True or False, # Whether user can access payment statements. 524 "paymentsManager": True or False, # Whether user can manage payment settings. 525 }, 526 ], 527 "websiteUrl": "A String", # The merchant's website. 528 "youtubeChannelLinks": [ # 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. 529 { 530 "channelId": "A String", # Channel ID. 531 "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. 532 }, 533 ], 534} 535 536 x__xgafv: string, V1 error format. 537 Allowed values 538 1 - v1 error format 539 2 - v2 error format 540 541Returns: 542 An object of the form: 543 544 { # 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. 545 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 546 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 547 { 548 "adsId": "A String", # Customer ID of the Ads account. 549 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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`" 550 }, 551 ], 552 "adultContent": True or False, # Indicates whether the merchant sells adult content. 553 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 554 "A String", 555 ], 556 "businessInformation": { # The business information of the account. 557 "address": { # The address of the business. 558 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 559 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 560 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 561 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 562 "streetAddress": "A String", # Street-level part of the address. 563 }, 564 "customerService": { # The customer service information of the business. 565 "email": "A String", # Customer service email. 566 "phoneNumber": "A String", # Customer service phone number. 567 "url": "A String", # Customer service URL. 568 }, 569 "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. 570 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 571 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 572 }, 573 "cssId": "A String", # ID of CSS the account belongs to. 574 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 575 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 576 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 577 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 578 }, 579 "id": "A String", # Required for update. Merchant Center account ID. 580 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 581 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 582 "A String", 583 ], 584 "name": "A String", # Required. Display name for the account. 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 "admin": True or False, # Whether user is an admin. 589 "emailAddress": "A String", # User's email address. 590 "orderManager": True or False, # Whether user is an order manager. 591 "paymentsAnalyst": True or False, # Whether user can access payment statements. 592 "paymentsManager": True or False, # Whether user can manage payment settings. 593 }, 594 ], 595 "websiteUrl": "A String", # The merchant's website. 596 "youtubeChannelLinks": [ # 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. 597 { 598 "channelId": "A String", # Channel ID. 599 "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. 600 }, 601 ], 602}</pre> 603</div> 604 605<div class="method"> 606 <code class="details" id="link">link(merchantId, accountId, body=None, x__xgafv=None)</code> 607 <pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId. 608 609Args: 610 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) 611 accountId: string, The ID of the account that should be linked. (required) 612 body: object, The request body. 613 The object takes the form of: 614 615{ 616 "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`" 617 "eCommercePlatformLinkInfo": { # Additional information required for E_COMMERCE_PLATFORM link type. # Additional information required for `eCommercePlatform` link type. 618 "externalAccountId": "A String", # The id used by the third party service provider to identify the merchant. 619 }, 620 "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`" 621 "linkedAccountId": "A String", # The ID of the linked account. 622 "paymentServiceProviderLinkInfo": { # Additional information required for PAYMENT_SERVICE_PROVIDER link type. # Additional information required for `paymentServiceProvider` link type. 623 "externalAccountBusinessCountry": "A String", # The business country of the merchant account as identified by the third party service provider. 624 "externalAccountId": "A String", # The id used by the third party service provider to identify the merchant. 625 }, 626 "services": [ # Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`" 627 "A String", 628 ], 629} 630 631 x__xgafv: string, V1 error format. 632 Allowed values 633 1 - v1 error format 634 2 - v2 error format 635 636Returns: 637 An object of the form: 638 639 { 640 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsLinkResponse`". 641}</pre> 642</div> 643 644<div class="method"> 645 <code class="details" id="list">list(merchantId, label=None, maxResults=None, name=None, pageToken=None, view=None, x__xgafv=None)</code> 646 <pre>Lists the sub-accounts in your Merchant Center account. 647 648Args: 649 merchantId: string, The ID of the managing account. This must be a multi-client account. (required) 650 label: string, If view is set to "css", only return accounts that are assigned label with given ID. 651 maxResults: integer, The maximum number of accounts to return in the response, used for paging. 652 name: string, If set, only the accounts with the given name (case sensitive) will be returned. 653 pageToken: string, The token returned by the previous request. 654 view: string, Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant". 655 Allowed values 656 MERCHANT - Default. View is populated with Merchant Center fields. 657 CSS - View is populated with Comparison Shopping Services fields. 658 x__xgafv: string, V1 error format. 659 Allowed values 660 1 - v1 error format 661 2 - v2 error format 662 663Returns: 664 An object of the form: 665 666 { 667 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsListResponse`". 668 "nextPageToken": "A String", # The token for the retrieval of the next page of accounts. 669 "resources": [ 670 { # 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. 671 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 672 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 673 { 674 "adsId": "A String", # Customer ID of the Ads account. 675 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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`" 676 }, 677 ], 678 "adultContent": True or False, # Indicates whether the merchant sells adult content. 679 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 680 "A String", 681 ], 682 "businessInformation": { # The business information of the account. 683 "address": { # The address of the business. 684 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 685 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 686 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 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 "streetAddress": "A String", # Street-level part of the address. 689 }, 690 "customerService": { # The customer service information of the business. 691 "email": "A String", # Customer service email. 692 "phoneNumber": "A String", # Customer service phone number. 693 "url": "A String", # Customer service URL. 694 }, 695 "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. 696 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 697 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 698 }, 699 "cssId": "A String", # ID of CSS the account belongs to. 700 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 701 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 702 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 703 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 704 }, 705 "id": "A String", # Required for update. Merchant Center account ID. 706 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 707 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 708 "A String", 709 ], 710 "name": "A String", # Required. Display name for the account. 711 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. 712 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. 713 { 714 "admin": True or False, # Whether user is an admin. 715 "emailAddress": "A String", # User's email address. 716 "orderManager": True or False, # Whether user is an order manager. 717 "paymentsAnalyst": True or False, # Whether user can access payment statements. 718 "paymentsManager": True or False, # Whether user can manage payment settings. 719 }, 720 ], 721 "websiteUrl": "A String", # The merchant's website. 722 "youtubeChannelLinks": [ # 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. 723 { 724 "channelId": "A String", # Channel ID. 725 "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. 726 }, 727 ], 728 }, 729 ], 730}</pre> 731</div> 732 733<div class="method"> 734 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 735 <pre>Retrieves the next page of results. 736 737Args: 738 previous_request: The request for the previous page. (required) 739 previous_response: The response from the request for the previous page. (required) 740 741Returns: 742 A request object that you can call 'execute()' on to request the next 743 page. Returns None if there are no more items in the collection. 744 </pre> 745</div> 746 747<div class="method"> 748 <code class="details" id="listlinks">listlinks(merchantId, accountId, maxResults=None, pageToken=None, x__xgafv=None)</code> 749 <pre>Returns the list of accounts linked to your Merchant Center account. 750 751Args: 752 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) 753 accountId: string, The ID of the account for which to list links. (required) 754 maxResults: integer, The maximum number of links to return in the response, used for pagination. The minimum allowed value is 5 results per page. If provided value is lower than 5, it will be automatically increased to 5. 755 pageToken: string, The token returned by the previous request. 756 x__xgafv: string, V1 error format. 757 Allowed values 758 1 - v1 error format 759 2 - v2 error format 760 761Returns: 762 An object of the form: 763 764 { 765 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsListLinksResponse`". 766 "links": [ # The list of available links. 767 { 768 "linkedAccountId": "A String", # The ID of the linked account. 769 "services": [ # List of provided services. 770 { 771 "service": "A String", # Service provided to or by the linked account. Acceptable values are: - "`shoppingActionsOrderManagement`" - "`shoppingActionsProductManagement`" - "`shoppingAdsProductManagement`" - "`paymentProcessing`" 772 "status": "A String", # Status of the link Acceptable values are: - "`active`" - "`inactive`" - "`pending`" 773 }, 774 ], 775 }, 776 ], 777 "nextPageToken": "A String", # The token for the retrieval of the next page of links. 778}</pre> 779</div> 780 781<div class="method"> 782 <code class="details" id="listlinks_next">listlinks_next(previous_request, previous_response)</code> 783 <pre>Retrieves the next page of results. 784 785Args: 786 previous_request: The request for the previous page. (required) 787 previous_response: The response from the request for the previous page. (required) 788 789Returns: 790 A request object that you can call 'execute()' on to request the next 791 page. Returns None if there are no more items in the collection. 792 </pre> 793</div> 794 795<div class="method"> 796 <code class="details" id="requestphoneverification">requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)</code> 797 <pre>Request verification code to start phone verification. 798 799Args: 800 merchantId: string, Required. 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) 801 accountId: string, Required. The ID of the account. (required) 802 body: object, The request body. 803 The object takes the form of: 804 805{ # Request message for the RequestPhoneVerification method. 806 "languageCode": "A String", # Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) (for example, en-US). Language code is used to provide localized `SMS` and `PHONE_CALL`. Default language used is en-US if not provided. 807 "phoneNumber": "A String", # Phone number to be verified. 808 "phoneRegionCode": "A String", # Required. Two letter country code for the phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes. 809 "phoneVerificationMethod": "A String", # Verification method to receive verification code. 810} 811 812 x__xgafv: string, V1 error format. 813 Allowed values 814 1 - v1 error format 815 2 - v2 error format 816 817Returns: 818 An object of the form: 819 820 { # Response message for the RequestPhoneVerification method. 821 "verificationId": "A String", # The verification ID to use in subsequent calls to `verifyphonenumber`. 822}</pre> 823</div> 824 825<div class="method"> 826 <code class="details" id="update">update(merchantId, accountId, body=None, x__xgafv=None)</code> 827 <pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource. 828 829Args: 830 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) 831 accountId: string, The ID of the account. (required) 832 body: object, The request body. 833 The object takes the form of: 834 835{ # 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. 836 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 837 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 838 { 839 "adsId": "A String", # Customer ID of the Ads account. 840 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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`" 841 }, 842 ], 843 "adultContent": True or False, # Indicates whether the merchant sells adult content. 844 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 845 "A String", 846 ], 847 "businessInformation": { # The business information of the account. 848 "address": { # The address of the business. 849 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 850 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 851 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 852 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 853 "streetAddress": "A String", # Street-level part of the address. 854 }, 855 "customerService": { # The customer service information of the business. 856 "email": "A String", # Customer service email. 857 "phoneNumber": "A String", # Customer service phone number. 858 "url": "A String", # Customer service URL. 859 }, 860 "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. 861 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 862 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 863 }, 864 "cssId": "A String", # ID of CSS the account belongs to. 865 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 866 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 867 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 868 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 869 }, 870 "id": "A String", # Required for update. Merchant Center account ID. 871 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 872 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 873 "A String", 874 ], 875 "name": "A String", # Required. Display name for the account. 876 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. 877 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. 878 { 879 "admin": True or False, # Whether user is an admin. 880 "emailAddress": "A String", # User's email address. 881 "orderManager": True or False, # Whether user is an order manager. 882 "paymentsAnalyst": True or False, # Whether user can access payment statements. 883 "paymentsManager": True or False, # Whether user can manage payment settings. 884 }, 885 ], 886 "websiteUrl": "A String", # The merchant's website. 887 "youtubeChannelLinks": [ # 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. 888 { 889 "channelId": "A String", # Channel ID. 890 "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. 891 }, 892 ], 893} 894 895 x__xgafv: string, V1 error format. 896 Allowed values 897 1 - v1 error format 898 2 - v2 error format 899 900Returns: 901 An object of the form: 902 903 { # 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. 904 "accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 905 "adsLinks": [ # Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. 906 { 907 "adsId": "A String", # Customer ID of the Ads account. 908 "status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads 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`" 909 }, 910 ], 911 "adultContent": True or False, # Indicates whether the merchant sells adult content. 912 "automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center. 913 "A String", 914 ], 915 "businessInformation": { # The business information of the account. 916 "address": { # The address of the business. 917 "country": "A String", # CLDR country code (e.g. "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts. 918 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). 919 "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). 920 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). 921 "streetAddress": "A String", # Street-level part of the address. 922 }, 923 "customerService": { # The customer service information of the business. 924 "email": "A String", # Customer service email. 925 "phoneNumber": "A String", # Customer service phone number. 926 "url": "A String", # Customer service URL. 927 }, 928 "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. 929 "phoneNumber": "A String", # The phone number of the business. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`. 930 "phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`" 931 }, 932 "cssId": "A String", # ID of CSS the account belongs to. 933 "googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account. 934 "gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API. 935 "gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile. 936 "status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`" 937 }, 938 "id": "A String", # Required for update. Merchant Center account ID. 939 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`". 940 "labelIds": [ # Manually created label IDs that are assigned to the account by CSS. 941 "A String", 942 ], 943 "name": "A String", # Required. Display name for the account. 944 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. 945 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. 946 { 947 "admin": True or False, # Whether user is an admin. 948 "emailAddress": "A String", # User's email address. 949 "orderManager": True or False, # Whether user is an order manager. 950 "paymentsAnalyst": True or False, # Whether user can access payment statements. 951 "paymentsManager": True or False, # Whether user can manage payment settings. 952 }, 953 ], 954 "websiteUrl": "A String", # The merchant's website. 955 "youtubeChannelLinks": [ # 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. 956 { 957 "channelId": "A String", # Channel ID. 958 "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. 959 }, 960 ], 961}</pre> 962</div> 963 964<div class="method"> 965 <code class="details" id="updatelabels">updatelabels(merchantId, accountId, body=None, x__xgafv=None)</code> 966 <pre>Updates labels that are assigned to the Merchant Center account by CSS user. 967 968Args: 969 merchantId: string, The ID of the managing account. (required) 970 accountId: string, The ID of the account whose labels are updated. (required) 971 body: object, The request body. 972 The object takes the form of: 973 974{ 975 "labelIds": [ # The IDs of labels that should be assigned to the account. 976 "A String", 977 ], 978} 979 980 x__xgafv: string, V1 error format. 981 Allowed values 982 1 - v1 error format 983 2 - v2 error format 984 985Returns: 986 An object of the form: 987 988 { 989 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsUpdateLabelsResponse`". 990}</pre> 991</div> 992 993<div class="method"> 994 <code class="details" id="verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</code> 995 <pre>Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. Only verified phone number will replace an existing verified phone number. 996 997Args: 998 merchantId: string, Required. 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) 999 accountId: string, Required. The ID of the account. (required) 1000 body: object, The request body. 1001 The object takes the form of: 1002 1003{ # Request message for the VerifyPhoneNumber method. 1004 "phoneVerificationMethod": "A String", # Verification method used to receive verification code. 1005 "verificationCode": "A String", # The verification code that was sent to the phone number for validation. 1006 "verificationId": "A String", # The verification ID returned by `requestphoneverification`. 1007} 1008 1009 x__xgafv: string, V1 error format. 1010 Allowed values 1011 1 - v1 error format 1012 2 - v2 error format 1013 1014Returns: 1015 An object of the form: 1016 1017 { # Response message for the VerifyPhoneNumber method. 1018 "verifiedPhoneNumber": "A String", # Verified phone number if verification is successful. This phone number can only be replaced by another verified phone number. 1019}</pre> 1020</div> 1021 1022</body></html>