REST Resource: advertisers.insertionOrders

Recurso: InsertionOrder

Un solo pedido de inserción

Representación JSON 
{
  "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)
}
Campos
name

string

Solo salida. Es el nombre del recurso del pedido de inserción.
advertiserId

string (int64 format)

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

string (int64 format)

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

string (int64 format)

Solo salida. Es el ID único del pedido de inserción. Asignado por el sistema.
displayName

string

Obligatorio. Es el nombre visible del pedido de inserción.

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

enum (InsertionOrderType)

Opcional. Es el tipo de pedido de inserción.

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

enum (EntityStatus)

Obligatorio. Controla si el pedido de inserción puede invertir su presupuesto y ofertar por 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.
  • No se puede volver a cambiar el estado de un pedido de inserción a ENTITY_STATUS_DRAFT desde ningún otro estado.
  • No se puede establecer un pedido de inserción como ENTITY_STATUS_ACTIVE si su campaña superior no está activa.
updateTime

string (Timestamp format)

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

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
partnerCosts[]

object (PartnerCost)

Opcional. Son los costos de socio asociados al pedido de inserción.

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

object (Pacing)

Obligatorio. Es el parámetro de configuración de la velocidad de inversión del presupuesto del pedido de inserción.

pacingType PACING_TYPE_ASAP no es compatible con pacingPeriod PACING_PERIOD_FLIGHT.
frequencyCap

object (FrequencyCap)

Obligatorio. Es el parámetro de configuración de limitación de frecuencia del pedido de inserción.
integrationDetails

object (IntegrationDetails)

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

object (Kpi)

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

En la interfaz de Display & Video 360, se representa como el"Objetivo ".
budget

object (InsertionOrderBudget)

Obligatorio. Es la configuración de asignación de presupuesto del pedido de inserción.
bidStrategy

object (BiddingStrategy)

Opcional. Es la estrategia de ofertas del pedido de inserción. De forma predeterminada, se establece fixedBid.

Si el campo automationType de budget se establece en INSERTION_ORDER_AUTOMATION_TYPE_BUDGET o INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET, el pedido de inserción impondrá esta estrategia de ofertas en sus líneas de pedido. Si una estrategia de ofertas impuesta no es compatible con el parámetro de configuración enableOptimizedTargeting de una línea de pedido, se actualizará el parámetro de configuración de la segmentación optimizada.
reservationType

enum (ReservationType)

Solo salida. Es el tipo de reservación del pedido de inserción.
optimizationObjective

enum (OptimizationObjective)

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

InsertionOrderType

Son los tipos posibles de un pedido de inserción.

El tipo de pedido de inserción determina qué parámetros de configuración y opciones se aplican, como el formato de los anuncios o las opciones de segmentación.

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED No se especificó el tipo de pedido de inserción o es desconocido.
RTB Licitación en tiempo real
OVER_THE_TOP Exagerada
OUT_OF_HOME Espacios públicos

KPI

Son los parámetros de configuración que controlan el indicador clave de rendimiento (KPI) de un pedido de inserción.

Representación JSON 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of mutually exclusive fields.
}
Campos
kpiType

enum (KpiType)

Obligatorio. Es el tipo de KPI.
kpiAlgorithmId

string (int64 format)

Opcional. Es el 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.
Obligatorio. Es el valor del KPI. El campo relevante corresponde al kpi_type. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
kpiAmountMicros

string (int64 format)

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

Se aplica cuando kpiType es uno de los siguientes valores:

  • 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.
kpiPercentageMicros

string (int64 format)

Es la representación decimal del porcentaje objetivo en micros.

Se aplica cuando kpiType es uno de los siguientes valores:

  • 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: 70000 representa el 7% (decimal 0.07).
kpiString

string

Es una cadena de KPI, que puede estar vacía. Debe estar codificado en UTF-8 y tener una longitud de no más de 100 caracteres.

Se aplica cuando kpiType es KPI_TYPE_OTHER.
Fin de los campos mutuamente excluyentes.

KpiType

Son los posibles tipos de indicadores clave de rendimiento (KPI).

