REST Resource: advertisers.lineItems

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "inventorySourceIds": [
    string
  ],
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean
}

string

Apenas saída. O nome do recurso do item de linha.

string (int64 format)

Apenas saída. O ID exclusivo do anunciante ao qual o item de linha pertence.

string (int64 format)

Apenas saída. O ID exclusivo da campanha a que o item de linha pertence.

string (int64 format)

Obrigatório. Imutável. O ID exclusivo do pedido de inserção ao qual o item de linha pertence.

string (int64 format)

Apenas saída. O ID exclusivo do item de linha. Atribuído pelo sistema.

string

Obrigatório. O nome de exibição do item de linha.

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

enum (LineItemType)

Obrigatório. Imutável. O tipo do item de linha.

enum (EntityStatus)

Obrigatório. Controla se o item de linha pode ou não gastar seu orçamento e fazer lances no inventário.

• Para o método lineItems.create, apenas ENTITY_STATUS_DRAFT é permitido. Para ativar um item de linha, use o método lineItems.patch e atualize o status para ENTITY_STATUS_ACTIVE após a criação.
• Não é possível alterar o status de um item de linha de volta para ENTITY_STATUS_DRAFT.
• Se o pedido de inserção pai do item de linha não estiver ativo, o item de linha não poderá gastar o orçamento, mesmo que o status seja ENTITY_STATUS_ACTIVE.

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o item de linha 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 item de linha.

Se ausente ou vazio no método lineItems.create, o item de linha recém-criado herdará os custos do parceiro do pedido de inserção pai.

object (LineItemFlight)

Obrigatório. É o horário de início e de término do período de veiculação do item de linha.

object (LineItemBudget)

Obrigatório. A configuração de alocação do orçamento do item de linha.

object (Pacing)

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

object (FrequencyCap)

Obrigatório. As configurações de limite de frequência da impressão do item de linha.

Use o campo maxImpressions neste objeto de configurações ao atribuir um limite limitado.

object (PartnerRevenueModel)

Obrigatório. A configuração do modelo de receita do parceiro referente ao item de linha.

object (ConversionCountingConfig)

A configuração de acompanhamento de conversões do item de linha.

string (int64 format)

Os IDs dos criativos associados ao item de linha.

object (BiddingStrategy)

Obrigatório. A estratégia de lances do item de linha.

object (IntegrationDetails)

Detalhes de integração do item de linha.

string (int64 format)

Os códigos das origens de inventário particulares atribuídos ao item de linha.

object (TargetingExpansionConfig)

As configurações de segmentação otimizada do item de linha.

Essa configuração só é aplicável a itens de linha de display, vídeo ou áudio que usam lances automáticos e segmentam positivamente listas de público-alvo qualificadas.

enum (LineItemWarningMessage)

Apenas saída. As mensagens de aviso geradas pelo item de linha. Esses avisos não impedem que o item de linha seja salvo, mas alguns podem impedir a execução dele.

object (MobileApp)

O app para dispositivos móveis promovido pelo item de linha.

Aplicável apenas quando lineItemType é LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL ou LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.

enum (ReservationType)

Apenas saída. O tipo de reserva do item de linha.

boolean

Define se novas trocas serão segmentadas automaticamente pelo item de linha. Esse campo é falso por padrão.

{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  },
  "triggerId": string
}

enum (LineItemFlightDateType)

Obrigatório. O tipo de período de veiculação do item de linha.

object (DateRange)

As datas de início e término do período de veiculação do item de linha. Elas são resolvidas em relação ao fuso horário do anunciante pai.

• Obrigatório quando flightDateType for LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. Saída apenas caso contrário.
• Ao criar um novo período de veiculação, startDate e endDate precisam estar no futuro.
• Um voo 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 ID do acionador manual associado ao item de linha.

• Obrigatório quando flightDateType for LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER. Não pode ser definido de outra forma.
• Quando definidos, o período de veiculação do item de linha é herdados do pedido de inserção pai.
• Os itens de linha ativos serão gastos quando o acionador selecionado for ativado dentro do período de veiculação do pedido de inserção pai.

