REST Resource: advertisers.insertionOrders

Recurso: InsertionOrder

Es 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 de la orden de inserción.
advertiserId

string (int64 format)

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

string (int64 format)

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

string (int64 format)

Solo salida. Es el ID único de la orden de inserción. El sistema lo asigna.
displayName

string

Es 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 durante la creación, el valor predeterminado es RTB.
entityStatus

enum (EntityStatus)

Es obligatorio. Controla si el pedido de inserción puede invertir su presupuesto y ofertar por el inventario.

  • En el caso del método insertionOrders.create, solo se permite ENTITY_STATUS_DRAFT. Para activar una orden 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 se puede cambiar al estado ENTITY_STATUS_DRAFT desde ningún otro estado.
  • Una orden de inserción no se puede establecer en ENTITY_STATUS_ACTIVE si su campaña principal no está activa.
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la última actualización de la orden de inserción. El sistema lo asigna.

Usa el RFC 3339, en el que el resultado generado siempre se normaliza según la zona horaria Z y usa 0, 3, 6 o 9 dígitos fraccionarios. 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 del socio asociados al pedido de inserción.

Si está ausente o 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)

Es 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)

Es 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 la integración del pedido de inserción.
kpi

object (Kpi)

Es obligatorio. Es el indicador clave de rendimiento (KPI) de la orden de inserción.

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

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (OptimizationObjective)

Es 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 orden de inserción determina qué parámetros de configuración y opciones son aplicables, como el formato de los anuncios o las opciones de segmentación.

Enumeraciones
INSERTION_ORDER_TYPE_UNSPECIFIED No se especificó el tipo de pedido de inserción o se desconoce.
RTB Licitaciones en tiempo real.
OVER_THE_TOP Es exagerado.

KPI

Es la configuración que controla el indicador clave de rendimiento (KPI) de un pedido de inserción.

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

enum (KpiType)

Es 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.
Campo de unión kpi_value. Es obligatorio. Es el valor del KPI. El campo pertinente corresponde al kpi_type. kpi_value puede ser solo uno de los siguientes:
kpiAmountMicros

string (int64 format)

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

Se aplica cuando 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.
kpiPercentageMicros

string (int64 format)

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

Se aplica cuando 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, 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.

KpiType

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

Enumeraciones
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 la 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 del porcentaje de conversiones de las impresiones (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 finalización de audio (reproducciones de audio completas por impresión).
KPI_TYPE_VIDEO_COMPLETION_RATE El KPI es el porcentaje de la tasa de finalización de video (vistas de video completas por impresión).
KPI_TYPE_CPCL El KPI se establece en CPCL (costo por escucha 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 la pantalla durante al menos 10 segundos).
KPI_TYPE_MAXIMIZE_PACING El KPI está configurado para maximizar el impacto de 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 de la orden de inserción.

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

enum (BudgetUnit)

Es 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 de la orden de inserción.

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

object (InsertionOrderBudgetSegment)

Es obligatorio. Es la lista de segmentos del presupuesto. Usa un segmento de presupuesto para especificar un presupuesto determinado para un período específico durante el que se publica una orden de inserción.

InsertionOrderAutomationType

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

Enumeraciones
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED No se especificó o se desconoce la opción de automatización de la orden de inserción en esta versión.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Asignación automática del presupuesto Permite que el sistema transfiera automáticamente el presupuesto a las líneas de pedido propietarias para optimizar el rendimiento definido por kpi. No hay automatización en la configuración de la oferta.
INSERTION_ORDER_AUTOMATION_TYPE_NONE No hay automatización de la oferta ni del 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 transfiera el presupuesto a las líneas de artículos propias para optimizar el rendimiento definido por kpi.

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)

Es obligatorio. Es el importe del presupuesto que el pedido de inserción invertirá para el dateRange determinado. El importe está en micros. 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 del presupuesto. Se puede usar para ingresar información de la orden de compra para cada segmento de presupuesto y hacer que esa información se imprima en las facturas.

Debe estar codificado en UTF-8.
dateRange

object (DateRange)

Es obligatorio. Es la configuración de las fechas de inicio y finalización del segmento de presupuesto. Se resuelven en relación con la zona horaria del anunciante principal.

  • Cuando crees un segmento de presupuesto nuevo, 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, y ambos deben ser anteriores al año 2037.
campaignBudgetId

string (int64 format)

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

OptimizationObjective

Son los tipos posibles de objetivos de optimización.

Enumeraciones
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 aplicaciones y las tiendas de aplicaciones.
BRAND_AWARENESS Prioriza las impresiones de 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

 Enumera las órdenes de inserción de un anunciante.

listAssignedTargetingOptions

 Enumera las opciones de segmentación asignadas de una orden de inserción en todos los tipos de segmentación.

patch

 Actualiza una orden de inserción existente.