REST Resource: accounts

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 (AccountUser)
    }
  ],
  "id": string,
  "youtubeChannelLinks": [
    {
      object (AccountYouTubeChannelLink)
    }
  ],
  "googleMyBusinessLink": {
    object (AccountGoogleMyBusinessLink)
  },
  "businessInformation": {
    object (AccountBusinessInformation)
  },
  "businessIdentity": {
    object (AccountBusinessIdentity)
  },
  "automaticImprovements": {
    object (AccountAutomaticImprovements)
  },
  "adsLinks": [
    {
      object (AccountAdsLink)
    }
  ],
  "cssId": string,
  "labelIds": [
    string
  ],
  "accountManagement": string,
  "automaticLabelIds": [
    string
  ],
  "conversionSettings": {
    object (AccountConversionSettings)
  }
}
Fields
name

string

Required. Display name for the account.
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#account".
websiteUrl

string

The merchant's website.
adultContent

boolean

Indicates whether the merchant sells adult content.
sellerId

string

Client-specific, locally-unique, internal ID for the child account.
users[]

object (AccountUser)

Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
id

string

Required. 64-bit Merchant Center account ID.
businessInformation

object (AccountBusinessInformation)

The business information of the account.
businessIdentity

object (AccountBusinessIdentity)

The business identity attributes can be used to self-declare attributes that let customers know more about your business.
automaticImprovements

object (AccountAutomaticImprovements)

The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
cssId

string

ID of CSS the account belongs to.
labelIds[]

string

Manually created label IDs that are assigned to the account by CSS.
accountManagement

string

Output only. How the account is managed.

Acceptable values are:

  • "manual"
  • "automatic"
automaticLabelIds[]

string

Automatically created label IDs that are assigned to the account by CSS Center.
conversionSettings

object (AccountConversionSettings)

Settings for conversion tracking.

AccountUser

JSON representation 
{
  "emailAddress": string,
  "admin": boolean,
  "orderManager": boolean,
  "paymentsManager": boolean,
  "paymentsAnalyst": boolean,
  "reportingManager": boolean
}
Fields
emailAddress

string

User's email address.
admin

boolean

Whether user is an admin.
orderManager

boolean

Whether user is an order manager.
paymentsManager

boolean

Whether user can manage payment settings.
paymentsAnalyst

boolean

Whether user can access payment statements.
reportingManager

boolean

Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.

AccountBusinessInformation

JSON representation 
{
  "address": {
    object (AccountAddress)
  },
  "phoneNumber": string,
  "phoneVerificationStatus": string,
  "customerService": {
    object (AccountCustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
Fields
address

object (AccountAddress)

The address of the business. Use \n to add a second address line.
phoneNumber

string

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 Accounts.requestphoneverification and Accounts.verifyphonenumber.
phoneVerificationStatus

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

object (AccountCustomerService)

The customer service information of the business.
koreanBusinessRegistrationNumber

string

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

string

Street-level part of the address. Use \n to add a second line.
locality

string

City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
region

string

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

string

Postal code or ZIP (for example, "94043").
country

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.

AccountCustomerService

JSON representation 
{
  "url": string,
  "email": string,
  "phoneNumber": string
}
Fields
url

string

Customer service URL.
email

string

Customer service email.
phoneNumber

string

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 (AccountIdentityType)
  },
  "womenOwned": {
    object (AccountIdentityType)
  },
  "veteranOwned": {
    object (AccountIdentityType)
  },
  "latinoOwned": {
    object (AccountIdentityType)
  },
  "smallBusiness": {
    object (AccountIdentityType)
  },
  "includeForPromotions": boolean
}
Fields
blackOwned

object (AccountIdentityType)

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

object (AccountIdentityType)

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

object (AccountIdentityType)

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

object (AccountIdentityType)

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

object (AccountIdentityType)

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

boolean

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.

AccountIdentityType

The account identity type used to specify attributes.

JSON representation 
{
  "selfIdentified": boolean
}
Fields
selfIdentified

boolean

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 (AccountItemUpdates)
  },
  "imageImprovements": {
    object (AccountImageImprovements)
  },
  "shippingImprovements": {
    object (AccountShippingImprovements)
  }
}
Fields
itemUpdates

object (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. This field is only updated (cleared) if provided.
imageImprovements

object (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 This field is only updated (cleared) if provided.
shippingImprovements

object (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
This field is only updated (cleared) if provided.

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 (AccountItemUpdatesSettings)
  },
  "effectiveAllowPriceUpdates": boolean,
  "effectiveAllowAvailabilityUpdates": boolean,
  "effectiveAllowStrictAvailabilityUpdates": boolean,
  "effectiveAllowConditionUpdates": boolean
}
Fields
accountItemUpdatesSettings

object (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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

If price updates are enabled, Google always updates the active price with the crawled information.
allowAvailabilityUpdates

boolean

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 allowAvailabilityUpdates field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
allowStrictAvailabilityUpdates

boolean

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

boolean

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 (AccountImageImprovementsSettings)
  },
  "effectiveAllowAutomaticImageImprovements": boolean
}
Fields
accountImageImprovementsSettings

object (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

boolean

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

boolean

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

boolean

Enables automatic shipping improvements.

AccountConversionSettings

Settings for conversion tracking.

JSON representation 
{
  "freeListingsAutoTaggingEnabled": boolean
}
Fields
freeListingsAutoTaggingEnabled

boolean

When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See auto-tagging.

Methods

authinfo

 Returns information about the authenticated user.

claimwebsite

 Claims the website of a Merchant Center sub-account.

custombatch

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

delete

 Deletes a Merchant Center sub-account.

get

 Retrieves a Merchant Center account.

insert

 Creates a Merchant Center sub-account.

Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.

list

 Lists the sub-accounts in your Merchant Center account.
Returns the list of accounts linked to your Merchant Center account.

requestphoneverification

 Request verification code to start phone verification.

update

 Updates a Merchant Center account.

updatelabels

 Updates labels that are assigned to the Merchant Center account by CSS user.

verifyphonenumber

 Validates verification code to verify phone number for the account.