Method: advertisers.creatives.list

Lista os criativos em um anunciante.

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

Solicitação HTTP

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

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 criativos 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 se um valor inválido for especificado.
pageToken

string

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

string

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

  • creativeId (padrão)
  • createTime
  • mediaDuration
  • dimensions (classifica primeiro por largura e depois por altura)

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente de um campo, use o sufixo "desc" deve ser adicionado ao nome do campo. Exemplo: createTime desc.
filter

string

Permite filtrar por propriedades do criativo.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • A restrição para o mesmo campo precisa ser combinada por OR.
  • A restrição para campos diferentes precisa ser combinada por AND.
  • Entre ( e ), só pode haver restrições combinadas por OR para o mesmo campo.
  • Uma restrição tem o formato {field} {operator} {value}.
  • O operador precisa ser EQUALS (=) para os seguintes campos:
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • O operador precisa ser HAS (:) para os seguintes campos:
    • lineItemIds
  • O operador precisa ser GREATER THAN OR EQUAL TO (>=) ou LESS THAN OR EQUAL TO (<=) para os seguintes campos:
    • updateTime (entrada no formato ISO 8601 ou AAAA-MM-DDTHH:MM:SSZ)
  • Para entityStatus, minDuration, maxDuration, updateTime e dynamic, pode haver no máximo uma restrição.
  • Para dimensions, o valor está na forma de "{width}x{height}".
  • Para exchangeReviewStatus, o valor está na forma de {exchange}-{reviewStatus}.
  • Para minDuration e maxDuration, o valor está na forma de "{duration}s". A granularidade de milissegundos aceita apenas segundos.
  • Para updateTime, o valor do campo de um recurso do criativo reflete a última vez que um criativo foi atualizado, o que inclui as atualizações feitas pelo sistema (por exemplo, atualizações na revisão de criativos).
  • Pode haver várias restrições lineItemIds para pesquisar vários códigos de item de linha possíveis.
  • Pode haver várias restrições de creativeId para pesquisar vários IDs de criativo possíveis.

Exemplos:

  • Todos os criativos nativos: creativeType="CREATIVE_TYPE_NATIVE"
  • Todos os criativos ativos com dimensões 300 x 400 ou 50 x 100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Todos os criativos dinâmicos aprovados pelo AdX ou pelo AppNexus, com duração mínima de 5 segundos e 200 ms. dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Todos os criativos em vídeo associados ao código 1 ou 2 do item de linha: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Encontrar criativos por vários IDs: creativeId=1 OR creativeId=2

  • Todos os criativos 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". O tamanho desse campo não pode ultrapassar 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 
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
Campos
creatives[]

object (Creative)

A lista de criativos.

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 ListCreativesRequest para recuperar a próxima página de resultados. Se o campo for nulo, isso significa que esta é a última página.

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.