REST Resource: advertisers.insertionOrders

Recurso: InsertOrder

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. 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. El ID único del pedido de inserción. Asignada por el sistema.
displayName

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.
insertionOrderType

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.
entityStatus

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.
updateTime

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".
partnerCosts[]

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.
pacing

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (Kpi)

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

Esto se conoce como el "Objetivo". en la Red de Display y La interfaz de Video 360
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

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.

InsertionOrderType

Los posibles tipos de un pedido de inserción.

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

Enumeraciones
INSERTION_ORDER_TYPE_UNSPECIFIED El tipo de pedido de inserción no se especifica o es desconocido.
RTB Ofertas en tiempo real.
OVER_THE_TOP Transmisión libre

KPI

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

Obligatorio. El tipo de KPI.
kpiAlgorithmId

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.
Campo de unión kpi_value. Obligatorio. El valor del KPI. El campo relevante corresponde a kpi_type. kpi_value puede ser solo uno de los siguientes:
kpiAmountMicros

string (int64 format)

Es el importe del objetivo, expresado en micrones 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)

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: 70,000 representa el 7% (0.07 decimal).
kpiString

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.

KpiType

Tipos posibles de indicadores clave de rendimiento (KPI).

Enumeraciones
KPI_TYPE_UNSPECIFIED No se especifica el tipo de KPI en esta versión o se desconoce.
KPI_TYPE_CPM El KPI es el CPM (costo por mil).
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 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 del porcentaje de conversiones por clic (conversiones por clic).
KPI_TYPE_IMPRESSION_CVR El KPI es el porcentaje de conversiones de impresiones (conversiones por impresión).
KPI_TYPE_VCPM El KPI es la 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 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 durante más de 10 segundos (porcentaje de impresiones medibles y que no se pueden omitir que estuvieron en 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 una 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)

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.
budgetSegments[]

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.

InsertionOrderAutomationType

Opciones posibles para automatizar la oferta y el presupuesto del pedido de inserción.

Enumeraciones
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED La opción de automatización de pedidos de inserción no se especificó o se desconoce 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 propietarias para optimizar el rendimiento definido por kpi. No hay automatización en la configuración de las ofertas.
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 líneas de pedido propietarias para optimizar el rendimiento definido por kpi.

InsertionOrderBudgetSegment

Son parámetros de configuración que controlan el presupuesto de un solo segmento del 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. La cantidad es en micros. Debe ser mayor que 0. Por ejemplo, 5,000,000,000 representa 500 unidades estándar de moneda.
description

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.
dateRange

object (DateRange)

Obligatorio. Es la configuración de 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.
campaignBudgetId

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.

OptimizationObjective

Posibles tipos de objetivos de optimización.

Enumeraciones
OPTIMIZATION_OBJECTIVE_UNSPECIFIED No se especificó el valor del tipo en esta versión o se desconoce.
CONVERSION Prioriza las impresiones que aumentan las ventas y las conversiones.
CLICK Priorice las impresiones que aumenten 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 mediante el algoritmo de ofertas personalizadas asignado.
NO_OBJECTIVE El objetivo no está definido. Se puede usar 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.

listAssignedTargetingOptions

 Se muestran las opciones de segmentación asignadas de un pedido de inserción en todos los tipos de segmentación.

patch

 Actualiza un pedido de inserción existente.