PerformanceGoal
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003ePerformanceGoal settings determine the performance objectives for campaigns and insertion orders, using various types like CPM, CPC, CPA, CTR, etc.\u003c/p\u003e\n"],["\u003cp\u003ePerformance goals can be specified as a monetary amount (e.g., cost per click), a percentage (e.g., click-through rate), or a custom KPI string.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePerformanceGoalType\u003c/code\u003e field defines the type of performance goal being set, such as CPM, CPC, CPA, CTR, and others, while \u003ccode\u003eperformance_goal_value\u003c/code\u003e holds the actual goal value.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eperformance_goal_value\u003c/code\u003e can be represented as \u003ccode\u003eperformanceGoalAmountMicros\u003c/code\u003e for cost-based goals, \u003ccode\u003eperformanceGoalPercentageMicros\u003c/code\u003e for percentage-based goals, and \u003ccode\u003eperformanceGoalString\u003c/code\u003e for custom goals.\u003c/p\u003e\n"]]],["This document outlines the settings for campaign or insertion order performance goals. Key actions include defining the `performanceGoalType` (e.g., CPM, CPC, CTR), and setting its corresponding value via `performanceGoalAmountMicros` (for currency-based goals), `performanceGoalPercentageMicros` (for percentage-based goals), or `performanceGoalString` (for other KPIs). There is an enumeration `PerformanceGoalType` with types like `CPM`, `CPC`, `CPA`, `CTR`, `VIEWABILITY`, etc. Each goal type specifies the required data type for the performance goal value.\n"],null,["# PerformanceGoal\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [PerformanceGoalType](#PerformanceGoalType)\n\nSettings that control the performance goal of a campaign or insertion order.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"performanceGoalType\": enum (/display-video/api/v1beta2/reference/rest/v1beta2/PerformanceGoal#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`. } ``` |\n\n| Fields ||\n|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `performanceGoalType` | `enum (`[PerformanceGoalType](/display-video/api/v1beta2/reference/rest/v1beta2/PerformanceGoal#PerformanceGoalType)`)` Required. The type of the performance goal. |\n| Union field `performance_goal_value`. Required. The performance goal value corresponding to a given [performance_goal_type](/display-video/api/v1beta2/reference/rest/v1beta2/PerformanceGoal#FIELDS.performance_goal_type). `performance_goal_value` can be only one of the following: ||\n| `performanceGoalAmountMicros` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The goal amount, in micros of the advertiser's currency. Applicable when [performanceGoalType](/display-video/api/v1beta2/reference/rest/v1beta2/PerformanceGoal#FIELDS.performance_goal_type) 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. |\n| `performanceGoalPercentageMicros` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The decimal representation of the goal percentage in micros. Applicable when [performanceGoalType](/display-video/api/v1beta2/reference/rest/v1beta2/PerformanceGoal#FIELDS.performance_goal_type) 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). |\n| `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](/display-video/api/v1beta2/reference/rest/v1beta2/PerformanceGoal#FIELDS.performance_goal_type) is set to `PERFORMANCE_GOAL_TYPE_OTHER`. |\n\nPerformanceGoalType\n-------------------\n\nPossible types of performance goals.\n\n| Enums ||\n|-----------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| `PERFORMANCE_GOAL_TYPE_UNSPECIFIED` | Performance goal type is not specified or is unknown in this version. |\n| `PERFORMANCE_GOAL_TYPE_CPM` | The performance goal is set in CPM (cost per mille). |\n| `PERFORMANCE_GOAL_TYPE_CPC` | The performance goal is set in CPC (cost per click). |\n| `PERFORMANCE_GOAL_TYPE_CPA` | The performance goal is set in CPA (cost per action). |\n| `PERFORMANCE_GOAL_TYPE_CTR` | The performance goal is set in CTR (click-through rate) percentage. |\n| `PERFORMANCE_GOAL_TYPE_VIEWABILITY` | The performance goal is set in Viewability percentage. |\n| `PERFORMANCE_GOAL_TYPE_CPIAVC` | The performance goal is set as CPIAVC (cost per impression audible and visible at completion). |\n| `PERFORMANCE_GOAL_TYPE_CPE` | The performance goal is set in CPE (cost per engagement). |\n| `PERFORMANCE_GOAL_TYPE_CLICK_CVR` | The performance goal is set in click conversion rate (conversions per click) percentage. |\n| `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` | The performance goal is set in impression conversion rate (conversions per impression) percentage. |\n| `PERFORMANCE_GOAL_TYPE_VCPM` | The performance goal is set in VCPM (cost per thousand viewable impressions). |\n| `PERFORMANCE_GOAL_TYPE_VTR` | The performance goal is set in YouTube view rate (YouTube views per impression) percentage. |\n| `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` | The performance goal is set in audio completion rate (complete audio listens per impression) percentage. |\n| `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` | The performance goal is set in video completion rate (complete video views per impression) percentage. |\n| `PERFORMANCE_GOAL_TYPE_OTHER` | The performance goal is set to Other. |"]]
