Method: advertisers.creatives.list

Elenca le creatività di un inserzionista.

L'ordine è definito dal parametro orderBy. Se non viene specificato un filter di entityStatus, le creatività con ENTITY_STATUS_ARCHIVED non verranno incluse nei risultati.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista per cui elencare le creatività.

Parametri di query

Parametri
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificato, il valore predefinito è 100. Restituisce il codice di errore INVALID_ARGUMENT se viene specificato un valore non valido.

pageToken

string

Un token che identifica una pagina di risultati che il server deve restituire. In genere, questo è il valore di nextPageToken restituito dalla chiamata precedente al metodo creatives.list. Se non specificato, verrà restituita la prima pagina dei risultati.

orderBy

string

Campo in base al quale ordinare l'elenco. I valori accettabili sono:

  • creativeId (valore predefinito)
  • createTime
  • mediaDuration
  • dimensions (ordina prima per larghezza, poi per altezza)

L'ordinamento predefinito è crescente. Per specificare l'ordine decrescente per un campo, al nome del campo deve essere aggiunto il suffisso "desc". Esempio: createTime desc.

filter

string

Consente di filtrare in base ai campi creatività.

Sintassi supportata:

  • Le espressioni di filtro sono costituite da una o più limitazioni.
  • Le limitazioni possono essere combinate con gli operatori logici AND o OR. Una sequenza di limitazioni utilizza implicitamente AND.
  • Una limitazione ha la forma di {field} {operator} {value}.
  • Il campo lineItemIds deve utilizzare l'operatore HAS (:).
  • Il campo updateTime deve utilizzare gli operatori GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • Tutti gli altri campi devono utilizzare l'operatore EQUALS (=).
  • Per i campi entityStatus, minDuration, maxDuration, updateTime e dynamic, può essere presente al massimo una limitazione.

Campi supportati:

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions (input sotto forma di {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (input sotto forma di {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (input sotto forma di {duration}s. Sono supportati solo i secondi)
  • minDuration (input sotto forma di {duration}s. Sono supportati solo i secondi)
  • updateTime (input in formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Note:

  • Per updateTime, il valore del campo di una risorsa della creatività riflette l'ultima volta che una creatività è stata aggiornata, inclusi gli aggiornamenti apportati dal sistema (ad es. aggiornamenti della revisione della creatività).

Esempi:

  • Tutte le creatività native: creativeType="CREATIVE_TYPE_NATIVE"
  • Tutte le creatività attive con dimensioni 300 x 400 o 50 x 100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Tutte le creatività dinamiche approvate da AdX o AppNexus, con una durata minima di 5 secondi 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")
  • Tutte le creatività video associate all'ID elemento pubblicitario 1 o 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Trovare creatività in base a più ID creatività: creativeId=1 OR creativeId=2
  • Tutte le creatività con un orario di aggiornamento maggiore o uguale a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"

La lunghezza di questo campo non deve superare i 500 caratteri.

Per saperne di più, consulta la nostra guida alle richieste di LIST dei filtri.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
Campi
creatives[]

object (Creative)

L'elenco delle creatività.

Questo elenco non sarà presente se è vuoto.

nextPageToken

string

Un token per recuperare la pagina successiva dei risultati. Passa questo valore nel campo pageToken nella chiamata successiva al metodo ListCreativesRequest per recuperare la pagina successiva dei risultati. Se questo campo è null, significa che questa è l'ultima pagina.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la OAuth 2.0 Overview.