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.conversionActions

Resource: ConversionAction

A conversion action.

JSON representation
{
  "resourceName": string,
  "status": enum (ConversionActionStatus),
  "type": enum (ConversionActionType),
  "category": enum (ConversionActionCategory),
  "valueSettings": {
    object (ValueSettings)
  },
  "countingType": enum (ConversionActionCountingType),
  "attributionModelSettings": {
    object (AttributionModelSettings)
  },
  "tagSnippets": [
    {
      object (TagSnippet)
    }
  ],
  "mobileAppVendor": enum (MobileAppVendor),
  "firebaseSettings": {
    object (FirebaseSettings)
  },
  "thirdPartyAppAnalyticsSettings": {
    object (ThirdPartyAppAnalyticsSettings)
  },
  "id": string,
  "name": string,
  "ownerCustomer": string,
  "includeInConversionsMetric": boolean,
  "clickThroughLookbackWindowDays": string,
  "viewThroughLookbackWindowDays": string,
  "phoneCallDurationSeconds": string,
  "appId": string
}
Fields
resourceName

string

Immutable. The resource name of the conversion action. Conversion action resource names have the form:

customers/{customerId}/conversionActions/{conversion_action_id}

status

enum (ConversionActionStatus)

The status of this conversion action for conversion event accrual.

type

enum (ConversionActionType)

Immutable. The type of this conversion action.

category

enum (ConversionActionCategory)

The category of conversions reported for this conversion action.

valueSettings

object (ValueSettings)

Settings related to the value for conversion events associated with this conversion action.

countingType

enum (ConversionActionCountingType)

How to count conversion events for the conversion action.

attributionModelSettings

object (AttributionModelSettings)

Settings related to this conversion action's attribution model.

tagSnippets[]

object (TagSnippet)

Output only. The snippets used for tracking conversions.

mobileAppVendor

enum (MobileAppVendor)

Output only. Mobile app vendor for an app conversion action.

firebaseSettings

object (FirebaseSettings)

Output only. Firebase settings for Firebase conversion types.

thirdPartyAppAnalyticsSettings

object (ThirdPartyAppAnalyticsSettings)

Output only. Third Party App Analytics settings for third party conversion types.

id

string (int64 format)

Output only. The ID of the conversion action.

name

string

The name of the conversion action.

This field is required and should not be empty when creating new conversion actions.

ownerCustomer

string

Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.

includeInConversionsMetric

boolean

Whether this conversion action should be included in the "conversions" metric.

clickThroughLookbackWindowDays

string (int64 format)

The maximum number of days that may elapse between an interaction (e.g., a click) and a conversion event.

viewThroughLookbackWindowDays

string (int64 format)

The maximum number of days which may elapse between an impression and a conversion without an interaction.

phoneCallDurationSeconds

string (int64 format)

The phone call duration in seconds after which a conversion should be reported for this conversion action.

The value must be between 0 and 10000, inclusive.

appId

string

App ID for an app conversion action.

ConversionActionStatus

Possible statuses of a conversion action.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Conversions will be recorded.
REMOVED Conversions will not be recorded.
HIDDEN Conversions will not be recorded and the conversion action will not appear in the UI.

ConversionActionType

Possible types of a conversion action.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AD_CALL Conversions that occur when a user clicks on an ad's call extension.
CLICK_TO_CALL Conversions that occur when a user on a mobile device clicks a phone number.
GOOGLE_PLAY_DOWNLOAD Conversions that occur when a user downloads a mobile app from the Google Play Store.
GOOGLE_PLAY_IN_APP_PURCHASE Conversions that occur when a user makes a purchase in an app through Android billing.
UPLOAD_CALLS Call conversions that are tracked by the advertiser and uploaded.
UPLOAD_CLICKS Conversions that are tracked by the advertiser and uploaded with attributed clicks.
WEBPAGE Conversions that occur on a webpage.
WEBSITE_CALL Conversions that occur when a user calls a dynamically-generated phone number from an advertiser's website.
STORE_SALES_DIRECT_UPLOAD Store Sales conversion based on first-party or third-party merchant data uploads. Only customers on the allowlist can use store sales direct upload types.
STORE_SALES Store Sales conversion based on first-party or third-party merchant data uploads and/or from in-store purchases using cards from payment networks. Only customers on the allowlist can use store sales types. Read only.
FIREBASE_ANDROID_FIRST_OPEN Android app first open conversions tracked via Firebase.
FIREBASE_ANDROID_IN_APP_PURCHASE Android app in app purchase conversions tracked via Firebase.
FIREBASE_ANDROID_CUSTOM Android app custom conversions tracked via Firebase.
FIREBASE_IOS_FIRST_OPEN iOS app first open conversions tracked via Firebase.
FIREBASE_IOS_IN_APP_PURCHASE iOS app in app purchase conversions tracked via Firebase.
FIREBASE_IOS_CUSTOM iOS app custom conversions tracked via Firebase.
THIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPEN Android app first open conversions tracked via Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE Android app in app purchase conversions tracked via Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM Android app custom conversions tracked via Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPEN iOS app first open conversions tracked via Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE iOS app in app purchase conversions tracked via Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM iOS app custom conversions tracked via Third Party App Analytics.
ANDROID_APP_PRE_REGISTRATION Conversions that occur when a user pre-registers a mobile app from the Google Play Store. Read only.
ANDROID_INSTALLS_ALL_OTHER_APPS Conversions that track all Google Play downloads which aren't tracked by an app-specific type. Read only.
FLOODLIGHT_ACTION Floodlight activity that counts the number of times that users have visited a particular webpage after seeing or clicking on one of an advertiser's ads. Read only.
FLOODLIGHT_TRANSACTION Floodlight activity that tracks the number of sales made or the number of items purchased. Can also capture the total value of each sale. Read only.
GOOGLE_HOSTED Conversions that track local actions from Google's products and services after interacting with an ad. Read only.
LEAD_FORM_SUBMIT Conversions reported when a user submits a lead form. Read only.
SALESFORCE Conversions that come from Salesforce. Read only.
SEARCH_ADS_360 Conversions imported from googleAds.search Ads 360 Floodlight data. Read only.
SMART_CAMPAIGN_AD_CLICKS_TO_CALL Call conversions that occur on Smart campaign Ads without call tracking setup, using Smart campaign custom criteria. Read only.
SMART_CAMPAIGN_MAP_CLICKS_TO_CALL The user clicks on a call element within Google Maps. Smart campaign only. Read only.
SMART_CAMPAIGN_MAP_DIRECTIONS The user requests directions to a business location within Google Maps. Smart campaign only. Read only.
SMART_CAMPAIGN_TRACKED_CALLS Call conversions that occur on Smart campaign Ads with call tracking setup, using Smart campaign custom criteria. Read only.
STORE_VISITS Conversions that occur when a user visits an advertiser's retail store. Read only.

