REST Resource: advertisers.lineItems

Recurso: item de linha

Um único item de linha.

Representação JSON 
{
  "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
}
Campos
name

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

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

enum (LineItemType)

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

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

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".
partnerCosts[]

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

object (LineItemFlight)

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

object (LineItemBudget)

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

object (Pacing)

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

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

object (PartnerRevenueModel)

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

object (ConversionCountingConfig)

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

string (int64 format)

Os IDs dos criativos associados ao item de linha.
bidStrategy

object (BiddingStrategy)

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

object (IntegrationDetails)

Detalhes de integração do item de linha.
inventorySourceIds[]

string (int64 format)

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

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.
warningMessages[]

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

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

enum (ReservationType)

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

boolean

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

LineItemType

Tipos possíveis de um item de linha.

O tipo de item de linha 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
LINE_ITEM_TYPE_UNSPECIFIED

O valor do tipo não foi especificado ou é desconhecido nesta versão.

Os itens de linha desse tipo e a segmentação deles não podem ser criados ou atualizados usando a API.
LINE_ITEM_TYPE_DISPLAY_DEFAULT Anúncios gráficos, HTML5, nativos ou rich media.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL Anúncios de display que geram instalações de um aplicativo.
LINE_ITEM_TYPE_VIDEO_DEFAULT Anúncios em vídeo vendidos com base no CPM para vários ambientes.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL Anúncios em vídeo que geram instalações de um aplicativo.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

Anúncios de display veiculados em inventário de apps para dispositivos móveis.

Os itens de linha desse tipo e a segmentação deles não podem ser criados ou atualizados usando a API.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

Anúncios em vídeo veiculados no inventário do app para dispositivos móveis.

Os itens de linha desse tipo e a segmentação deles não podem ser criados ou atualizados usando a API.
LINE_ITEM_TYPE_AUDIO_DEFAULT Anúncios de áudio RTB vendidos para vários ambientes.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP Anúncios over-the-top presentes em pedidos de inserção OTT. Esse tipo só é aplicável a itens de linha com um pedido de inserção de insertionOrderType OVER_THE_TOP.

LineItemFlight

Configurações que controlam a duração ativa de um item de linha.

Representação JSON 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  },
  "triggerId": string
}
Campos
flightDateType

enum (LineItemFlightDateType)

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

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

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.

LineItemFlightDateType

Tipos possíveis de período de veiculação de um item de linha.

Enums
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED O valor do tipo não foi especificado ou é desconhecido nesta versão.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED O período de veiculação do item de linha é herdados do pedido de inserção pai.
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM O item de linha usa os próprios períodos de veiculação personalizados.
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER

O item de linha usa um acionador.

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 valor será desativado em 1o de agosto de 2023. Leia nosso anúncio de suspensão de uso de recursos para mais informações.

LineItemBudget

Configurações que controlam como o orçamento é alocado.

Representação JSON 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
Campos
budgetAllocationType

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

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

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.

LineItemBudgetAllocationType

Possíveis tipos de alocação de orçamento.

Enums
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED O valor do tipo não foi especificado ou é desconhecido nesta versão.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC A alocação automática de orçamento está ativada para o item de linha.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED Um valor de orçamento máximo fixo é alocado para o item de linha.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED Nenhum limite de orçamento é aplicado ao item de linha.

PartnerRevenueModel

Configurações que controlam como a receita do parceiro é calculada.

Representação JSON 
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
Campos
markupType

enum (PartnerRevenueModelMarkupType)

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

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

PartnerRevenueModelMarkupType

Possíveis tipos de marcação do modelo de receita do parceiro.

Enums
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED O valor do tipo não foi especificado ou é desconhecido nesta versão.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM Calcula a receita do parceiro com base em um CPM fixo.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

Calcule a receita do parceiro com base em uma porcentagem de sobretaxa do custo de mídia.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP Calcule a receita do parceiro com base em uma porcentagem sobreposta do seu custo de mídia total, que inclui todos os custos de parceiro e de dados.

ConversionCountingConfig

Configurações que controlam como as conversões são contabilizadas.

Todas as conversões pós-clique serão contadas. É possível definir um valor percentual para a contagem de conversões pós-visualização.

Representação JSON 
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
Campos
postViewCountPercentageMillis

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.
floodlightActivityConfigs[]

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.

TrackingFloodlightActivityConfig

Configurações que controlam o comportamento de uma única configuração de atividade do Floodlight.

Representação JSON 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
Campos
floodlightActivityId

string (int64 format)

Obrigatório. O ID da atividade do Floodlight.
postClickLookbackWindowDays

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

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.

TargetingExpansionConfig

Configurações que controlam as configurações de segmentação otimizada do item de linha.

Representação JSON 
{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}
Campos
targetingExpansionLevel

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.
excludeFirstPartyAudience
(deprecated)

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.

TargetingExpansionLevel

É a configuração de segmentação otimizada.

