REST Resource: guaranteedOrders

Recurso: GuaranteedOrder

Um pedido garantido.

Os pedidos garantidos são a entidade pai das origens de inventário garantido. Ao criar uma origem de inventário garantido, é preciso atribuir um ID 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,

  // 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

Apenas saída. O nome do recurso da transação garantida.
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 seja exclusivo em todas as transações garantidas. 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 da transação garantida. Os códigos do pedido garantidos têm o formato {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Obrigatório. O nome de exibição da transação garantida.

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 de quando a transação garantida foi atualizada pela última vez. 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 da transação garantida.

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. Aplicável apenas se readWritePartnerId estiver definido. Se for verdadeiro, substitui 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 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 da transação garantida.

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.

Obrigatório.

O parceiro ou anunciante com acesso de leitura/gravação à transação garantida. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
readWritePartnerId

string (int64 format)

O parceiro com acesso de leitura/gravação à transação garantida.
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.
Fim dos campos mutuamente exclusivos.

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.

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 somente quando entityStatus está definido como ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Apenas saída. O status de configuração da transação garantida.

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

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

GuaranteedOrderConfigStatus

Possíveis estados de configuração de uma transação garantida.

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 ser veiculado.
COMPLETED O estado depois que o comprador configura um pedido garantido.

Métodos

create

 Cria uma nova transação garantida.

editGuaranteedOrderReadAccessors

 Edita os anunciantes de leitura de um pedido garantido.

get

 Recebe uma transação garantida.

list

 Lista as transações garantidas que podem ser acessadas pelo usuário atual.

patch

 Atualiza uma transação garantida.