REST Resource: advertisers.insertionOrders

{
  "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),
  "optimizationObjective": enum (OptimizationObjective)
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

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.

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.

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.

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".

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.

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (Kpi)

Obrigatório. O indicador principal de desempenho (KPI, na sigla em inglês) do pedido de inserção.

Isso é representado como "Meta" na interface do Display & Video 360.

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (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.

{
  "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.
}

enum (KpiType)

Obrigatório. O tipo de KPI.

string (int64 format)

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.

string (int64 format)

O valor da meta, em micros na 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 unidades padrão da moeda.

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).

string

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 é KPI_TYPE_OTHER.

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

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

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.

object (InsertionOrderBudgetSegment)

Obrigatório. A lista de segmentos de orçamento. Use um segmento de orçamento para especificar um orçamento para determinado período em que um pedido de inserção é veiculado.

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

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.

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.

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.

string (int64 format)

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