- Recurso: InsertOrder
- InsertionOrderType
- KPIs
- KpiType
- InsertionOrderBudget
- InsertionOrderAutomationType
- InsertionOrderBudgetSegment
- OptimizationObjective
- Métodos
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 ( |
Campos | |
---|---|
name |
Apenas saída. O nome do recurso do pedido de inserção. |
advertiserId |
Apenas saída. O ID exclusivo do anunciante ao qual o pedido de inserção pertence. |
campaignId |
Obrigatório. Imutável. O ID exclusivo da campanha a que o pedido de inserção pertence. |
insertionOrderId |
Apenas saída. O ID exclusivo do pedido de inserção. Atribuído pelo sistema. |
displayName |
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 |
É o tipo de pedido de inserção. Se esse campo não for especificado na criação, o valor será |
entityStatus |
Obrigatório. Controla se o pedido de inserção pode gastar seu orçamento e fazer lances no inventário.
|
updateTime |
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: |
partnerCosts[] |
Os custos do parceiro associados ao pedido de inserção. Se ausente ou vazio no método |
pacing |
Obrigatório. É a configuração de velocidade de gasto do orçamento do pedido de inserção. |
frequencyCap |
Obrigatório. É a configuração do limite de frequência do pedido de inserção. |
integrationDetails |
Detalhes adicionais de integração do pedido de inserção. |
kpi |
Obrigatório. O indicador principal de desempenho (KPI, na sigla em inglês) do pedido de inserção. Isso é representado como "meta" na guia Interface do Video 360. |
budget |
Obrigatório. As configurações de alocação do orçamento do pedido de inserção. |
bidStrategy |
A estratégia de lances do pedido de inserção. Por padrão, |
reservationType |
Apenas saída. O tipo de reserva do pedido de inserção. |
optimizationObjective |
Opcional. O objetivo de otimização do pedido de inserção. Esse campo só está disponível para clientes na lista de permissões. Se um cliente não estiver na lista de permissões, este campo será nulo e uma tentativa de defini-lo retornará um erro. |
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. |
IPD
Configurações que controlam o indicador principal de desempenho, ou KPI, de um pedido de inserção.
Representação JSON |
---|
{ "kpiType": enum ( |
Campos | |
---|---|
kpiType |
Obrigatório. O tipo de KPI. |
kpiAlgorithmId |
Opcional. ID do algoritmo de lances personalizados associado a KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Esse campo será ignorado se o KPI adequado não for 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 |
O valor da meta, em micros na moeda do anunciante. Aplicável quando
Por exemplo: 1.500.000 representa 1,5 unidades padrão da moeda. |
kpiPercentageMicros |
A representação decimal da porcentagem da meta, em micros. Aplicável quando
Por exemplo: 70.000 representa 7% (decimal 0,07). |
kpiString |
Uma string de KPI, que pode estar vazia. Precisa ser codificado em UTF-8 e ter no máximo 100 caracteres. Aplicável quando |
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 é CPM (custo por mil). |
KPI_TYPE_CPC |
O KPI é CPC (custo por clique). |
KPI_TYPE_CPA |
O KPI é CPA (custo por ação). |
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 é CPIAVC (custo por impressão audível e visível na conclusão). |
KPI_TYPE_CPE |
O KPI é 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 cliques (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 é custo por mil impressões visíveis (VCPM). |
KPI_TYPE_VTR |
O KPI é a porcentagem da taxa de visualização do YouTube (visualizações por impressão do YouTube). |
KPI_TYPE_AUDIO_COMPLETION_RATE |
O KPI é a porcentagem da taxa de conclusão de áudio (ouvações completas de áudio por impressão). |
KPI_TYPE_VIDEO_COMPLETION_RATE |
O KPI é a porcentagem da taxa de visualizações completas (visualizações de vídeo completas por impressão). |
KPI_TYPE_CPCL |
O KPI é definido no CPCL (custo por escuta completa de áudio). |
KPI_TYPE_CPCV |
O KPI é definido no CPCV (custo por exibição de vídeo completa). |
KPI_TYPE_TOS10 |
O KPI é definido com base na taxa de tempo na tela de mais de 10 segundos (porcentagem de impressões mensuráveis e não puláveis que apareceram na tela por pelo menos 10 segundos). |
KPI_TYPE_MAXIMIZE_PACING |
O KPI está definido para maximizar o impacto da marca enquanto prioriza gastar todo o orçamento. |
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST |
O KPI é definido com base 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 ( |
Campos | |
---|---|
budgetUnit |
Obrigatório. Imutável. A unidade de orçamento especifica se o orçamento se baseia na moeda ou na impressão. |
automationType |
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á |
budgetSegments[] |
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 kpi . 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 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 ( |
Campos | |
---|---|
budgetAmountMicros |
Obrigatório. É o valor do orçamento que o pedido de inserção vai gastar para o |
description |
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 |
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.
|
campaignBudgetId |
O |
OptimizationObjective
Possíveis tipos de objetivos de otimização.
Enums | |
---|---|
OPTIMIZATION_OBJECTIVE_UNSPECIFIED |
O valor do tipo não foi especificado ou é desconhecido nesta versão. |
CONVERSION |
Priorize impressões que aumentem as vendas e as conversões. |
CLICK |
Priorizar impressões que aumentem o tráfego do site, dos aplicativos e das app stores. |
BRAND_AWARENESS |
Priorizar impressões de qualidade específica. |
CUSTOM |
O objetivo é definido pelo algoritmo de lances personalizados atribuído. |
NO_OBJECTIVE |
O objetivo não foi definido. Qualquer KPI ou estratégia de lances pode ser usado. |
Métodos |
|
---|---|
|
Cria um novo pedido de inserção. |
|
Exclui um pedido de inserção. |
|
Recebe um pedido de inserção. |
|
Lista os pedidos de inserção de um anunciante. |
|
Lista as opções de segmentação atribuídas de um pedido de inserção a diferentes tipos de segmentação. |
|
Atualiza um pedido de inserção existente. |