Method: advertisers.youtubeAdGroups.list

Elenca i gruppi di annunci di YouTube.

Richiesta HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroups

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

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. 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

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

orderBy

string

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

Consente di filtrare in base ai campi personalizzati del gruppo di annunci di YouTube.

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

Proprietà supportate:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Esempi:

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

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

object (YoutubeAdGroup)

L'elenco dei gruppi 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 youtubeAdGroups.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.