- Resource: InsertionOrder
- InsertionOrderType
- Kpi
- KpiType
- InsertionOrderBudget
- InsertionOrderAutomationType
- InsertionOrderBudgetSegment
- OptimizationObjective
- Methods
Resource: InsertionOrder
A single insertion order.
JSON representation |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "displayName": string, "insertionOrderType": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the insertion order. |
advertiserId |
Output only. The unique ID of the advertiser the insertion order belongs to. |
campaignId |
Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
insertionOrderId |
Output only. The unique ID of the insertion order. Assigned by the system. |
displayName |
Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. |
insertionOrderType |
The type of insertion order. If this field is unspecified in creation, the value defaults to |
entityStatus |
Required. Controls whether or not the insertion order can spend its budget and bid on inventory.
|
updateTime |
Output only. The timestamp when the insertion order was last updated. Assigned by the system. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
partnerCosts[] |
The partner costs associated with the insertion order. If absent or empty in |
pacing |
Required. The budget spending speed setting of the insertion order. |
frequencyCap |
Required. The frequency capping setting of the insertion order. |
integrationDetails |
Additional integration details of the insertion order. |
kpi |
Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface. |
budget |
Required. The budget allocation settings of the insertion order. |
bidStrategy |
The bidding strategy of the insertion order. By default, |
reservationType |
Output only. The reservation type of the insertion order. |
optimizationObjective |
Optional. The optimization objective of the insertion order. This field is only available to allowlisted customers. If a customer is not allowlisted, this field will be null and attempts to set it will return an error. |
InsertionOrderType
Possible types of an Insertion Order.
The type of the Insertion Order determines which settings and options are applicable, such as the format of the ads or targeting options.
Enums | |
---|---|
INSERTION_ORDER_TYPE_UNSPECIFIED |
Insertion order type is not specified or is unknown. |
RTB |
Real-time bidding. |
OVER_THE_TOP |
Over-the-top. |
Kpi
Settings that control the key performance indicator, or KPI, of an insertion order.
JSON representation |
---|
{ "kpiType": enum ( |
Fields | |
---|---|
kpiType |
Required. The type of KPI. |
kpiAlgorithmId |
Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected. |
Union field kpi_value . Required. The value of the KPI. The relevant field corresponds to the kpi_type . kpi_value can be only one of the following: |
|
kpiAmountMicros |
The goal amount, in micros of the advertiser's currency. Applicable when
For example: 1500000 represents 1.5 standard units of the currency. |
kpiPercentageMicros |
The decimal representation of the goal percentage in micros. Applicable when
For example: 70000 represents 7% (decimal 0.07). |
kpiString |
A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when |
KpiType
Possible key performance indicator (KPI) types.
Enums | |
---|---|
KPI_TYPE_UNSPECIFIED |
KPI type is not specified or is unknown in this version. |
KPI_TYPE_CPM |
The KPI is CPM (cost per mille). |
KPI_TYPE_CPC |
The KPI is CPC (cost per click). |
KPI_TYPE_CPA |
The KPI is CPA (cost per action). |
KPI_TYPE_CTR |
The KPI is CTR (click-through rate) percentage. |
KPI_TYPE_VIEWABILITY |
The KPI is Viewability percentage. |
KPI_TYPE_CPIAVC |
The KPI is CPIAVC (cost per impression audible and visible at completion). |
KPI_TYPE_CPE |
The KPI is CPE (cost per engagement). |
KPI_TYPE_CPV |
The KPI is set in CPV (cost per view). |
KPI_TYPE_CLICK_CVR |
The KPI is click conversion rate (conversions per click) percentage. |
KPI_TYPE_IMPRESSION_CVR |
The KPI is impression conversion rate (conversions per impression) percentage. |
KPI_TYPE_VCPM |
The KPI is VCPM (cost per thousand viewable impressions). |
KPI_TYPE_VTR |
The KPI is YouTube view rate (YouTube views per impression) percentage. |
KPI_TYPE_AUDIO_COMPLETION_RATE |
The KPI is audio completion rate (complete audio listens per impression) percentage. |
KPI_TYPE_VIDEO_COMPLETION_RATE |
The KPI is video completion rate (complete video views per impression) percentage. |
KPI_TYPE_CPCL |
The KPI is set in CPCL (cost per complete audio listen). |
KPI_TYPE_CPCV |
The KPI is set in CPCV (cost per complete video view). |
KPI_TYPE_TOS10 |
The KPI is set in rate of time on screen 10+ seconds (Percentage of measurable, non-skippable impressions that were on the screen for at least 10 seconds). |
KPI_TYPE_MAXIMIZE_PACING |
The KPI is set to maximize brand impact while prioritizing spending the full budget. |
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST |
The KPI is set in custom impression value divided by cost. |
KPI_TYPE_OTHER |
The KPI is some other value. |
InsertionOrderBudget
Settings that control how insertion order budget is allocated.
JSON representation |
---|
{ "budgetUnit": enum ( |
Fields | |
---|---|
budgetUnit |
Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. |
automationType |
The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to |
budgetSegments[] |
Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. |
InsertionOrderAutomationType
Possible options for automating insertion order bid and budget.
Enums | |
---|---|
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED |
Insertion order automation option is not specified or is unknown in this version. |
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET |
Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi . No automation on bid settings. |
INSERTION_ORDER_AUTOMATION_TYPE_NONE |
No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level. |
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET |
Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi . |
InsertionOrderBudgetSegment
Settings that control the budget of a single budget segment.
JSON representation |
---|
{
"budgetAmountMicros": string,
"description": string,
"dateRange": {
object ( |
Fields | |
---|---|
budgetAmountMicros |
Required. The budget amount the insertion order will spend for the given |
description |
The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. |
dateRange |
Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone.
|
campaignBudgetId |
The |
OptimizationObjective
Possible types of the optimization objectives.
Enums | |
---|---|
OPTIMIZATION_OBJECTIVE_UNSPECIFIED |
Type value is not specified or is unknown in this version. |
CONVERSION |
Prioritize impressions that increase sales and conversions. |
CLICK |
Prioritize impressions that increase website traffic, apps, app stores. |
BRAND_AWARENESS |
Prioritize impressions of specific quality. |
CUSTOM |
Objective is defined by the assigned custom bidding algorithm. |
NO_OBJECTIVE |
Objective is not defined. Any KPI or bidding strategy can be used. |
Methods |
|
---|---|
|
Creates a new insertion order. |
|
Deletes an insertion order. |
|
Gets an insertion order. |
|
Lists insertion orders in an advertiser. |
|
Lists assigned targeting options of an insertion order across targeting types. |
|
Updates an existing insertion order. |