Method: advertisers.adGroupAds.list

Elenca gli annunci del gruppo di annunci.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista a cui appartengono gli annunci.

Parametri di query

Parametri
pageSize

integer

Facoltativo. Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 100. 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 adGroupAds.list. Se non specificato, verrà restituita la prima pagina dei 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 per un campo, è necessario aggiungere il suffisso "desc" al nome del campo. Esempio: displayName desc.
filter

string

Facoltativo. Consente di filtrare in base ai campi degli annunci del gruppo di annunci.

Sintassi supportata:

  • Le espressioni di filtro sono costituite da una o più limitazioni.
  • Le limitazioni possono essere combinate con 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
  • parentCreativeId

Esempi:

  • Tutti gli annunci del gruppo di annunci in un gruppo di annunci: adGroupId="1234"
  • Tutti gli annunci del gruppo di annunci in un gruppo di annunci con un entityStatus di ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"
  • Tutti gli annunci del gruppo di annunci in una creatività principale: parentCreativeId="12345"

La lunghezza di questo campo non deve superare i 500 caratteri.

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

object (AdGroupAd)

L'elenco degli annunci.

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

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.