Method: advertisers.adGroups.list

Elenca i gruppi di annunci.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista a cui appartengono i gruppi di annunci.

Parametri di query

Parametri
pageSize

integer

(Facoltativo) 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

(Facoltativo) 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 adGroups.list. Se non specificato, verrà restituita la prima pagina di risultati.
orderBy

string

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

  • displayName (valore predefinito)
  • entityStatus

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

string

(Facoltativo) Consente di filtrare in base ai campi personalizzati del gruppo di annunci.

Sintassi supportata:

  • Le espressioni di filtro sono costituite da una o più limitazioni.
  • Le restrizioni possono essere combinate con AND e OR. Una sequenza di restrizioni utilizza implicitamente AND.
  • Una restrizione ha la forma {field} {operator} {value}.
  • Tutti i campi devono utilizzare l'operatore EQUALS (=).

Proprietà supportate:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Esempi:

  • Tutti i gruppi di annunci di un elemento pubblicitario: lineItemId="1234"
  • Tutti i gruppi di annunci ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM di un inserzionista: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

La lunghezza di questo campo non deve superare i 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 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
Campi
adGroups[]

object (AdGroup)

L'elenco dei gruppi di annunci.

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 adGroups.list per recuperare la pagina dei 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.