- Resource: Account
- AccountUser
- AccountYouTubeChannelLink
- AccountGoogleMyBusinessLink
- AccountBusinessInformation
- AccountAddress
- AccountCustomerService
- AccountBusinessIdentity
- AccountIdentityType
- AccountAutomaticImprovements
- AccountItemUpdates
- AccountItemUpdatesSettings
- AccountImageImprovements
- AccountImageImprovementsSettings
- AccountShippingImprovements
- AccountAdsLink
- AccountConversionSettings
- Methods
Resource: 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.
JSON representation |
---|
{ "name": string, "kind": string, "websiteUrl": string, "adultContent": boolean, "sellerId": string, "users": [ { object ( |
Fields | |
---|---|
name |
Required. Display name for the account. |
kind |
Identifies what kind of resource this is. Value: the fixed string " |
websiteUrl |
The merchant's website. |
adultContent |
Indicates whether the merchant sells adult content. |
sellerId |
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. |
id |
Required. 64-bit Merchant Center account ID. |
youtubeChannelLinks[] |
Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status |
googleMyBusinessLink |
The Business Profile which is linked or in the process of being linked with the Merchant Center account. |
businessInformation |
The business information of the account. |
businessIdentity |
The business identity attributes can be used to self-declare attributes that let customers know more about your business. |
automaticImprovements |
The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately. |
adsLinks[] |
Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status |
cssId |
ID of CSS the account belongs to. |
labelIds[] |
Manually created label IDs that are assigned to the account by CSS. |
accountManagement |
Output only. How the account is managed. Acceptable values are:
|
automaticLabelIds[] |
Automatically created label IDs that are assigned to the account by CSS Center. |
conversionSettings |
Settings for conversion tracking. |
AccountUser
JSON representation |
---|
{ "emailAddress": string, "admin": boolean, "orderManager": boolean, "paymentsManager": boolean, "paymentsAnalyst": boolean, "reportingManager": boolean } |
Fields | |
---|---|
emailAddress |
User's email address. |
admin |
Whether user is an admin. |
orderManager |
Whether user is an order manager. |
paymentsManager |
Whether user can manage payment settings. |
paymentsAnalyst |
Whether user can access payment statements. |
reportingManager |
Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center. |
AccountYouTubeChannelLink
JSON representation |
---|
{ "channelId": string, "status": string } |
Fields | |
---|---|
channelId |
Channel ID. |
status |
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 |
AccountGoogleMyBusinessLink
JSON representation |
---|
{ "gmbEmail": string, "status": string, "gmbAccountId": string } |
Fields | |
---|---|
gmbEmail |
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 |
Status of the link between this Merchant Center account and the Business Profile. Acceptable values are:
|
gmbAccountId |
The ID of the Business Profile. If this is provided, then |
AccountBusinessInformation
JSON representation |
---|
{ "address": { object ( |
Fields | |
---|---|
address |
The address of the business. Use |
phoneNumber |
The phone number of the business in 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 |
phoneVerificationStatus |
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:
|
customerService |
The customer service information of the business. |
koreanBusinessRegistrationNumber |
The 10-digit Korean business registration number separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set. |
AccountAddress
JSON representation |
---|
{ "streetAddress": string, "locality": string, "region": string, "postalCode": string, "country": string } |
Fields | |
---|---|
streetAddress |
Street-level part of the address. Use |
locality |
City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs). |
region |
Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
postalCode |
Postal code or ZIP (for example, "94043"). |
country |
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. |
AccountCustomerService
JSON representation |
---|
{ "url": string, "email": string, "phoneNumber": string } |
Fields | |
---|---|
url |
Customer service URL. |
email |
Customer service email. |
phoneNumber |
Customer service phone number. |
AccountBusinessIdentity
The business identity attributes can be used to self-declare attributes that let customers know more about your business.
JSON representation |
---|
{ "blackOwned": { object ( |
Fields | |
---|---|
blackOwned |
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. |
womenOwned |
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. |
veteranOwned |
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. |
latinoOwned |
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. |
smallBusiness |
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. |
includeForPromotions |
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
The account identity type used to specify attributes.
JSON representation |
---|
{ "selfIdentified": boolean } |
Fields | |
---|---|
selfIdentified |
Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions. |
AccountAutomaticImprovements
The automatic improvements of the account can be used to automatically update items, improve images and shipping.
JSON representation |
---|
{ "itemUpdates": { object ( |
Fields | |
---|---|
itemUpdates |
Turning on item updates 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. |
imageImprovements |
This improvement will attempt to automatically correct submitted images if they don't meet the image requirements, 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 This field is only updated (cleared) if provided. |
shippingImprovements |
Not available for MCAs accounts. By turning on automatic shipping improvements, 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:
|
AccountItemUpdates
Turning on item updates 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.
JSON representation |
---|
{
"accountItemUpdatesSettings": {
object ( |
Fields | |
---|---|
accountItemUpdatesSettings |
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. |
effectiveAllowPriceUpdates |
Output only. The effective value of allowPriceUpdates. If accountItemUpdatesSettings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only. |
effectiveAllowAvailabilityUpdates |
Output only. The effective value of allowAvailabilityUpdates. If accountItemUpdatesSettings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only. |
effectiveAllowStrictAvailabilityUpdates |
Output only. The effective value of allowStrictAvailabilityUpdates. If accountItemUpdatesSettings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only. |
effectiveAllowConditionUpdates |
Output only. The effective value of allowConditionUpdates. If accountItemUpdatesSettings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only. |
AccountItemUpdatesSettings
Settings for the Automatic Item Updates.
JSON representation |
---|
{ "allowPriceUpdates": boolean, "allowAvailabilityUpdates": boolean, "allowStrictAvailabilityUpdates": boolean, "allowConditionUpdates": boolean } |
Fields | |
---|---|
allowPriceUpdates |
If price updates are enabled, Google always updates the active price with the crawled information. |
allowAvailabilityUpdates |
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 |
allowStrictAvailabilityUpdates |
If allowAvailabilityUpdates 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. |
allowConditionUpdates |
If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product. |
AccountImageImprovements
This improvement will attempt to automatically correct submitted images if they don't meet the image requirements, 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
JSON representation |
---|
{
"accountImageImprovementsSettings": {
object ( |
Fields | |
---|---|
accountImageImprovementsSettings |
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. |
effectiveAllowAutomaticImageImprovements |
Output only. The effective value of allowAutomaticImageImprovements. If accountImageImprovementsSettings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only. |
AccountImageImprovementsSettings
Settings for the Automatic Image Improvements.
JSON representation |
---|
{ "allowAutomaticImageImprovements": boolean } |
Fields | |
---|---|
allowAutomaticImageImprovements |
Enables automatic image improvements. |
AccountShippingImprovements
Not available for MCAs accounts. By turning on automatic shipping improvements, 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
JSON representation |
---|
{ "allowShippingImprovements": boolean } |
Fields | |
---|---|
allowShippingImprovements |
Enables automatic shipping improvements. |
AccountAdsLink
JSON representation |
---|
{ "adsId": string, "status": string } |
Fields | |
---|---|
adsId |
Customer ID of the Ads account. |
status |
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 Acceptable values are:
|
AccountConversionSettings
Settings for conversion tracking.
JSON representation |
---|
{ "freeListingsAutoTaggingEnabled": boolean } |
Fields | |
---|---|
freeListingsAutoTaggingEnabled |
When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See auto-tagging. |
Methods |
|
---|---|
|
Returns information about the authenticated user. |
|
Claims the website of a Merchant Center sub-account. |
|
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. |
|
Deletes a Merchant Center sub-account. |
|
Retrieves a Merchant Center account. |
|
Creates a Merchant Center sub-account. |
|
Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId. |
|
Lists the sub-accounts in your Merchant Center account. |
|
Returns the list of accounts linked to your Merchant Center account. |
|
Request verification code to start phone verification. |
|
Updates a Merchant Center account. |
|
Updates labels that are assigned to the Merchant Center account by CSS user. |
|
Validates verification code to verify phone number for the account. |