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 ricerca

Parametri
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificati, il valore predefinito sarà 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 dovrebbe restituire. In genere, si tratta del valore di nextPageToken restituito dalla precedente chiamata 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, è necessario aggiungere un suffisso "desc" al nome del campo. Esempio: displayName desc.
filter

string

Consente di applicare un filtro in base ai campi personalizzati dei gruppi di annunci di YouTube.

Sintassi supportata:

  • Le espressioni di filtro sono composte da una o più restrizioni.
  • Le limitazioni possono essere combinate da AND e OR. Una sequenza di limitazioni utilizza implicitamente AND.
  • Una restrizione 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 gruppi di annunci ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM 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 superare i 500 caratteri.

Per ulteriori informazioni, consulta la guida relativa al filtro delle richieste di 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 
{
  "youtubeAdGroups": [
    {
      object (YoutubeAdGroup)
    }
  ],
  "nextPageToken": string
}
Campi
youtubeAdGroups[]

object (YoutubeAdGroup)

L'elenco dei gruppi di annunci.

Questo elenco non sarà presente se vuoto.
nextPageToken

string

Un token per recuperare la pagina dei risultati successiva. 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 pagina Panoramica di OAuth 2.0.