PerformanceGoal

  • Display & Video 360 API v1 has been sunset.

  • Performance goals are settings that control the performance objective of a campaign or insertion order.

  • The PerformanceGoal object defines the type and value of a performance goal.

  • The performanceGoalType field is required and specifies the kind of performance goal being set.

  • The value of the performance goal is defined by one of three union fields: performanceGoalAmountMicros, performanceGoalPercentageMicros, or performanceGoalString, depending on the performanceGoalType.

Settings that control the performance goal of a campaign or insertion order.

JSON representation 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
Fields
performanceGoalType

enum (PerformanceGoalType)

Required. The type of the performance goal.
Union field performance_goal_value. Required. The performance goal value corresponding to a given performance_goal_type. performance_goal_value can be only one of the following:
performanceGoalAmountMicros

string (int64 format)

The goal amount, in micros of the advertiser's currency.

Applicable when performanceGoalType is one of:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

For example 1500000 represents 1.5 standard units of the currency.
performanceGoalPercentageMicros

string (int64 format)

The decimal representation of the goal percentage in micros.

Applicable when performanceGoalType is one of:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

For example, 70000 represents 7% (decimal 0.07).
performanceGoalString

string

A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters.

Applicable when performanceGoalType is set to PERFORMANCE_GOAL_TYPE_OTHER.

PerformanceGoalType

Possible types of performance goals.

Enums
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Performance goal type is not specified or is unknown in this version.
PERFORMANCE_GOAL_TYPE_CPM The performance goal is set in CPM (cost per mille).
PERFORMANCE_GOAL_TYPE_CPC The performance goal is set in CPC (cost per click).
PERFORMANCE_GOAL_TYPE_CPA The performance goal is set in CPA (cost per action).
PERFORMANCE_GOAL_TYPE_CTR The performance goal is set in CTR (click-through rate) percentage.
PERFORMANCE_GOAL_TYPE_VIEWABILITY The performance goal is set in Viewability percentage.
PERFORMANCE_GOAL_TYPE_CPIAVC The performance goal is set as CPIAVC (cost per impression audible and visible at completion).
PERFORMANCE_GOAL_TYPE_CPE The performance goal is set in CPE (cost per engagement).
PERFORMANCE_GOAL_TYPE_CLICK_CVR The performance goal is set in click conversion rate (conversions per click) percentage.
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR The performance goal is set in impression conversion rate (conversions per impression) percentage.
PERFORMANCE_GOAL_TYPE_VCPM The performance goal is set in VCPM (cost per thousand viewable impressions).
PERFORMANCE_GOAL_TYPE_VTR The performance goal is set in YouTube view rate (YouTube views per impression) percentage.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE The performance goal is set in audio completion rate (complete audio listens per impression) percentage.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE The performance goal is set in video completion rate (complete video views per impression) percentage.
PERFORMANCE_GOAL_TYPE_OTHER The performance goal is set to Other.