Returns the credentials Resource.
Returns the labels Resource.
Returns the returncarrier Resource.
Returns information about the authenticated user.
claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)
Claims the website of a Merchant Center sub-account. Merchant accounts with approved third-party CSSs aren't required to claim a website.
Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
delete(merchantId, accountId, force=None, x__xgafv=None)
Deletes a Merchant Center sub-account.
get(merchantId, accountId, view=None, x__xgafv=None)
Retrieves a Merchant Center account.
insert(merchantId, body=None, x__xgafv=None)
Creates a Merchant Center sub-account.
link(merchantId, accountId, body=None, x__xgafv=None)
Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
list(merchantId, label=None, maxResults=None, name=None, pageToken=None, view=None, x__xgafv=None)
Lists the sub-accounts in your Merchant Center account.
Retrieves the next page of results.
listlinks(merchantId, accountId, maxResults=None, pageToken=None, x__xgafv=None)
Returns the list of accounts linked to your Merchant Center account.
Retrieves the next page of results.
requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)
Request verification code to start phone verification.
update(merchantId, accountId, body=None, x__xgafv=None)
Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
updatelabels(merchantId, accountId, body=None, x__xgafv=None)
Updates labels that are assigned to the Merchant Center account by CSS user.
verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)
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.
authinfo(x__xgafv=None)
Returns information about the authenticated user.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"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`".
}
claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)
Claims the website of a Merchant Center sub-account. Merchant accounts with approved third-party CSSs aren't required to claim a website.
Args:
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)
accountId: string, The ID of the account whose website is claimed. (required)
overwrite: boolean, Only available to selected merchants, for example multi-client accounts (MCAs) and their sub-accounts. When set to `True`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsClaimWebsiteResponse`".
}
close()
Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
Args:
body: object, The request body.
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.
"account": { # Account data. After the creation of a new account it may take a few minutes before it's 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`.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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`" - "`paymentServiceProvider`" - "`localProductManager`"
"linkedAccountId": "A String", # The ID of the linked account.
"services": [ # Provided services. Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`" - "`localProductManagement`"
"A String",
],
},
"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.
"view": "A String", # Controls which fields are visible. Only applicable if the method is 'get'.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"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's 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`.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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.
},
],
},
"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 for failed custombatch entries. *Note:* Schema errors fail the whole request.
"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`"
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponse`".
}
delete(merchantId, accountId, force=None, x__xgafv=None)
Deletes a Merchant Center sub-account.
Args:
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)
accountId: string, The ID of the account. (required)
force: boolean, Option to delete sub-accounts with products. The default value is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
get(merchantId, accountId, view=None, x__xgafv=None)
Retrieves a Merchant Center account.
Args:
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)
accountId: string, The ID of the account. (required)
view: string, Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".
Allowed values
MERCHANT - Default. View is populated with Merchant Center fields.
CSS - View is populated with Comparison Shopping Services fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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.
},
],
}
insert(merchantId, body=None, x__xgafv=None)
Creates a Merchant Center sub-account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
body: object, The request body.
The object takes the form of:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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.
},
],
}
link(merchantId, accountId, body=None, x__xgafv=None)
Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Args:
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)
accountId: string, The ID of the account that should be linked. (required)
body: object, The request body.
The object takes the form of:
{
"action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
"eCommercePlatformLinkInfo": { # Additional information required for E_COMMERCE_PLATFORM link type. # Additional information required for `eCommercePlatform` link type.
"externalAccountId": "A String", # The id used by the third party service provider to identify the merchant.
},
"linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`"
"linkedAccountId": "A String", # The ID of the linked account.
"paymentServiceProviderLinkInfo": { # Additional information required for PAYMENT_SERVICE_PROVIDER link type. # Additional information required for `paymentServiceProvider` link type.
"externalAccountBusinessCountry": "A String", # The business country of the merchant account as identified by the third party service provider.
"externalAccountId": "A String", # The id used by the third party service provider to identify the merchant.
},
"services": [ # Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`"
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsLinkResponse`".
}
list(merchantId, label=None, maxResults=None, name=None, pageToken=None, view=None, x__xgafv=None)
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)
label: string, If view is set to "css", only return accounts that are assigned label with given ID.
maxResults: integer, The maximum number of accounts to return in the response, used for paging.
name: string, If set, only the accounts with the given name (case sensitive) will be returned.
pageToken: string, The token returned by the previous request.
view: string, Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".
Allowed values
MERCHANT - Default. View is populated with Merchant Center fields.
CSS - View is populated with Comparison Shopping Services fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
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's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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.
},
],
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
listlinks(merchantId, accountId, maxResults=None, pageToken=None, x__xgafv=None)
Returns the list of accounts linked to your Merchant Center account.
Args:
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)
accountId: string, The ID of the account for which to list links. (required)
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.
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsListLinksResponse`".
"links": [ # The list of available links.
{
"linkedAccountId": "A String", # The ID of the linked account.
"services": [ # List of provided services.
{
"service": "A String", # Service provided to or by the linked account. Acceptable values are: - "`shoppingActionsOrderManagement`" - "`shoppingActionsProductManagement`" - "`shoppingAdsProductManagement`" - "`paymentProcessing`"
"status": "A String", # Status of the link Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
],
},
],
"nextPageToken": "A String", # The token for the retrieval of the next page of links.
}
listlinks_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)
Request verification code to start phone verification.
Args:
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)
accountId: string, Required. The ID of the account. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the RequestPhoneVerification method.
"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.
"phoneNumber": "A String", # Phone number to be verified.
"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.
"phoneVerificationMethod": "A String", # Verification method to receive verification code.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the RequestPhoneVerification method.
"verificationId": "A String", # The verification ID to use in subsequent calls to `verifyphonenumber`.
}
update(merchantId, accountId, body=None, x__xgafv=None)
Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
Args:
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)
accountId: string, The ID of the account. (required)
body: object, The request body.
The object takes the form of:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"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 Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"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`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "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. Use `\n` to add a second line.
},
"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.
},
"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.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. 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`.
"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`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"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.
"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.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"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.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"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.
{
"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.
},
],
}
updatelabels(merchantId, accountId, body=None, x__xgafv=None)
Updates labels that are assigned to the Merchant Center account by CSS user.
Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account whose labels are updated. (required)
body: object, The request body.
The object takes the form of:
{
"labelIds": [ # The IDs of labels that should be assigned to the account.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsUpdateLabelsResponse`".
}
verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)
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.
Args:
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)
accountId: string, Required. The ID of the account. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the VerifyPhoneNumber method.
"phoneVerificationMethod": "A String", # Verification method used to receive verification code.
"verificationCode": "A String", # The verification code that was sent to the phone number for validation.
"verificationId": "A String", # The verification ID returned by `requestphoneverification`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the VerifyPhoneNumber method.
"verifiedPhoneNumber": "A String", # Verified phone number if verification is successful. This phone number can only be replaced by another verified phone number.
}