REST Resource: advertisers.insertionOrders

Recurso: InserciónOrder

Un único 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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
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. 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. Lo asigna 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 ofertar 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 su creación.
  • Un pedido de inserción no se puede volver a cambiar de ningún otro estado al estado ENTITY_STATUS_DRAFT.
  • 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. Lo asigna el sistema.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con 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 está ausente o está vacío en el método insertionOrders.create, el pedido de inserción recién creado heredará los costos de socios de la configuración de socios.
pacing

object (Pacing)

Obligatorio. Es el parámetro de 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 de integración adicionales del pedido de inserción.
performanceGoal

object (PerformanceGoal)

Obligatorio. Es el objetivo de rendimiento del pedido de inserción.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (BillableOutcome)

Inmutable. Es el resultado facturable del pedido de inserción.

Las compras basadas en resultados dejaron de estar disponibles. BILLABLE_OUTCOME_PAY_PER_IMPRESSION es el único valor válido.

InsertionOrderType

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.

Enumeradores
INSERTION_ORDER_TYPE_UNSPECIFIED El tipo de pedido de inserción no se especificó o se desconoce.
RTB Ofertas en tiempo real
OVER_THE_TOP Excepcional.

InsertionOrderBudget

Configuración que controla cómo se asigna el presupuesto de los pedidos 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 esté ejecutando un pedido de inserción.

InsertionOrderAutomationType

Opciones posibles para automatizar la oferta y el presupuesto de los pedidos de inserción.

Enumeradores
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED No se especificó la opción de automatización de pedidos de inserción 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 performanceGoal. No hay automatización en la configuración de ofertas.
INSERTION_ORDER_AUTOMATION_TYPE_NONE No se pueden automatizar las ofertas ni los presupuestos a nivel del pedido de inserción. La oferta y el presupuesto se deben configurar manualmente 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 pedido propietarias para optimizar el rendimiento definido por la performanceGoal.

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 especificado. El importe está en micros. Debe ser mayor que 0. Por ejemplo, 500000000 representa 500 unidades estándar de la moneda.
description

string

La descripción del segmento del presupuesto Puede utilizarse para ingresar información de la orden de compra para cada segmento del presupuesto y hacer que se imprima en las facturas.

Debe estar codificado en UTF-8.
dateRange

object (DateRange)

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

  • Cuando se crea un nuevo segmento de presupuesto, los valores de startDate y 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)

El budgetId del presupuesto de la campaña al que forma parte este segmento de presupuesto de pedido de inserción.

BillableOutcome

Posibles resultados facturables para un pedido de inserción.

Enumeradores
BILLABLE_OUTCOME_UNSPECIFIED Resultado facturable no especificado.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Pago por impresiones
BILLABLE_OUTCOME_PAY_PER_CLICK

Pago por clic.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Pago por vista activa.

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

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