REST Resource: advertisers.insertionOrders

Recurso: Adição de pedido

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)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType)
}
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.

Ser codificado em UTF-8 com um 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 o orçamento e dar 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.
  • Um pedido de inserção não pode ser alterado de nenhum outro para o status ENTITY_STATUS_DRAFT.
  • Um pedido de inserção não poderá ser definido 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 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".
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 vai herdar os custos do parceiro das configurações do parceiro.
pacing

object (Pacing)

Obrigatório. A configuração da 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)

Mais detalhes de integração do pedido de inserção.
kpi

object (Kpi)

Obrigatório. O indicador principal de desempenho (KPI) do pedido de inserção.

Isso é representado como "Meta" na interface do Display & Video 360.
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.

InsertionOrderType

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

O tipo de pedido de inserção determina as configurações e opções 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.

IPD

Configurações que controlam o indicador principal de desempenho ou KPI de um pedido de inserção.

Representação JSON 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
Campos
kpiType

enum (KpiType)

Obrigatório. O tipo de KPI.
kpiAlgorithmId

string (int64 format)

Opcional. ID do algoritmo de lances personalizados associado a KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Este campo será ignorado se o KPI adequado não estiver selecionado.
Campo de união kpi_value. Obrigatório. O valor do KPI. O campo relevante corresponde a kpi_type. kpi_value pode ser apenas de um dos tipos a seguir:
kpiAmountMicros

string (int64 format)

O valor da meta, em micros da moeda do anunciante.

Aplicável quando kpiType é um dos seguintes:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Por exemplo: 1.500.000 representa 1,5 unidade padrão da moeda.
kpiPercentageMicros

string (int64 format)

A representação decimal da porcentagem da meta em micros.

Aplicável quando kpiType é um dos seguintes:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

Por exemplo: 70.000 representa 7% (decimal 0,07).
kpiString

string

Uma string de KPI, que pode estar vazia. Precisa ser codificado em UTF-8 com até 100 caracteres.

Aplicável quando kpiType é KPI_TYPE_OTHER.

KpiType

Possíveis tipos de indicador principal de desempenho (KPI).

Enums
KPI_TYPE_UNSPECIFIED O tipo de KPI não foi especificado ou é desconhecido nesta versão.
KPI_TYPE_CPM O KPI é o custo por mil (CPM).
KPI_TYPE_CPC O KPI é o custo por clique (CPC).
KPI_TYPE_CPA O KPI é o custo por ação (CPA).
KPI_TYPE_CTR O KPI é a porcentagem da CTR (taxa de cliques).
KPI_TYPE_VIEWABILITY O KPI é a porcentagem de visibilidade.
KPI_TYPE_CPIAVC O KPI é o custo por impressão audível e visível na conclusão (CPIAVC, na sigla em inglês).
KPI_TYPE_CPE O KPI é o custo por engajamento (CPE).
KPI_TYPE_CPV O KPI é definido em CPV (custo por visualização).
KPI_TYPE_CLICK_CVR O KPI é a porcentagem da taxa de conversão de clique (conversões por clique).
KPI_TYPE_IMPRESSION_CVR O KPI é a porcentagem da taxa de conversão de impressões (conversões por impressão).
KPI_TYPE_VCPM O KPI é o custo por mil impressões visíveis (VCPM).
KPI_TYPE_VTR O KPI é a porcentagem da taxa de visualização do YouTube (visualizações do YouTube por impressão).
KPI_TYPE_AUDIO_COMPLETION_RATE O KPI é a porcentagem da taxa de conclusão de áudio (ouções de áudio completas por impressão).
KPI_TYPE_VIDEO_COMPLETION_RATE O KPI é a porcentagem da taxa de visualizações completas (visualizações de vídeos completas por impressão).
KPI_TYPE_CPCL O KPI é definido em CPCL (custo por reprodução de áudio completa).
KPI_TYPE_CPCV O KPI é definido em CPCV (custo por visualização completa do vídeo).
KPI_TYPE_TOS10 O KPI é definido em uma taxa de tempo na tela de mais de 10 segundos (porcentagem de impressões mensuráveis e não puláveis que ficaram na tela por pelo menos 10 segundos).
KPI_TYPE_MAXIMIZE_PACING O KPI é definido para maximizar o impacto da marca, priorizando o gasto total do orçamento.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST O KPI é definido no valor da impressão personalizada dividido pelo custo.
KPI_TYPE_OTHER O KPI é algum outro valor.

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 é baseado em moeda ou em 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 padrão será INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Obrigatório. A lista de segmentos de orçamento. Use um segmento de orçamento para especificar um orçamento 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 está especificada ou é desconhecida nesta versão.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Alocação automática de orçamento Permitir que o sistema transfira automaticamente o orçamento para itens de linha proprietários a fim de otimizar o desempenho definido por kpi. Nenhuma automação nas configurações de lance.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Não há automação de lances ou orçamento no nível do pedido de inserção. O lance e o orçamento precisam ser configurados manualmente no nível do item de linha.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Permitir que o sistema ajuste automaticamente os lances e transfira o orçamento para itens de linha proprietários para otimizar o desempenho definido por kpi.

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 no dateRange especificado. O valor está em micros. Precisa ser maior que 0. Por exemplo, 50.000.000 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 da ordem de compra de 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. Eles são resolvidos em relação ao fuso horário do anunciante principal.

  • 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.
  • O endDate precisa ser o startDate ou uma data posterior, ambos antes do ano de 2037.
campaignBudgetId

string (int64 format)

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

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 a um pedido de inserção em todos os tipos de segmentação.

patch

 Atualiza um pedido de inserção existente.