InsertionOrder

import type { InsertionOrder } from "https://googleapis.deno.dev/v1/displayvideo:v4.ts";

A single insertion order.

interface InsertionOrder {

readonly advertiserId?: bigint;

bidStrategy?: BiddingStrategy;

budget?: InsertionOrderBudget;

campaignId?: bigint;

displayName?: string;

entityStatus?:

| "ENTITY_STATUS_UNSPECIFIED"

| "ENTITY_STATUS_ACTIVE"

| "ENTITY_STATUS_ARCHIVED"

| "ENTITY_STATUS_DRAFT"

| "ENTITY_STATUS_PAUSED"

| "ENTITY_STATUS_SCHEDULED_FOR_DELETION";

frequencyCap?: FrequencyCap;

readonly insertionOrderId?: bigint;

insertionOrderType?: "INSERTION_ORDER_TYPE_UNSPECIFIED" | "RTB" | "OVER_THE_TOP";

integrationDetails?: IntegrationDetails;

kpi?: Kpi;

readonly name?: string;

optimizationObjective?:

| "OPTIMIZATION_OBJECTIVE_UNSPECIFIED"

| "CONVERSION"

| "CLICK"

| "BRAND_AWARENESS"

| "CUSTOM"

| "NO_OBJECTIVE";

pacing?: Pacing;

partnerCosts?: PartnerCost[];

readonly reservationType?:

| "RESERVATION_TYPE_UNSPECIFIED"

| "RESERVATION_TYPE_NOT_GUARANTEED"

| "RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED"

| "RESERVATION_TYPE_TAG_GUARANTEED"

| "RESERVATION_TYPE_PETRA_VIRAL"

| "RESERVATION_TYPE_INSTANT_RESERVE";

readonly updateTime?: Date;

}

§Properties

readonly advertiserId?: bigint

[src]

Output only. The unique ID of the advertiser the insertion order belongs to.

bidStrategy?: BiddingStrategy

[src]

Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.

budget?: InsertionOrderBudget

[src]

Required. The budget allocation settings of the insertion order.

campaignId?: bigint

[src]

Required. Immutable. The unique ID of the campaign that the insertion order belongs to.

displayName?: string

[src]

Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.

[src]

Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only ENTITY_STATUS_DRAFT is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to ENTITY_STATUS_ACTIVE after creation. * An insertion order cannot be changed back to ENTITY_STATUS_DRAFT status from any other status. * An insertion order cannot be set to ENTITY_STATUS_ACTIVE if its parent campaign is not active.

frequencyCap?: FrequencyCap

[src]

Required. The frequency capping setting of the insertion order.

readonly insertionOrderId?: bigint

[src]

Output only. The unique ID of the insertion order. Assigned by the system.

insertionOrderType?: "INSERTION_ORDER_TYPE_UNSPECIFIED" | "RTB" | "OVER_THE_TOP"

[src]

Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to RTB.

integrationDetails?: IntegrationDetails

[src]

Optional. Additional integration details of the insertion order.

kpi?: Kpi

[src]

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.

readonly name?: string

[src]

Output only. The resource name of the insertion order.

[src]

Optional. Required. The optimization objective of the insertion order.

pacing?: Pacing

[src]

Required. The budget spending speed setting of the insertion order. pacing_type PACING_TYPE_ASAP is not compatible with pacing_period PACING_PERIOD_FLIGHT.

partnerCosts?: PartnerCost[]

[src]

Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.

[src]

Output only. The reservation type of the insertion order.

readonly updateTime?: Date

[src]

Output only. The timestamp when the insertion order was last updated. Assigned by the system.