REST Resource: guaranteedOrders

Recurso: objetos garantidos

Um pedido garantido.

Os pedidos garantidos são a entidade pai de origens de inventário garantidas. Ao criar uma origem de inventário garantida, é necessário atribuir um código de pedido garantido a ela.

Representação 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

Apenas saída. O nome do recurso do pedido garantido.
legacyGuaranteedOrderId

string

Apenas saída. É o ID legado do pedido garantido. Atribuído pela troca original. O ID legado é exclusivo em uma troca, mas não é garantido que ele seja exclusivo em todos os pedidos garantidos. Esse ID é usado no SDF e na interface.
exchange

enum (Exchange)

Obrigatório. Imutável. A troca em que o pedido garantido foi originado.
guaranteedOrderId

string

Apenas saída. O identificador exclusivo do pedido garantido. Os códigos dos pedidos garantidos têm o formato {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Obrigatório. O nome de exibição do pedido garantido.

Precisa ser codificado em UTF-8 com um tamanho máximo de 240 bytes.
status

object (GuaranteedOrderStatus)

As configurações de status do pedido garantido.
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o pedido garantido foi atualizado pela última vez. Atribuído pelo sistema.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
publisherName

string

Obrigatório. O nome do editor do pedido garantido.

Precisa ser codificado em UTF-8 com um tamanho máximo de 240 bytes.
readAccessInherited

boolean

Indica se todos os anunciantes de readWritePartnerId têm acesso de leitura ao pedido garantido. Aplicável apenas se readWritePartnerId estiver definido. Se "True", substitui readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

São os IDs dos anunciantes com acesso de leitura ao pedido garantido.

Este campo não pode incluir o anunciante atribuído a readWriteAdvertiserId se ele estiver definido. Todos os anunciantes neste campo precisam pertencer a readWritePartnerId ou ao mesmo parceiro que readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Apenas saída. O ID do anunciante padrão do pedido garantido.

O anunciante padrão é o readWriteAdvertiserId ou, se ele não estiver definido, o primeiro anunciante listado em readAdvertiserIds. Caso contrário, não haverá anunciante padrão.
defaultCampaignId

string (int64 format)

O ID da campanha padrão que é atribuído ao pedido garantido.

A campanha padrão precisa pertencer ao anunciante padrão.

Campo de união read_write_accessor. Obrigatório.

É o parceiro ou anunciante com acesso de leitura/gravação ao pedido garantido. read_write_accessor pode ser apenas de um dos tipos a seguir:
readWritePartnerId

string (int64 format)

O parceiro com acesso de leitura/gravação ao pedido garantido.
readWriteAdvertiserId

string (int64 format)

O anunciante com acesso de leitura/gravação ao pedido garantido. Também é o anunciante padrão do pedido garantido.

GuaranteedOrderStatus

As configurações de status do pedido garantido.

Representação JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Campos
entityStatus

enum (EntityStatus)

Indica se o pedido garantido pode ser veiculado ou não.

Os valores aceitáveis são ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED e ENTITY_STATUS_PAUSED. O valor padrão é ENTITY_STATUS_ACTIVE.
entityPauseReason

string

O motivo fornecido pelo usuário para pausar esse pedido garantido.

Precisa ser codificado em UTF-8 com um tamanho máximo de 100 bytes.

Aplicável apenas quando entityStatus está definido como ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Apenas saída. O status de configuração do pedido garantido.

Os valores aceitáveis são PENDING e COMPLETED.

Um pedido garantido precisa ser configurado (preencha os campos obrigatórios, escolha criativos e selecione uma campanha padrão) antes de ser veiculado. Atualmente, a ação de configuração só pode ser realizada pela interface.

GuaranteedOrderConfigStatus

Possíveis estados de configuração para um pedido garantido.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED O status de aprovação não é especificado ou é desconhecido nesta versão.
PENDING O estado inicial de um pedido garantido. A ordem garantida nesse estado precisa ser configurada antes de ser veiculada.
COMPLETED O estado após o comprador configurar um pedido garantido.

Métodos

create

 Cria um novo pedido garantido.

editGuaranteedOrderReadAccessors

 Edita a leitura de anunciantes de um pedido garantido.

get

 Recebe um pedido garantido.

list

 Lista os pedidos garantidos que são acessíveis ao usuário atual.

patch

 Atualiza um pedido garantido existente.