REST Resource: advertisers.insertionOrders

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}

string

Solo salida. El nombre del recurso del pedido de inserción.

string (int64 format)

Solo salida. Es el ID único del anunciante al que pertenece el pedido de inserción.

string (int64 format)

Obligatorio. Inmutable. Es el ID único de la campaña a la que pertenece el pedido de inserción.

string (int64 format)

Solo salida. El ID único del pedido de inserción. Asignada por el sistema.

string

Obligatorio. El nombre visible del pedido de inserción.

Debe estar codificado en UTF-8, con un tamaño máximo de 240 bytes.

enum (InsertionOrderType)

Es el tipo de pedido de inserción.

Si no se especifica este campo durante la creación, el valor predeterminado es RTB.

enum (EntityStatus)

Obligatorio. Controla si el pedido de inserción puede invertir su presupuesto y oferta en el inventario.

• Para el método insertionOrders.create, solo se permite ENTITY_STATUS_DRAFT. Para activar un pedido de inserción, usa el método insertionOrders.patch y actualiza el estado a ENTITY_STATUS_ACTIVE después de la creación.
• Un pedido de inserción no puede volver a cambiar el estado ENTITY_STATUS_DRAFT desde ningún otro estado.
• No se puede establecer un pedido de inserción como ENTITY_STATUS_ACTIVE si la campaña principal no está activa.

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización del pedido de inserción. Asignada por el sistema.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

object (PartnerCost)

Los costos del socio asociados con el pedido de inserción.

Si el método insertionOrders.create no está presente o está vacío, el pedido de inserción recién creado heredará los costos del socio de la configuración del socio.

object (Pacing)

Obligatorio. Es la configuración de velocidad de inversión del presupuesto del pedido de inserción.

object (FrequencyCap)

Obligatorio. La configuración de limitación de frecuencia del pedido de inserción.

object (IntegrationDetails)

Son los detalles adicionales de integración del pedido de inserción.

object (Kpi)

Obligatorio. El indicador clave de rendimiento (KPI) del pedido de inserción.

Esto se conoce como el "Objetivo" en la interfaz de Display & Video 360.

object (InsertionOrderBudget)

Obligatorio. La configuración de asignación del presupuesto del pedido de inserción.

object (BiddingStrategy)

La estrategia de oferta del pedido de inserción. De forma predeterminada, se establece fixedBid.

enum (ReservationType)

Solo salida. El tipo de reserva del pedido de inserción.

enum (OptimizationObjective)

Opcional. Es el objetivo de optimización del pedido de inserción.

Este campo solo está disponible para los clientes incluidos en la lista de entidades permitidas. Si un cliente no está incluido en la lista de entidades permitidas, este campo será nulo y, si intentas configurarlo, se mostrará un error.

{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}

enum (KpiType)

Obligatorio. El tipo de KPI.

string (int64 format)

Opcional. ID del algoritmo de ofertas personalizadas asociado con KPI_CUSTOM_Impression_VALUE_OVER_COST. Este campo se ignora si no se selecciona el KPI adecuado.

string (int64 format)

Es el importe objetivo, expresado en micrones de la moneda del anunciante.

Se aplica cuando el valor de kpiType es uno de los siguientes:

• KPI_TYPE_CPM
• KPI_TYPE_CPC
• KPI_TYPE_CPA
• KPI_TYPE_CPIAVC
• KPI_TYPE_VCPM

Por ejemplo, 1500000 representa 1.5 unidades estándar de la moneda.

string (int64 format)

Representación decimal del porcentaje objetivo en micros.

Se aplica cuando el valor de kpiType es uno de los siguientes:

• KPI_TYPE_CTR
• KPI_TYPE_VIEWABILITY
• KPI_TYPE_CLICK_CVR
• KPI_TYPE_IMPRESSION_CVR
• KPI_TYPE_VTR
• KPI_TYPE_AUDIO_COMPLETION_RATE
• KPI_TYPE_VIDEO_COMPLETION_RATE

Por ejemplo: 70,000 representa el 7% (0.07 decimal).

string

Una cadena de KPI, que puede estar vacía. Debe estar codificado en UTF-8 y con una longitud máxima de 100 caracteres.

Se aplica cuando kpiType es KPI_TYPE_OTHER.

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

Obligatorio. Inmutable. La unidad de presupuesto especifica si el presupuesto se basa en la moneda o en las impresiones.

enum (InsertionOrderAutomationType)

Es el tipo de automatización que se usa para administrar la oferta y el presupuesto del pedido de inserción.

Si no se especifica este campo durante la creación, el valor predeterminado es INSERTION_ORDER_AUTOMATION_TYPE_NONE.

object (InsertionOrderBudgetSegment)

Obligatorio. Es la lista de segmentos del presupuesto. Usa un segmento de presupuesto para especificar un presupuesto específico durante un período determinado en el que se publicará un pedido de inserción.

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

string (int64 format)

Obligatorio. Es el importe del presupuesto que invertirá el pedido de inserción para el dateRange determinado. La cantidad es en micros. Debe ser mayor que 0. Por ejemplo, 5,000,000,000 representa 500 unidades estándar de moneda.

string

Es la descripción del segmento del presupuesto. Se puede usar para ingresar la información de la orden de compra de cada segmento del presupuesto y hacer que se imprima en las facturas.

Debe estar codificado en UTF-8.

object (DateRange)

Obligatorio. Es la configuración de la fecha de inicio y finalización del segmento del presupuesto. Se resuelven según la zona horaria del anunciante principal.

• Cuando se crea un nuevo segmento de presupuesto, tanto startDate como endDate deben estar en el futuro.
• Un segmento de presupuesto existente con un startDate en el pasado tiene un endDate mutable, pero un startDate inmutable.
• endDate debe ser startDate o posterior, ambos antes del año 2037.

string (int64 format)

Es el budgetId del presupuesto de la campaña en el que forma parte este segmento de presupuesto del pedido de inserción.