Aviso: os itens de linha que usam acionadores manuais não são mais veiculados nas campanhas da Rede de Display e Vídeo em 360°. Esse campo vai ser desativado em 1o de agosto de 2023. Leia nosso anúncio de suspensão de uso de recursos para mais informações.

{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}

enum (LineItemBudgetAllocationType)

Obrigatório. Tipo de alocação do orçamento.

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC só é aplicável quando a alocação automática de orçamento está ativada para o pedido de inserção pai.

enum (BudgetUnit)

Apenas saída. A unidade de orçamento especifica se o orçamento se baseia na moeda ou na impressão. Este valor é herdado do pedido de inserção pai.

string (int64 format)

É o orçamento máximo que o item de linha gastará. Precisa ser maior que 0.

Quando budgetAllocationType for:

• LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC, este campo é imutável e definido pelo sistema.
• LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, se budgetUnit for:
  • BUDGET_UNIT_CURRENCY, este campo representa o valor máximo do orçamento a ser gasto, em micros na moeda do anunciante. Por exemplo, 1500000 representa 1,5 unidades padrão da moeda.
  • BUDGET_UNIT_IMPRESSIONS, este campo representa o número máximo de impressões a serem veiculadas.
• LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED, este campo não é aplicável e será ignorado pelo sistema.

{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}

enum (PartnerRevenueModelMarkupType)

Obrigatório. O tipo de marcação do modelo de receita do parceiro.

string (int64 format)

Obrigatório. O valor da marcação do modelo de receita do parceiro. Deve ser maior ou igual a 0.

• Quando o markupType é definido como PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, esse campo representa a marcação de CPM em micros na moeda do anunciante. Por exemplo, 1500000 representa 1,5 unidades padrão da moeda.
• Quando markupType é definido como PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, esse campo representa a marcação percentual do custo de mídia em milissegundos. Por exemplo, 100 representa 0,1% (decimal 0,001).
• Quando markupType é definido como PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, esse campo representa a marcação percentual do custo de mídia total em milissegundos. Por exemplo, 100 representa 0,1% (decimal 0,001).

{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}

string (int64 format)

Porcentagem de conversões pós-visualização a serem contabilizadas, em milissegundos (1/1.000 de uma porcentagem). Precisa estar entre 0 e 100.000.

Por exemplo, para rastrear 50% das conversões pós-clique, defina um valor de 50.000.

object (TrackingFloodlightActivityConfig)

As configurações de atividades do Floodlight usadas para rastrear conversões.

O número de conversões contadas é a soma de todas as conversões contadas por todos os IDs de atividades do Floodlight especificados nesse campo.

{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}

string (int64 format)

Obrigatório. O ID da atividade do Floodlight.

integer

Obrigatório. O número de dias após o clique em um anúncio em que uma conversão pode ser contada. Precisa estar entre 0 e 90.

integer

Obrigatório. É o número de dias após a visualização de um anúncio em que uma conversão pode ser contada. Precisa estar entre 0 e 90.

{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}

enum (TargetingExpansionLevel)

Obrigatório. Indica se a segmentação otimizada está ativada.

Esse campo aceita os seguintes valores:

• NO_EXPANSION: a segmentação otimizada está desativada
• LEAST_EXPANSION: a segmentação otimizada está ativada

Se este campo for definido com qualquer outro valor, ele será automaticamente definido como LEAST_EXPANSION.

NO_EXPANSION será o valor padrão do campo e será atribuído automaticamente se você não o definir.

boolean

Define se os públicos-alvo próprios serão excluídos da expansão de segmentação.

Esse campo foi descontinuado com o lançamento da segmentação otimizada.

Esse campo será definido como false. Se ele for definido como true quando for descontinuado, todas as segmentações positivas por público-alvo próprio atribuídas a este item de linha serão substituídas pela segmentação negativa dos mesmos públicos-alvo próprios para garantir a exclusão contínua desses públicos-alvo.

{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}

string

Obrigatório. O ID do app fornecido pela loja da plataforma.

Os apps Android são identificados pelo ID do pacote usado pela Play Store do Android, como com.google.android.gm.

Os apps iOS são identificados por um ID de app de nove dígitos usado pela App Store da Apple, como 422689480.

enum (Platform)

Apenas saída. A plataforma do app.

string

Apenas saída. O nome do app.

string

Apenas saída. O editor do app.