REST Resource: guaranteedOrders

Recurso: GuaranteedOrder

Um pedido garantido.

Os pedidos garantidos são a entidade principal das fontes de inventário garantido. Ao criar uma fonte de inventário garantido, um ID de pedido garantido precisa ser atribuído 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 bolsa original. O ID legado é exclusivo em uma troca, mas não há garantia de que 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 IDs de pedido garantido 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 da última atualização do pedido garantido. Atribuído pelo sistema.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
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

Se todos os anunciantes de readWritePartnerId têm acesso de leitura ao pedido garantido. Só é aplicável se readWritePartnerId estiver definido. Se for verdadeiro, vai substituir readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Os IDs dos anunciantes com acesso de leitura ao pedido garantido.

Esse 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 de 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 não estiver definido, o primeiro anunciante listado em readAdvertiserIds. Caso contrário, não há um anunciante padrão.
defaultCampaignId

string (int64 format)

O ID da campanha padrão atribuída 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. Esse 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 a ordem garantida pode ser veiculada.

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 este pedido garantido.

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

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

enum (GuaranteedOrderConfigStatus)

Apenas saída. O status da 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 da veiculação. No momento, a ação de configuração só pode ser realizada pela interface.

GuaranteedOrderConfigStatus

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

Tipos enumerados
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED O status de aprovação não foi especificado ou é desconhecido nesta versão.
PENDING O estado inicial de um pedido garantido. O pedido garantido nesse estado precisa ser configurado antes de poder veicular.
COMPLETED O estado depois que o comprador configura um pedido garantido.

Métodos

create

 Cria um novo pedido garantido.

editGuaranteedOrderReadAccessors

 Edita os anunciantes de leitura de um pedido garantido.

get

 Recebe um pedido garantido.

list

 Lista os pedidos garantidos acessíveis ao usuário atual.

patch

 Atualiza um pedido garantido.