REST Resource: guaranteedOrders

Recurso: GuaranteedOrder

Un orden garantizado.

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

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,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
Campos
name

string

Solo salida. El nombre de recurso del pedido garantizado.
legacyGuaranteedOrderId

string

Solo salida. 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 lo sea en todos los pedidos garantizados. Este ID se usa en la IU y el SDF.
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 pedido garantizados tienen el formato {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Obligatorio. El nombre visible del pedido garantizado.

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

object (GuaranteedOrderStatus)

La configuración de estado del pedido garantizado.
updateTime

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización del pedido garantizado. 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".
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 "True", anula readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

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

Si este campo está configurado, no debe incluir el anunciante asignado a readWriteAdvertiserId. 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 readWriteAdvertiserId o, si no se establece, 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 asignada al pedido garantizado.

La campaña predeterminada debe pertenecer al anunciante predeterminado.

Campo de unión read_write_accessor. Obligatorio.

El socio o anunciante con acceso de lectura/escritura al pedido garantizado. read_write_accessor puede ser una de las siguientes opciones:
readWritePartnerId

string (int64 format)

El socio con acceso de lectura/escritura al pedido garantizado.
readWriteAdvertiserId

string (int64 format)

Es el anunciante con acceso de lectura/escritura al pedido garantizado. Este también es el anunciante predeterminado del pedido garantizado.

GuaranteedOrderStatus

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 se puede publicar o no el orden garantizado.

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 proporcionado por el usuario para detener este pedido garantizado.

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

Solo se aplica cuando entityStatus se establece como ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Solo salida. Es el estado de configuración del pedido garantizado.

Los valores aceptables son PENDING y COMPLETED.

Se debe configurar un pedido garantizado (completar los campos obligatorios, elegir las creatividades y seleccionar una campaña predeterminada) para que se pueda publicar. 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 para un pedido garantizado.

Enumeraciones
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED El estado de aprobación no se especifica en esta versión o se desconoce.
PENDING Es el estado inicial de un pedido garantizado. El orden garantizado en este estado se debe configurar antes de la publicación.
COMPLETED Es el estado después de que el comprador configura un pedido garantizado.

Métodos

create

 Crea un nuevo pedido garantizado.

editGuaranteedOrderReadAccessors

 Las ediciones leen a los anunciantes 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.