REST Resource: guaranteedOrders

Recurso: GuaranteedOrder

Un pedido garantizado

Los pedidos garantizados son la entidad principal de las fuentes de inventario garantizado. Cuando se crea una fuente de inventario garantizado, se le debe asignar un ID de pedido garantizado.

Representación JSON 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
Campos
name

string

Solo salida. Es el nombre del recurso del pedido garantizado.
legacyGuaranteedOrderId

string

Solo salida. Es el ID heredado del pedido garantizado. Asignado por el intercambio original. El ID heredado es único dentro de un intercambio, pero no se garantiza que sea único en todos los pedidos garantizados. Este ID se usa en el SDF y la IU.
exchange

enum (Exchange)

Obligatorio. Inmutable. Es el intercambio en el que se originó el pedido garantizado.
guaranteedOrderId

string

Solo salida. Es el identificador único del pedido garantizado. Los IDs de pedidos garantizados tienen el formato {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Obligatorio. Es el nombre visible de la línea de pedido garantizada.

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

object (GuaranteedOrderStatus)

Es la configuración de estado del pedido garantizado.
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la última actualización del pedido garantizado. 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".
publisherName

string

Obligatorio. Es el nombre del publicador del pedido garantizado.

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

boolean

Indica si todos los anunciantes de readWritePartnerId tienen acceso de lectura al pedido garantizado. Solo se aplica si se establece readWritePartnerId. Si es verdadero, anula readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Son los IDs de los anunciantes con acceso de lectura al pedido garantizado.

Este campo no debe incluir el anunciante asignado a readWriteAdvertiserId si está configurado. Todos los anunciantes de este campo deben pertenecer a readWritePartnerId o al mismo socio que readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Solo salida. Es el ID del anunciante predeterminado del pedido garantizado.

El anunciante predeterminado es el readWriteAdvertiserId o, si no está configurado, el primer anunciante que aparece en readAdvertiserIds. De lo contrario, no hay un anunciante predeterminado.
defaultCampaignId

string (int64 format)

Es el ID de la campaña predeterminada que se asigna al pedido garantizado.

La campaña predeterminada debe pertenecer al anunciante predeterminado.

Obligatorio.

Es el socio o anunciante con acceso de lectura y escritura al pedido garantizado. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
readWritePartnerId

string (int64 format)

Es el socio con acceso de lectura y escritura al pedido garantizado.
readWriteAdvertiserId

string (int64 format)

Es el anunciante con acceso de lectura y escritura al pedido garantizado. Este también es el anunciante predeterminado del pedido garantizado.
Fin de los campos mutuamente excluyentes.

GuaranteedOrderStatus

Es la configuración de estado del pedido garantizado.

Representación JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Campos
entityStatus

enum (EntityStatus)

Indica si el pedido garantizado se puede publicar o no.

Los valores aceptables son ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED y ENTITY_STATUS_PAUSED. El valor predeterminado es ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Es el motivo que proporcionó el usuario para pausar este pedido garantizado.

Debe estar codificado en UTF-8 con una longitud máxima de 100 bytes.

Solo se aplica cuando entityStatus se establece en ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Solo salida. Es el estado de configuración de la línea de pedido garantizada.

Los valores aceptables son PENDING y COMPLETED.

Para que se pueda publicar un pedido garantizado, se debe configurar (completar los campos obligatorios, elegir las creatividades y seleccionar una campaña predeterminada). Actualmente, la acción de configuración solo se puede realizar a través de la IU.

GuaranteedOrderConfigStatus

Son los posibles estados de configuración de un pedido garantizado.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED El estado de aprobación no se especifica o es desconocido en esta versión.
PENDING Es el estado inicial de un pedido garantizado. El pedido garantizado en este estado debe configurarse antes de que pueda publicarse.
COMPLETED Es el estado después de que el comprador configura un pedido garantizado.

Métodos

create

 Crea un nuevo pedido garantizado.

editGuaranteedOrderReadAccessors

 Edita los anunciantes de solo lectura de un pedido garantizado.

get

 Obtiene un pedido garantizado.

list

 Muestra una lista de los pedidos garantizados a los que puede acceder el usuario actual.

patch

 Actualiza un pedido garantizado existente.