Method: advertisers.creatives.list

Elenca le creatività in 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/v1beta2/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 100. Se non specificato, verrà usato 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, si tratta del valore di nextPageToken restituito dalla chiamata precedente al metodo creatives.list. Se non specificato, verrà restituita la prima pagina di risultati.

orderBy

string

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

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

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

filter

string

Consente di filtrare in base alle proprietà delle creatività.

Sintassi supportata:

  • Le espressioni di filtro sono costituite da una o più restrizioni.
  • La limitazione per lo stesso campo deve essere combinata da OR.
  • Le restrizioni per campi diversi devono essere combinate da AND.
  • Tra ( e ) possono esserci solo limitazioni combinate da OR per lo stesso campo.
  • Una limitazione ha il formato {field} {operator} {value}.
  • L'operatore deve essere EQUALS (=) per i seguenti campi:
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • L'operatore deve essere HAS (:) per i seguenti campi:
    • lineItemIds
  • L'operatore deve essere GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=) per i seguenti campi:
      .
    • updateTime (input nel formato ISO 8601 o AAAA-MM-GGTHH:MM:SSZ)
  • Per entityStatus, minDuration, maxDuration, updateTime e dynamic può esistere al massimo una limitazione.
  • Per dimensions, il valore è nel formato "{width}x{height}".
  • Per exchangeReviewStatus, il valore è nel formato {exchange}-{reviewStatus}.
  • Per minDuration e maxDuration, il valore è nel formato di "{duration}s". Con una granularità in millisecondi, sono supportati solo i secondi.
  • Per updateTime, il valore del campo di una risorsa creatività riflette l'ultima volta che una creatività è stata aggiornata, inclusi gli aggiornamenti apportati dal sistema (ad esempio quelli alla revisione delle creatività).
  • Potrebbero esserci più limitazioni di lineItemIds per cercare in base a più ID elemento pubblicitario possibili.
  • Potrebbero esserci più limitazioni di creativeId per poter cercare in base a più ID creatività possibili.

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)
  • Trova creatività in base a più ID creatività: creativeId=1 OR creativeId=2
  • Tutte le creatività con un'ora di aggiornamento superiore o uguale a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" La lunghezza di questo campo non deve essere superiore a 500 caratteri.

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 di creatività.

Se vuoto, questo elenco non sarà presente.

nextPageToken

string

Un token per recuperare la pagina successiva di risultati. Passa questo valore nel campo pageToken nella chiamata successiva al metodo ListCreativesRequest per recuperare la pagina dei risultati successiva. 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 panoramica di OAuth 2.0.