Groups: list

Restituisce un elenco di gruppi che corrispondono ai parametri di richiesta dell'API. Ad esempio, puoi recuperare tutti i gruppi di proprietà dell'utente autenticato oppure uno o più gruppi tramite i relativi ID univoci.

Richiesta

Richiesta HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti (scopri di più su autenticazione e autorizzazione).

Ambiti
https://www.googleapis.com/auth/yt-analytics.readonly Visualizzare i report di YouTube Analytics per i tuoi contenuti di YouTube. Questo ambito fornisce l'accesso alle metriche sull'attività utente, come i conteggi delle visualizzazioni e delle valutazioni.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Visualizzare i report di YouTube Analytics relativi al valore monetario per i contenuti di YouTube. Questo ambito fornisce l'accesso alle metriche sull'attività utente e alle metriche stimate relative alle entrate e al rendimento degli annunci.
https://www.googleapis.com/auth/youtube Gestisci il tuo account YouTube. Nell'API YouTube Analytics, i proprietari del canale utilizzano questo ambito per gestire i gruppi e gli elementi di gruppo di YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Visualizzare e gestire le risorse di YouTube e i relativi contenuti su YouTube. Nell'API di YouTube Analytics, i proprietari di contenuti utilizzano questo ambito per gestire i gruppi e gli elementi di gruppo di YouTube Analytics.

Parametri

Nella tabella seguente sono elencati i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.

Parametri
Filtri (specifica esattamente uno dei seguenti parametri)
id string
Il parametro id specifica un elenco separato da virgole di ID gruppo YouTube relativi alle risorse recuperate. Ogni gruppo deve essere di proprietà dell'utente autenticato. In una risorsa group, la proprietà id specifica l'ID gruppo di YouTube del gruppo.

Tieni presente che se non specifichi un valore per il parametro id, devi impostare il parametro mine su true.
mine boolean
Questo parametro può essere utilizzato solo in una richiesta autorizzata. Imposta il valore di questo parametro su true per recuperare tutti i gruppi di proprietà dell'utente autenticato.
Parametri facoltativi
onBehalfOfContentOwner string
Questo parametro può essere utilizzato solo in una richiesta autorizzata. Nota: questo parametro è destinato esclusivamente ai partner della rete di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi.

Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente di YouTube che agisce per conto del proprietario dei contenuti specificato nel valore del parametro. Consente ai proprietari di contenuti di autenticarsi una volta sola per accedere a tutti i dati dei video e dei canali, senza dover fornire le credenziali di autenticazione per ogni singolo canale. L'account con cui l'utente esegue l'autenticazione deve essere collegato al proprietario dei contenuti di YouTube specificato.
pageToken string
Il parametro pageToken identifica una pagina specifica del set di risultati da restituire. In una risposta dell'API, la proprietà nextPageToken identifica la pagina successiva che può essere recuperata.

Corpo della richiesta

Non fornire un corpo della richiesta quando chiami questo metodo.

Risposta

In caso di esito positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

Proprietà

La tabella seguente definisce le proprietà visualizzate in questa risorsa:

Proprietà
kind string
Identifica il tipo di risorsa API. Il valore sarà youtube#groupListResponse.
etag etag
L'ETag di questa risorsa.
items[] list
Un elenco di gruppi che corrispondono ai parametri di richiesta dell'API. Ogni elemento dell'elenco rappresenta una risorsa group.
nextPageToken string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati.

Errori

L'API non definisce messaggi di errore specifici per questo metodo dell'API. Tuttavia, questo metodo potrebbe comunque restituire errori generici dell'API elencati nella documentazione del messaggio di errore.

Prova

Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.