Recurso: GuaranteedOrder
Un pedido garantizado.
Los pedidos garantizados son la entidad principal de las fuentes de inventario garantizadas. Cuando se crea una fuente de inventario garantizada, se debe asignar un ID de pedido garantizado a la fuente de inventario.
Representación JSON |
---|
{ "name": string, "legacyGuaranteedOrderId": string, "exchange": enum ( |
Campos | |
---|---|
name |
Solo salida. El nombre del recurso del pedido garantizado. |
legacyGuaranteedOrderId |
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 para todos los pedidos garantizados. Este ID se usa en el SDF y la IU. |
exchange |
Obligatorio. Inmutable. Es el intercambio donde se originó el pedido garantizado. |
guaranteedOrderId |
Solo salida. Es el identificador único del pedido garantizado. Los IDs de pedido garantizados tienen el formato |
displayName |
Obligatorio. Es el nombre visible del pedido garantizado. Debe estar codificado en UTF-8, con un tamaño máximo de 240 bytes. |
status |
La configuración de estado del pedido garantizado. |
updateTime |
Solo salida. La marca de tiempo de la última actualización del pedido garantizado. 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: |
publisherName |
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 |
Indica si todos los anunciantes de |
readAdvertiserIds[] |
Son los ID de los anunciantes con acceso de lectura al pedido garantizado. Este campo no debe incluir el anunciante asignado a |
defaultAdvertiserId |
Solo salida. Es el ID del anunciante predeterminado del pedido garantizado. El anunciante predeterminado es el |
defaultCampaignId |
El ID de la campaña predeterminada que se asigna al pedido garantizado. La campaña predeterminada debe pertenecer al anunciante predeterminado. |
Campo de unión El socio o anunciante con acceso de lectura y escritura al pedido garantizado. |
|
readWritePartnerId |
El socio con acceso de lectura/escritura al pedido garantizado. |
readWriteAdvertiserId |
El anunciante con acceso de lectura/escritura al pedido garantizado. También es el anunciante predeterminado del pedido garantizado. |
GuaranteedOrderStatus
La configuración de estado del pedido garantizado.
Representación JSON |
---|
{ "entityStatus": enum ( |
Campos | |
---|---|
entityStatus |
Indica si el pedido garantizado se puede publicar o no. Los valores aceptables son |
entityPauseReason |
Es el motivo proporcionado por el usuario para detener este pedido garantizado. Debe estar codificado en UTF-8, con una longitud máxima de 100 bytes. Solo se aplica cuando |
configStatus |
Solo salida. El estado de configuración del pedido garantizado. Los valores aceptables son Se debe configurar un pedido garantizado (completa los campos obligatorios, elige las creatividades y selecciona una campaña predeterminada) antes de que se pueda publicar. Actualmente, la acción de configuración solo se puede realizar a través de la IU. |
GuaranteedOrderConfigStatus
Son posibles estados de configuración para un pedido garantizado.
Enumeradores | |
---|---|
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED |
No se especificó el estado de aprobación o se desconoce en esta versión. |
PENDING |
El estado inicial de un pedido garantizado. Es necesario configurar el orden garantizado en este estado antes de que se pueda publicar. |
COMPLETED |
Es el estado después de que el comprador configura un pedido garantizado. |
Métodos |
|
---|---|
|
Crea un nuevo pedido garantizado. |
|
Las ediciones leen a los anunciantes de un pedido garantizado. |
|
Obtiene un pedido garantizado. |
|
Muestra una lista de los pedidos garantizados a los que puede acceder el usuario actual. |
|
Actualiza un pedido garantizado existente. |