Method: advertisers.list

Elenca gli inserzionisti accessibili all'utente corrente.

L'ordine è definito dal parametro orderBy.

È obbligatorio specificare un solo partnerId. La scheda di più partner non è supportata.

Richiesta HTTP

GET https://displayvideo.googleapis.com/v3/advertisers

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
partnerId

string (int64 format)

Obbligatorio. L'ID del partner a cui devono appartenere tutti gli inserzionisti recuperati. Il sistema supporta la visualizzazione degli inserzionisti per un solo partner alla volta.
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificato, verrà usato il valore predefinito 100.
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 advertisers.list. Se non specificato, verrà restituita la prima pagina di 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'ordinamento decrescente per un campo, è necessario aggiungere il suffisso "desc" al nome del campo. Ad esempio, displayName desc.
filter

string

Consente di filtrare in base ai campi dell'inserzionista.

Sintassi supportata:

  • Le espressioni di filtro sono costituite da una o più restrizioni.
  • Le limitazioni possono essere combinate con gli operatori logici AND o OR.
  • Una restrizione ha la forma {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:

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

Esempi:

  • Tutti gli inserzionisti attivi di un partner: entityStatus="ENTITY_STATUS_ACTIVE"
  • Tutti gli inserzionisti con un'ora di aggiornamento precedente o uguale al 04-11-2020T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tutti gli inserzionisti con un orario di aggiornamento superiore o uguale a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"

La lunghezza di questo campo non deve essere superiore a 500 caratteri.

Per ulteriori informazioni, consulta la nostra guida su come filtrare le richieste LIST.

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 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Campi
advertisers[]

object (Advertiser)

L'elenco degli inserzionisti.

Questo elenco non sarà presente se è vuoto.
nextPageToken

string

Un token per recuperare la pagina di risultati successiva. Passa questo valore nel campo pageToken nella chiamata successiva al metodo advertisers.list per recuperare la pagina di risultati successiva.

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.