Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers

Stay organized with collections Save and categorize content based on your preferences.

Resource: Customer

A customer.

JSON representation 
{
  "resourceName": string,
  "callReportingSetting": {
    object (CallReportingSetting)
  },
  "conversionTrackingSetting": {
    object (ConversionTrackingSetting)
  },
  "remarketingSetting": {
    object (RemarketingSetting)
  },
  "payPerConversionEligibilityFailureReasons": [
    enum (CustomerPayPerConversionEligibilityFailureReason)
  ],
  "optimizationScoreWeight": number,
  "id": string,
  "descriptiveName": string,
  "currencyCode": string,
  "timeZone": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string,
  "autoTaggingEnabled": boolean,
  "hasPartnersBadge": boolean,
  "manager": boolean,
  "testAccount": boolean,
  "optimizationScore": number
}
Fields
resourceName

string

Immutable. The resource name of the customer. Customer resource names have the form:

customers/{customerId}
callReportingSetting

object (CallReportingSetting)

Call reporting setting for a customer.
conversionTrackingSetting

object (ConversionTrackingSetting)

Output only. Conversion tracking setting for a customer.
remarketingSetting

object (RemarketingSetting)

Output only. Remarketing setting for a customer.
payPerConversionEligibilityFailureReasons[]

enum (CustomerPayPerConversionEligibilityFailureReason)

Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
optimizationScoreWeight

number

Output only. Optimization score weight of the customer.

Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers.

This field is read-only.
id

string (int64 format)

Output only. The ID of the customer.
descriptiveName

string

Optional, non-unique descriptive name of the customer.
currencyCode

string

Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
timeZone

string

Immutable. The local timezone ID of the customer.
trackingUrlTemplate

string

The URL template for constructing a tracking URL out of parameters.
finalUrlSuffix

string

The URL template for appending params to the final URL
autoTaggingEnabled

boolean

Whether auto-tagging is enabled for the customer.
hasPartnersBadge

boolean

Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
manager

boolean

Output only. Whether the customer is a manager.
testAccount

boolean

Output only. Whether the customer is a test account.
optimizationScore

number

Output only. Optimization score of the customer.

Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers.

See "About optimization score" at https://support.google.com/google-ads/answer/9061546.

This field is read-only.

CallReportingSetting

Call reporting setting for a customer.

JSON representation 
{
  "callReportingEnabled": boolean,
  "callConversionReportingEnabled": boolean,
  "callConversionAction": string
}
Fields
callReportingEnabled

boolean

Enable reporting of phone call events by redirecting them via Google System.
callConversionReportingEnabled

boolean

Whether to enable call conversion reporting.
callConversionAction

string

Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when callConversionReportingEnabled is set to true.

ConversionTrackingSetting

A collection of customer-wide settings related to Google Ads Conversion Tracking.

JSON representation 
{
  "conversionTrackingId": string,
  "crossAccountConversionTrackingId": string
}
Fields
conversionTrackingId

string (int64 format)

Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only.
crossAccountConversionTrackingId

string (int64 format)

Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversionTrackingId. This field can only be managed through the Google Ads UI. This field is read-only.

RemarketingSetting

Remarketing setting for a customer.

JSON representation 
{
  "googleGlobalSiteTag": string
}
Fields
googleGlobalSiteTag

string

Output only. The Google global site tag.

CustomerPayPerConversionEligibilityFailureReason

Enum describing possible reasons a customer is not eligible to use PaymentMode.CONVERSIONS.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NOT_ENOUGH_CONVERSIONS Customer does not have enough conversions.
CONVERSION_LAG_TOO_HIGH Customer's conversion lag is too high.
HAS_CAMPAIGN_WITH_SHARED_BUDGET Customer uses shared budgets.
HAS_UPLOAD_CLICKS_CONVERSION Customer has conversions with ConversionActionType.UPLOAD_CLICKS.
AVERAGE_DAILY_SPEND_TOO_HIGH Customer's average daily spend is too high.
ANALYSIS_NOT_COMPLETE Customer's eligibility has not yet been calculated by the Google Ads backend. Check back soon.
OTHER Customer is not eligible due to other reasons.

Methods

createCustomerClient

 Creates a new client under manager.

generateKeywordIdeas

 Returns a list of keyword ideas.

generateProductMixIdeas

 Generates a product mix ideas given a set of preferences.

generateReachForecast

 Generates a reach forecast for a given targeting / product mix.

get

 Returns the requested customer in full detail.

getHotelPerformanceView

 Returns the requested Hotel Performance View in full detail.

getShoppingPerformanceView

 Returns the requested Shopping performance view in full detail.

listAccessibleCustomers

 Returns resource names of customers directly accessible by the user authenticating the call.

mutate

 Updates a customer.

suggestKeywordThemes

 Suggests keyword themes to advertise on.

suggestSmartCampaignAd

 Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

suggestSmartCampaignBudgetOptions

 Returns BudgetOption suggestions.

uploadCallConversions

 Processes the given call conversions.

uploadClickConversions

 Processes the given click conversions.

uploadConversionAdjustments

 Processes the given conversion adjustments.

uploadUserData

 Uploads the given user data.