chore: update docs/dyn (#1162)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b5e48daa-1759-436b-9fe7-ffce1482b520/targets
- [ ] To automatically regenerate this PR, check this box.
diff --git a/docs/dyn/content_v2.accounts.html b/docs/dyn/content_v2.accounts.html
index 0e13782..ee55e97 100644
--- a/docs/dyn/content_v2.accounts.html
+++ b/docs/dyn/content_v2.accounts.html
@@ -99,7 +99,7 @@
<code><a href="#link">link(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.</p>
<p class="toc_element">
- <code><a href="#list">list(merchantId, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the sub-accounts in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -122,14 +122,14 @@
An object of the form:
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
- "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.
- {
- "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
- "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
- },
- ],
- }</pre>
+ "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.
+ {
+ "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
+ "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
+}</pre>
</div>
<div class="method">
@@ -149,8 +149,8 @@
An object of the form:
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".
- }</pre>
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".
+}</pre>
</div>
<div class="method">
@@ -167,74 +167,74 @@
The object takes the form of:
{
- "entries": [ # The request entries to be processed in the batch.
- { # A batch entry encoding a single non-batch accounts request.
- "linkRequest": { # Details about the `link` request.
- "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`"
- "linkedAccountId": "A String", # The ID of the linked account.
- "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
- },
- "method": "A String", # The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`"
- "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.
- "merchantId": "A String", # The ID of the managing account.
- "batchId": 42, # An entry ID, unique within the batch request.
- "labelIds": [ # Label IDs for the 'updatelabels' request.
- "A String",
+ "entries": [ # The request entries to be processed in the batch.
+ { # A batch entry encoding a single non-batch accounts request.
+ "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`.
+ "adultContent": True or False, # Indicates whether the merchant sells adult content.
+ "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.
+ {
+ "adwordsId": "A String", # Customer ID of the AdWords account.
+ "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`"
+ },
],
- "accountId": "A String", # The ID of the targeted account. Only defined if the method is not `insert`.
- "force": True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.
- "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`.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
},
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
},
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
- "adultContent": True or False, # Indicates whether the merchant sells adult content.
- "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.
- {
- "adwordsId": "A String", # Customer ID of the AdWords account.
- "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`"
- },
- ],
+ "phoneNumber": "A String", # The phone number of the business.
},
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ },
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "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.
+ },
+ ],
},
- ],
- }
+ "accountId": "A String", # The ID of the targeted account. Only defined if the method is not `insert`.
+ "batchId": 42, # An entry ID, unique within the batch request.
+ "force": True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.
+ "labelIds": [ # Label IDs for the 'updatelabels' request.
+ "A String",
+ ],
+ "linkRequest": { # Details about the `link` request.
+ "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
+ "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`"
+ "linkedAccountId": "A String", # The ID of the linked account.
+ },
+ "merchantId": "A String", # The ID of the managing account.
+ "method": "A String", # The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`"
+ "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.
+ },
+ ],
+}
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).
x__xgafv: string, V1 error format.
@@ -246,75 +246,75 @@
An object of the form:
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".
- "entries": [ # The result of the execution of the batch requests.
- { # A batch entry encoding a single non-batch accounts response.
- "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`.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
+ "entries": [ # The result of the execution of the batch requests.
+ { # A batch entry encoding a single non-batch accounts response.
+ "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`.
+ "adultContent": True or False, # Indicates whether the merchant sells adult content.
+ "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.
+ {
+ "adwordsId": "A String", # Customer ID of the AdWords account.
+ "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`"
},
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ ],
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
},
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
- "adultContent": True or False, # Indicates whether the merchant sells adult content.
- "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.
- {
- "adwordsId": "A String", # Customer ID of the AdWords account.
- "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`"
- },
- ],
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
+ },
+ "phoneNumber": "A String", # The phone number of the business.
},
- "batchId": 42, # The ID of the request entry this entry responds to.
- "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
- "errors": [ # A list of errors.
- { # An error returned by the API.
- "reason": "A String", # The error code.
- "message": "A String", # A description of the error.
- "domain": "A String", # The domain of the error.
- },
- ],
- "code": 42, # The HTTP status of the first error in `errors`.
- "message": "A String", # The message of the first error in `errors`.
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
},
- "linkStatus": "A String", # Deprecated. This field is never set. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`"
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
+ },
+ ],
},
- ],
- }</pre>
+ "batchId": 42, # The ID of the request entry this entry responds to.
+ "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
+ "code": 42, # The HTTP status of the first error in `errors`.
+ "errors": [ # A list of errors.
+ { # An error returned by the API.
+ "domain": "A String", # The domain of the error.
+ "message": "A String", # A description of the error.
+ "reason": "A String", # The error code.
+ },
+ ],
+ "message": "A String", # The message of the first error in `errors`.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`"
+ "linkStatus": "A String", # Deprecated. This field is never set. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".
+}</pre>
</div>
<div class="method">
@@ -349,54 +349,54 @@
An object of the form:
{ # 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.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
+ "adultContent": True or False, # Indicates whether the merchant sells adult content.
+ "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.
+ {
+ "adwordsId": "A String", # Customer ID of the AdWords account.
+ "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`"
},
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ ],
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
},
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
- "adultContent": True or False, # Indicates whether the merchant sells adult content.
- "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.
- {
- "adwordsId": "A String", # Customer ID of the AdWords account.
- "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`"
- },
- ],
- }</pre>
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
+ },
+ "phoneNumber": "A String", # The phone number of the business.
+ },
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ },
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -409,46 +409,6 @@
The object takes the form of:
{ # 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.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
- },
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"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.
{
@@ -456,6 +416,46 @@
"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`"
},
],
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
+ },
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
+ },
+ "phoneNumber": "A String", # The phone number of the business.
+ },
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ },
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "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.
+ },
+ ],
}
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).
@@ -468,54 +468,54 @@
An object of the form:
{ # 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.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
+ "adultContent": True or False, # Indicates whether the merchant sells adult content.
+ "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.
+ {
+ "adwordsId": "A String", # Customer ID of the AdWords account.
+ "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`"
},
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ ],
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
},
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
- "adultContent": True or False, # Indicates whether the merchant sells adult content.
- "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.
- {
- "adwordsId": "A String", # Customer ID of the AdWords account.
- "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`"
- },
- ],
- }</pre>
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
+ },
+ "phoneNumber": "A String", # The phone number of the business.
+ },
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ },
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -529,10 +529,10 @@
The object takes the form of:
{
- "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`"
- "linkedAccountId": "A String", # The ID of the linked account.
- "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
- }
+ "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
+ "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`"
+ "linkedAccountId": "A String", # The ID of the linked account.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -543,18 +543,18 @@
An object of the form:
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".
- }</pre>
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".
+}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the sub-accounts in your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
- pageToken: string, The token returned by the previous request.
maxResults: integer, The maximum number of accounts to return in the response, used for paging.
+ pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -564,60 +564,60 @@
An object of the form:
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
- "nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
- "resources": [
- { # 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.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
+ "nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
+ "resources": [
+ { # 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.
+ "adultContent": True or False, # Indicates whether the merchant sells adult content.
+ "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.
+ {
+ "adwordsId": "A String", # Customer ID of the AdWords account.
+ "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`"
},
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ ],
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
},
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
- "adultContent": True or False, # Indicates whether the merchant sells adult content.
- "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.
- {
- "adwordsId": "A String", # Customer ID of the AdWords account.
- "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`"
- },
- ],
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
+ },
+ "phoneNumber": "A String", # The phone number of the business.
},
- ],
- }</pre>
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ },
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
+ },
+ ],
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -645,46 +645,6 @@
The object takes the form of:
{ # 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.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
- },
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
- },
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"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.
{
@@ -692,6 +652,46 @@
"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`"
},
],
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
+ },
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
+ },
+ "phoneNumber": "A String", # The phone number of the business.
+ },
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ },
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "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.
+ },
+ ],
}
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).
@@ -704,54 +704,54 @@
An object of the form:
{ # 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.
- "id": "A String", # Required for update. Merchant Center account ID.
- "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
- {
- "paymentsAnalyst": True or False, # Whether user can access payment statements.
- "orderManager": True or False, # Whether user is an order manager.
- "admin": True or False, # Whether user is an admin.
- "emailAddress": "A String", # User's email address.
- "paymentsManager": True or False, # Whether user can manage payment settings.
- },
- ],
- "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
- "websiteUrl": "A String", # The merchant's website.
- "businessInformation": { # The business information of the account.
- "phoneNumber": "A String", # The phone number of the business.
- "customerService": { # The customer service information of the business.
- "url": "A String", # Customer service URL.
- "email": "A String", # Customer service email.
- "phoneNumber": "A String", # Customer service phone number.
- },
- "address": { # The address of the business.
- "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.
- "streetAddress": "A String", # Street-level part of the address.
- "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
- "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
- "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
- },
+ "adultContent": True or False, # Indicates whether the merchant sells adult content.
+ "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.
+ {
+ "adwordsId": "A String", # Customer ID of the AdWords account.
+ "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`"
},
- "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.
- {
- "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.
- "channelId": "A String", # Channel ID.
- },
- ],
- "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
- "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.
- "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ ],
+ "businessInformation": { # The business information of the account.
+ "address": { # The address of the business.
+ "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.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
+ "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+ "streetAddress": "A String", # Street-level part of the address.
},
- "name": "A String", # Required. Display name for the account.
- "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
- "adultContent": True or False, # Indicates whether the merchant sells adult content.
- "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.
- {
- "adwordsId": "A String", # Customer ID of the AdWords account.
- "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`"
- },
- ],
- }</pre>
+ "customerService": { # The customer service information of the business.
+ "email": "A String", # Customer service email.
+ "phoneNumber": "A String", # Customer service phone number.
+ "url": "A String", # Customer service URL.
+ },
+ "phoneNumber": "A String", # The phone number of the business.
+ },
+ "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
+ "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.
+ "status": "A String", # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`"
+ },
+ "id": "A String", # Required for update. Merchant Center account ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`"
+ "name": "A String", # Required. Display name for the account.
+ "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
+ "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
+ "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
+ {
+ "admin": True or False, # Whether user is an admin.
+ "emailAddress": "A String", # User's email address.
+ "orderManager": True or False, # Whether user is an order manager.
+ "paymentsAnalyst": True or False, # Whether user can access payment statements.
+ "paymentsManager": True or False, # Whether user can manage payment settings.
+ },
+ ],
+ "websiteUrl": "A String", # The merchant's website.
+ "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.
+ {
+ "channelId": "A String", # Channel ID.
+ "status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
+ },
+ ],
+}</pre>
</div>
</body></html>
\ No newline at end of file