Method: advertisers.adGroupAds.list

Elenca gli annunci del gruppo di annunci.

Richiesta HTTP

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

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 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

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

string

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

  • displayName (valore predefinito)
  • entityStatus

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

string

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

Sintassi supportata:

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

Campi supportati:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Esempi:

  • Tutti gli annunci di un gruppo di annunci all'interno di un gruppo di annunci: adGroupId="1234"
  • Tutti gli annunci di un gruppo di annunci con entitàStatus ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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

Per saperne di più, consulta la nostra guida sulle richieste di LIST filtro.

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

object (AdGroupAd)

L'elenco degli annunci del gruppo di annunci.

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 adGroupAds.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.