Method: advertisers.campaigns.list

Elenca le campagne di un inserzionista.

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

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

L'ID dell'inserzionista per cui elencare le campagne.

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.
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 campaigns.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:

  • displayName (valore predefinito)
  • entityStatus
  • updateTime

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

string

Consente il filtraggio in base ai campi della campagna.

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

Campi supportati:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (input in formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Esempi:

  • Tutte le campagne ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED di un inserzionista: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Tutte le campagne con un orario di aggiornamento inferiore o uguale a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tutte le campagne 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Campi
campaigns[]

object (Campaign)

L'elenco delle campagne.

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 campaigns.list per recuperare la pagina successiva dei risultati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la OAuth 2.0 Overview.