Groups: list

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

Risorse richieste:

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

Mirini con ingrandimento
https://www.googleapis.com/auth/yt-analytics.readonly Visualizza i report Analytics su YouTube per i tuoi contenuti di YouTube. Questo ambito fornisce l'accesso alle metriche relative alle attività degli utenti, come il numero di visualizzazioni e di valutazioni.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Visualizza i report Analytics su YouTube relativi al valore monetario per i tuoi contenuti di YouTube. Questo ambito fornisce l'accesso alle metriche relative all'attività utente e alle entrate stimate e alle metriche sul rendimento degli annunci.
https://www.googleapis.com/auth/youtube Gestisci il tuo account YouTube. Nell'API di YouTube Analytics, i proprietari dei canali utilizzano questo ambito per gestire i gruppi e gli elementi di YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Visualizzare e gestire le risorse di YouTube e i contenuti associati su YouTube. Nell'API di YouTube Analytics, i proprietari dei contenuti utilizzano questo ambito per gestire gli elementi e i gruppi di YouTube Analytics.

Parametri

Nella tabella seguente sono elencati i parametri supportati dalla query. Tutti i parametri elencati sono parametri di ricerca.

Parametri
Filtri (specifica esattamente uno dei seguenti parametri)
id string
Il parametro id specifica un elenco separato da virgole di ID dei gruppi YouTube per le risorse che vengono 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 appropriata. 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 appropriata. Nota: questo parametro è destinato esclusivamente ai partner 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. Permette ai proprietari dei contenuti di autenticarsi una volta sola e di accedere a tutti i dati video e del canale, senza dover fornire le credenziali di autenticazione per ogni singolo canale. L'account con cui l'utente si autentica deve essere collegato al proprietario dei contenuti di YouTube specificato.
pageToken string
Il parametro pageToken identifica una pagina specifica nel set di risultati che deve essere restituita. In una risposta 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 di risposta con la seguente struttura:

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

Proprietà

La tabella seguente definisce le proprietà che vengono 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 della richiesta API. Ogni elemento nell'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 alcun messaggio di errore univoco per questo metodo API. Tuttavia, questo metodo potrebbe comunque restituire errori generali dell'API elencati nella documentazione relativa ai messaggi di errore.

Prova.

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