ConversionActionCategory

The category of conversions that are associated with a ConversionAction.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DEFAULT Default category.
PAGE_VIEW User visiting a page.
PURCHASE Purchase, sales, or "order placed" event.
SIGNUP Signup user action.
LEAD Lead-generating action.
DOWNLOAD Software download action (as for an app).
ADD_TO_CART The addition of items to a shopping cart or bag on an advertiser site.
BEGIN_CHECKOUT When someone enters the checkout flow on an advertiser site.
SUBSCRIBE_PAID The start of a paid subscription for a product or service.
PHONE_CALL_LEAD A call to indicate interest in an advertiser's offering.
IMPORTED_LEAD A lead conversion imported from an external source into Google Ads.
SUBMIT_LEAD_FORM A submission of a form on an advertiser site indicating business interest.
BOOK_APPOINTMENT A booking of an appointment with an advertiser's business.
REQUEST_QUOTE A quote or price estimate request.
GET_DIRECTIONS A search for an advertiser's business location with intention to visit.
OUTBOUND_CLICK A click to an advertiser's partner's site.
CONTACT A call, SMS, email, chat or other type of contact to an advertiser.
ENGAGEMENT A website engagement event such as long site time or a Google Analytics (GA) Smart Goal. Intended to be used for GA, Firebase, GA Gold goal imports.
STORE_VISIT A visit to a physical store location.
STORE_SALE A sale occurring in a physical store.

ValueSettings

Settings related to the value for conversion events associated with this conversion action.

JSON representation
{
  "defaultValue": number,
  "defaultCurrencyCode": string,
  "alwaysUseDefaultValue": boolean
}
Fields
defaultValue

number

The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.

defaultCurrencyCode

string

The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.

alwaysUseDefaultValue

boolean

Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.

ConversionActionCountingType

Indicates how conversions for this action will be counted. For more information, see https://support.google.com/google-ads/answer/3438531.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ONE_PER_CLICK Count only one conversion per click.
MANY_PER_CLICK Count all conversions per click.

AttributionModelSettings

Settings related to this conversion action's attribution model.

JSON representation
{
  "attributionModel": enum (AttributionModel),
  "dataDrivenModelStatus": enum (DataDrivenModelStatus)
}
Fields
attributionModel

enum (AttributionModel)

The attribution model type of this conversion action.

dataDrivenModelStatus

enum (DataDrivenModelStatus)

Output only. The status of the data-driven attribution model for the conversion action.

AttributionModel

The attribution model that describes how to distribute credit for a particular conversion across potentially many prior interactions.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
EXTERNAL Uses external attribution.
GOOGLE_ADS_LAST_CLICK Attributes all credit for a conversion to its last click.
GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK Attributes all credit for a conversion to its first click using Google googleAds.search attribution.
GOOGLE_SEARCH_ATTRIBUTION_LINEAR Attributes credit for a conversion equally across all of its clicks using Google googleAds.search attribution.
GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY Attributes exponentially more credit for a conversion to its more recent clicks using Google googleAds.search attribution (half-life is 1 week).
GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED Attributes 40% of the credit for a conversion to its first and last clicks. Remaining 20% is evenly distributed across all other clicks. This uses Google googleAds.search attribution.
GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN Flexible model that uses machine learning to determine the appropriate distribution of credit among clicks using Google googleAds.search attribution.

DataDrivenModelStatus

Enumerates data driven model statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AVAILABLE The data driven model is available.
STALE The data driven model is stale. It hasn't been updated for at least 7 days. It is still being used, but will become expired if it does not get updated for 30 days.
EXPIRED The data driven model expired. It hasn't been updated for at least 30 days and cannot be used. Most commonly this is because there hasn't been the required number of events in a recent 30-day period.
NEVER_GENERATED The data driven model has never been generated. Most commonly this is because there has never been the required number of events in any 30-day period.

FirebaseSettings

Settings related to a Firebase conversion action.

JSON representation
{
  "eventName": string,
  "projectId": string
}
Fields
eventName

string

Output only. The event name of a Firebase conversion.

projectId

string

Output only. The Firebase project ID of the conversion.

ThirdPartyAppAnalyticsSettings

Settings related to a third party app analytics conversion action.

JSON representation
{
  "providerName": string,
  "eventName": string
}
Fields
providerName

string

Output only. Name of the third-party app analytics provider.

eventName

string

Output only. The event name of a third-party app analytics conversion.

Methods

get

Returns the requested conversion action.

mutate

Creates, updates or removes conversion actions.