ConversionAction

  • A conversion action is defined by its resource name, status, type, and origin.

  • Key attributes include category, value settings, counting type, and attribution model settings.

  • Tracking is facilitated by tag snippets, with specific settings for mobile apps, Firebase, third-party analytics, and Google Analytics 4.

  • Essential identification and configuration fields are id, name, primary_for_goal, owner_customer, and include_in_conversions_metric.

  • Lookback windows, phone call duration, and app ID are used for defining conversion events.

A conversion action.

Fields

resource_name

string

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

customers/{customer_id}/conversionActions/{conversion_action_id}

status

ConversionActionStatus

The status of this conversion action for conversion event accrual.

type

ConversionActionType

Immutable. The type of this conversion action.

origin

ConversionOrigin

Output only. The conversion origin of this conversion action.

category

ConversionActionCategory

The category of conversions reported for this conversion action.

value_settings

ValueSettings

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

counting_type

ConversionActionCountingType

How to count conversion events for the conversion action.

attribution_model_settings

AttributionModelSettings

Settings related to this conversion action's attribution model.

tag_snippets[]

TagSnippet

Output only. The snippets used for tracking conversions.

mobile_app_vendor

MobileAppVendor

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

firebase_settings

FirebaseSettings

Output only. Firebase settings for Firebase conversion types.

third_party_app_analytics_settings

ThirdPartyAppAnalyticsSettings

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

google_analytics_4_settings

GoogleAnalytics4Settings

Output only. Google Analytics 4 settings for Google Analytics 4 conversion types.

id

int64

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.

primary_for_goal

bool

If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.

owner_customer

string

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

include_in_conversions_metric

bool

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

click_through_lookback_window_days

int64

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

view_through_lookback_window_days

int64

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

phone_call_duration_seconds

int64

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.

app_id

string

App ID for an app conversion action.