Enums
TARGETING_EXPANSION_LEVEL_UNSPECIFIED A configuração de segmentação otimizada não foi especificada ou é desconhecida nesta versão.
NO_EXPANSION A segmentação otimizada está desativada.
LEAST_EXPANSION A segmentação otimizada está ativada.
SOME_EXPANSION

Se usado, será definido automaticamente como LEAST_EXPANSION.
BALANCED_EXPANSION

Se usado, será definido automaticamente como LEAST_EXPANSION.
MORE_EXPANSION

Se usado, será definido automaticamente como LEAST_EXPANSION.
MOST_EXPANSION

Se usado, será definido automaticamente como LEAST_EXPANSION.

LineItemWarningMessage

As mensagens de aviso geradas por um item de linha. Esses tipos de aviso não bloqueiam o salvamento de um item de linha, mas podem impedir a execução dele.

Enums
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED Não especificado ou desconhecido.
INVALID_FLIGHT_DATES Este item de linha tem períodos de veiculação inválidos. O item de linha não será executado.
EXPIRED A data de término deste item de linha está no passado.
PENDING_FLIGHT Esse item de linha começará a ser exibido no futuro.
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED Todas as trocas ativadas de parceiros são segmentadas negativamente. O item de linha não será executado.
INVALID_INVENTORY_SOURCE Nenhuma origem de inventário ativa está sendo segmentada. O item de linha não será executado.
APP_INVENTORY_INVALID_SITE_TARGETING Os apps e recursos deste item de linha A segmentação por URLs não inclui apps para dispositivos móveis. O tipo deste item de linha exige que você inclua apps para dispositivos móveis na segmentação de canal, aplicativos ou lista de sites. O item de linha não será executado.
APP_INVENTORY_INVALID_AUDIENCE_LISTS Este item de linha não segmenta usuários de dispositivos móveis. O tipo deste item de linha exige que você segmente uma lista de usuários com usuários de dispositivos móveis. O item de linha não será executado.
NO_VALID_CREATIVE Este item de linha não tem um criativo válido. O item de linha não será executado.
PARENT_INSERTION_ORDER_PAUSED O pedido de inserção deste item de linha foi pausado. O item de linha não será executado.
PARENT_INSERTION_ORDER_EXPIRED O pedido de inserção deste item de linha tem uma data de término definida no passado. O item de linha não será executado.
NO_POSITIVE_AUDIENCE_LIST_TARGETED Este item de linha não segmenta listas de públicos-alvo, e isso pode fazer com que seu orçamento seja gasto muito rapidamente.
APP_INSTALL_NO_CONVERSION_PIXEL Este item de linha de instalação de app não tem pixels de conversão configurados.
TARGETING_REVOKED_OR_CLOSED_USER_LIST Este item de linha segmenta uma ou mais listas de usuários que não estão mais disponíveis. No futuro, isso vai impedir que o item de linha seja veiculado. Por isso, considere remover essas listas da sua segmentação.
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY Este item de linha de instalação do aplicativo não tem uma estratégia de lances otimizada.
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS As transações segmentadas por este item de linha aceitam tamanhos de criativo que não estão em uso. Isso pode limitar a exibição ou o desempenho do item de linha.
NO_CREATIVE_FOR_TARGETED_DEALS Este item de linha não tem criativos para as transações segmentadas.
TARGETING_DEPRECATED_GEO_TARGET Este item de linha segmenta uma segmentação por área geográfica que foi descontinuada.
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

Este item de linha usa a configuração excludeFirstPartyAudience, que foi descontinuada e será desativada após 25 de março de 2023.

Atualize a integração da API para excluir diretamente os públicos-alvo próprios que usam a segmentação por público-alvo antes de 25 de março de 2023 para considerar a desativação do campo excludeFirstPartyAudience.

MobileApp

É um app para dispositivos móveis promovido por um item de linha de instalação de apps para dispositivos móveis.

Representação JSON 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
Campos
appId

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

enum (Platform)

Apenas saída. A plataforma do app.
displayName

string

Apenas saída. O nome do app.
publisher

string

Apenas saída. O editor do app.

Plataforma

Possíveis plataformas de aplicativos para dispositivos móveis.

Enums
PLATFORM_UNSPECIFIED A plataforma não foi especificada.
IOS plataforma iOS.
ANDROID Plataforma Android.

Métodos

bulkEditLineItemAssignedTargetingOptions

 Edição em massa das opções de segmentação em um único item de linha.

bulkListLineItemAssignedTargetingOptions

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

create

 Cria um novo item de linha.

delete

 Exclui um item de linha.

generateDefault

 Cria um novo item de linha com configurações (incluindo segmentação) herdadas do pedido de inserção e um entity_status ENTITY_STATUS_DRAFT.

get

 Recebe um item de linha.

list

 Lista os itens de linha de um anunciante.

patch

 Atualiza um item de linha existente.