- Resource: InsertionOrder
- InsertionOrderType
- InsertionOrderBudget
- InsertionOrderAutomationType
- InsertionOrderBudgetSegment
- BillableOutcome
- 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. |
performanceGoal |
Required. Performance goal of the insertion order. |
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. |
billableOutcome |
Immutable. The billable outcome of the insertion order. |
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. |
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 performanceGoal . 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 performanceGoal . |
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 with a length of no more than 80 characters. |
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 |
BillableOutcome
Possible billable outcomes for an insertion order.
Enums | |
---|---|
BILLABLE_OUTCOME_UNSPECIFIED |
Unspecified billable outcome. |
BILLABLE_OUTCOME_PAY_PER_IMPRESSION |
Pay per impressions. |
BILLABLE_OUTCOME_PAY_PER_CLICK |
Pay per click. |
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION |
Pay per active view. |
Methods |
|
---|---|
|
Lists assigned targeting options of an insertion order across targeting types. |
|
Creates a new insertion order. |
|
Deletes an insertion order. |
|
Gets an insertion order. |
|
Lists insertion orders in an advertiser. |
|
Updates an existing insertion order. |