REST Resource: advertisers.insertionOrders

Recurso: pedido de inserção

Um único pedido de inserção.

Representação JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
Campos
name

string

Apenas saída. O nome do recurso do pedido de inserção.
advertiserId

string (int64 format)

Apenas saída. O ID exclusivo do anunciante ao qual o pedido de inserção pertence.
campaignId

string (int64 format)

Obrigatório. Imutável. O ID exclusivo da campanha a que o pedido de inserção pertence.
insertionOrderId

string (int64 format)

Apenas saída. O ID exclusivo do pedido de inserção. Atribuído pelo sistema.
displayName

string

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

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

enum (InsertionOrderType)

É o tipo de pedido de inserção.

Se esse campo não for especificado na criação, o valor padrão será RTB.
entityStatus

enum (EntityStatus)

Obrigatório. Controla se o pedido de inserção pode gastar seu orçamento e fazer lances no inventário.

  • Para o método insertionOrders.create, apenas ENTITY_STATUS_DRAFT é permitido. Para ativar um pedido de inserção, use o método insertionOrders.patch e atualize o status para ENTITY_STATUS_ACTIVE após a criação.
  • Não é possível alterar o status de um pedido de inserção de volta para ENTITY_STATUS_DRAFT.
  • Não é possível definir um pedido de inserção como ENTITY_STATUS_ACTIVE se a campanha principal não estiver ativa.
updateTime

string (Timestamp format)

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

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", 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".
partnerCosts[]

object (PartnerCost)

Os custos do parceiro associados ao pedido de inserção.

Se ausente ou vazio no método insertionOrders.create, o pedido de inserção recém-criado herdará os custos do parceiro das configurações do parceiro.
pacing

object (Pacing)

Obrigatório. É a configuração de velocidade de gasto do orçamento do pedido de inserção.
frequencyCap

object (FrequencyCap)

Obrigatório. É a configuração do limite de frequência do pedido de inserção.
integrationDetails

object (IntegrationDetails)

Detalhes adicionais de integração do pedido de inserção.
performanceGoal

object (PerformanceGoal)

Obrigatório. Meta de desempenho do pedido de inserção.
budget

object (InsertionOrderBudget)

Obrigatório. As configurações de alocação do orçamento do pedido de inserção.
bidStrategy

object (BiddingStrategy)

A estratégia de lances do pedido de inserção. Por padrão, fixedBid é definido.
reservationType

enum (ReservationType)

Apenas saída. O tipo de reserva do pedido de inserção.
billableOutcome

enum (BillableOutcome)

Imutável. O resultado faturável do pedido de inserção.

A compra com base em resultados foi descontinuada. BILLABLE_OUTCOME_PAY_PER_IMPRESSION é o único valor válido.

InsertionOrderType

Tipos possíveis de um pedido de inserção.

O tipo de pedido de inserção determina quais configurações e opções são aplicáveis, como o formato dos anúncios ou as opções de segmentação.

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED O tipo do pedido de inserção não foi especificado ou é desconhecido.
RTB Lances em tempo real.
OVER_THE_TOP Over-the-top.

InsertionOrderBudget

Configurações que controlam como o orçamento do pedido de inserção é alocado.

Representação JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Campos
budgetUnit

enum (BudgetUnit)

Obrigatório. Imutável. A unidade de orçamento especifica se o orçamento se baseia na moeda ou na impressão.
automationType

enum (InsertionOrderAutomationType)

O tipo de automação usado para gerenciar o lance e o orçamento do pedido de inserção.

Se esse campo não for especificado na criação, o valor será INSERTION_ORDER_AUTOMATION_TYPE_NONE por padrão.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Obrigatório. A lista de segmentos de orçamento. Use um segmento de orçamento para especificar um orçamento específico para um determinado período de execução de um pedido de inserção.

InsertionOrderAutomationType

Opções possíveis para automatizar o lance e o orçamento do pedido de inserção.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED A opção de automação do pedido de inserção não foi especificada ou é desconhecida nesta versão.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Alocação automática de orçamento. Permita que o sistema mude automaticamente o orçamento para itens de linha próprios e otimize o desempenho definido por performanceGoal. As configurações de lance não são automatizadas.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Sem automação de lances ou orçamento no nível do pedido de inserção. Os lances e o orçamento precisam ser configurados manualmente no item de linha.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Permita que o sistema ajuste automaticamente os lances e transfira o orçamento para os itens de linha próprios para otimizar o desempenho definido por performanceGoal.

InsertionOrderBudgetSegment

Configurações que controlam o orçamento de um único segmento de orçamento.

Representação JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Campos
budgetAmountMicros

string (int64 format)

Obrigatório. É o valor do orçamento que o pedido de inserção vai gastar para o dateRange especificado. O valor está em micros. Precisa ser maior que 0. Por exemplo, 500000000 representa 500 unidades padrão da moeda.
description

string

A descrição do segmento de orçamento. Ele pode ser usado para inserir informações de Ordem de compra para cada segmento de orçamento e imprimir essas informações nas faturas.

Ser codificado em UTF-8.
dateRange

object (DateRange)

Obrigatório. As configurações das datas de início e término do segmento de orçamento. Elas são resolvidas em relação ao fuso horário do anunciante pai.

  • Ao criar um novo segmento de orçamento, startDate e endDate precisam estar no futuro.
  • Um segmento de orçamento atual com um startDate no passado tem um endDate mutável, mas um startDate imutável.
  • endDate precisa ser o startDate ou uma data posterior, ambas antes de 2037.
campaignBudgetId

string (int64 format)

O budgetId do orçamento da campanha do qual este segmento de orçamento do pedido de inserção faz parte.

BillableOutcome

Possíveis resultados faturáveis para um pedido de inserção.

Enums
BILLABLE_OUTCOME_UNSPECIFIED Resultado faturável não especificado.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Pagamento por impressões.
BILLABLE_OUTCOME_PAY_PER_CLICK

Pagamento por clique.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Pagamento por Active View.

Métodos

create

 Cria um novo pedido de inserção.

delete

 Exclui um pedido de inserção.

get

 Recebe um pedido de inserção.

list

 Lista os pedidos de inserção de um anunciante.

listAssignedTargetingOptions

 Lista as opções de segmentação atribuídas de um pedido de inserção a diferentes tipos de segmentação.

patch

 Atualiza um pedido de inserção existente.