Enums
KPI_TYPE_UNSPECIFIED El tipo de KPI no se especificó o es desconocido en esta versión.
KPI_TYPE_CPM El KPI es el CPM (costo por cada mil impresiones).
KPI_TYPE_CPC El KPI es el CPC (costo por clic).
KPI_TYPE_CPA El KPI es el CPA (costo por acción).
KPI_TYPE_CTR El KPI es el porcentaje de CTR (tasa de clics).
KPI_TYPE_VIEWABILITY El KPI es el porcentaje de visibilidad.
KPI_TYPE_CPIAVC El KPI es el CPIAVC (costo por impresión audible y visible al finalizar).
KPI_TYPE_CPE El KPI es el CPE (costo por participación).
KPI_TYPE_CPV El KPI se establece en CPV (costo por vista).
KPI_TYPE_CLICK_CVR El KPI es el porcentaje de conversiones por clic (conversiones por clic).
KPI_TYPE_IMPRESSION_CVR El KPI es el porcentaje de conversiones por impresión (conversiones por impresión).
KPI_TYPE_VCPM El KPI es el vCPM (costo por cada mil impresiones visibles).
KPI_TYPE_VTR El KPI es el porcentaje de la tasa de vistas de YouTube (vistas de YouTube por impresión).
KPI_TYPE_AUDIO_COMPLETION_RATE El KPI es el porcentaje de la tasa de reproducciones de audio completas (reproducciones de audio completas por impresión).
KPI_TYPE_VIDEO_COMPLETION_RATE El KPI es el porcentaje de la tasa de vistas completas de video (vistas completas de video por impresión).
KPI_TYPE_CPCL El KPI se establece en CPCL (costo por reproducción de audio completa).
KPI_TYPE_CPCV El KPI se establece en CPCV (costo por vista de video completa).
KPI_TYPE_TOS10 El KPI se establece en la tasa de tiempo en pantalla de más de 10 segundos (porcentaje de impresiones medibles que no se pueden omitir y que estuvieron en pantalla durante al menos 10 segundos).
KPI_TYPE_MAXIMIZE_PACING El KPI se establece para maximizar el impacto en la marca y, al mismo tiempo, priorizar la inversión de todo el presupuesto.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST El KPI se establece en el valor de impresión personalizado dividido por el costo.
KPI_TYPE_OTHER El KPI es algún otro valor.

InsertionOrderBudget

Es la configuración que controla cómo se asigna el presupuesto del pedido de inserción.

Representación JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Campos
budgetUnit

enum (BudgetUnit)

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

enum (InsertionOrderAutomationType)

Opcional. 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 en la creación, el valor predeterminado es INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

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

InsertionOrderAutomationType

Son las opciones posibles para automatizar la oferta y el presupuesto del pedido de inserción.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED La opción de automatización del pedido de inserción no se especificó o es desconocida en esta versión.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Asignación automática del presupuesto Permite que el sistema cambie automáticamente el presupuesto a las líneas de pedido de propiedad para optimizar el rendimiento definido por kpi. No hay automatización en la configuración de ofertas.
INSERTION_ORDER_AUTOMATION_TYPE_NONE No se automatizan las ofertas ni el presupuesto a nivel del pedido de inserción. La oferta y el presupuesto se deben configurar de forma manual a nivel de la línea de pedido.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Permite que el sistema ajuste automáticamente las ofertas y cambie el presupuesto a las líneas de pedido propias para optimizar el rendimiento definido por bidStrategy.

InsertionOrderBudgetSegment

Es la configuración que controla el presupuesto de un solo segmento de presupuesto.

Representación JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Campos
budgetAmountMicros

string (int64 format)

Obligatorio. Es el importe del presupuesto que invertirá el pedido de inserción para el dateRange determinado. El importe se expresa en microunidades. Debe ser mayor que 0. Por ejemplo, 500000000 representa 500 unidades estándar de la moneda.
description

string

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

Debe estar codificado en UTF-8.
dateRange

object (DateRange)

Obligatorio. La configuración de la fecha de inicio y finalización del segmento de presupuesto. Se resuelven en relación con la zona horaria del anunciante superior.

  • Cuando crees un segmento de presupuesto nuevo, tanto startDate como endDate deben ser fechas futuras.
  • 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.
campaignBudgetId

string (int64 format)

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

OptimizationObjective

Son los tipos posibles de objetivos de optimización.

Enums
OPTIMIZATION_OBJECTIVE_UNSPECIFIED El valor del tipo no se especificó o es desconocido en esta versión.
CONVERSION Prioriza las impresiones que aumentan las ventas y las conversiones.
CLICK Prioriza las impresiones que aumentan el tráfico del sitio web, las apps y las tiendas de aplicaciones.
BRAND_AWARENESS Prioriza las impresiones de una calidad específica.
CUSTOM El objetivo se define según el algoritmo de ofertas personalizadas asignado.
NO_OBJECTIVE No se definió el objetivo. Se puede utilizar cualquier KPI o estrategia de ofertas.

Métodos

create

 Crea un pedido de inserción nuevo.

delete

 Borra un pedido de inserción.

get

 Obtiene un pedido de inserción.

list

 Muestra una lista de los pedidos de inserción de un anunciante.

patch

 Actualiza un pedido de inserción existente.