Method: advertisers.lineItems.list

Lista os itens de linha em um anunciante.

A ordem é definida pelo parâmetro orderBy. Se uma filter de entityStatus não for especificada, os itens de linha com ENTITY_STATUS_ARCHIVED não serão incluídos nos resultados.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
advertiserId

string (int64 format)

Obrigatório. O ID do anunciante para o qual os itens de linha serão listados.

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. O valor precisa estar entre 1 e 100. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT caso um valor inválido seja especificado.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado pela chamada anterior para o método lineItems.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

Campo que classificará a lista. Os valores aceitos são:

  • displayName (padrão)
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, adicione um sufixo "desc" ao nome dele. Exemplo: displayName desc.
filter

string

Permite filtrar por propriedades do item de linha.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas por operadores lógicos AND ou OR. Uma sequência de restrições usa AND implicitamente.
  • Uma restrição tem o formato {field} {operator} {value}.
  • O operador usado em flight.dateRange.endDate deve ser MENOS QUE (<).
  • O operador usado em updateTime precisa ser GREATER THAN OR EQUAL TO (>=) ou LESS THAN OR EQUAL TO (<=).
  • O operador usado em warningMessages precisa ser HAS (:).
  • Os operadores usados em todos os outros campos precisam ser EQUALS (=).
  • Propriedades compatíveis:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (entrada formatada como AAAA-MM-DD)
    • warningMessages
    • flight.triggerId
    • updateTime (entrada no formato ISO 8601 ou AAAA-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

Exemplos:

  • Todos os itens de linha em um pedido de inserção: insertionOrderId="1234"
  • Todos os itens de linha ENTITY_STATUS_ACTIVE, ENTITY_STATUS_PAUSED e LINE_ITEM_TYPE_DISPLAY_DEFAULT em um anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Todos os itens de linha com períodos de veiculação que terminam antes de 28 de março de 2019: flight.dateRange.endDate<"2019-03-28"
  • Todos os itens de linha que têm NO_VALID_CREATIVE em warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • Todos os itens de linha com tempo de atualização menor ou igual a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Todos os itens de linha com horário de atualização maior ou igual a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
  • Todos os itens de linha que usam o canal especificado e a lista de palavras-chave negativas especificada na segmentação: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

Esse campo não pode ter mais de 500 caracteres.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Campos
lineItems[]

object (LineItem)

Lista de itens de linha.

Esta lista estará ausente se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método lineItems.list para recuperar a próxima página de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/display-video

Para mais informações, consulte a Visão geral do OAuth 2.0.