Groups: list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
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.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-08-21 UTC.
[null,null,["Ultimo aggiornamento 2025-08-21 UTC."],[[["\u003cp\u003eRetrieves a list of YouTube groups based on specified criteria, such as group IDs or ownership by the authenticated user.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific scopes to access group data, including read-only access to YouTube Analytics reports.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by group IDs (\u003ccode\u003eid\u003c/code\u003e parameter) or retrieving all groups owned by the authenticated user (\u003ccode\u003emine\u003c/code\u003e parameter).\u003c/p\u003e\n"],["\u003cp\u003eSupports optional parameters like \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e for content owners managing multiple channels and \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eReturns a response containing group details, including kind, Etag, items (list of groups), and a token for retrieving the next page of results.\u003c/p\u003e\n"]]],["This API method retrieves a list of YouTube Analytics groups. Requests are made via a `GET` request to a specified URL. Authentication requires specific scopes like `yt-analytics.readonly`. Users can filter groups by specifying group `id`s or by setting `mine` to `true` to get all groups they own. The response contains an `etag`, a list of `groups`, and potentially a `nextPageToken` for pagination. The method has the possibility to use `onBehalfOfContentOwner` for content owners.\n"],null,["# Groups: list\n\nReturns a list of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://youtubeanalytics.googleapis.com/v2/groups\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/analytics/authentication)).\n\n| Scopes ||\n|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| https://www.googleapis.com/auth/yt-analytics.readonly | View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts. |\n| https://www.googleapis.com/auth/yt-analytics-monetary.readonly | View YouTube Analytics monetary reports for your YouTube content. This scope provides access to user activity metrics and to estimated revenue and ad performance metrics. |\n| https://www.googleapis.com/auth/youtube | Manage your YouTube account. In the YouTube Analytics API, channel owners use this scope to manage YouTube Analytics groups and group items. |\n| https://www.googleapis.com/auth/youtubepartner | View and manage YouTube assets and associated content on YouTube. In the YouTube Analytics API, content owners use this scope to manage YouTube Analytics groups and group items. |\n\n### Parameters\n\nThe table below lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`. |\n| `mine` | `boolean` This parameter can only be used in a properly [authorized request](/youtube/analytics/authentication). Set this parameter's value to `true` to retrieve all groups owned by the authenticated user. |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/analytics/authentication). **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The **onBehalfOfContentOwner** parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. |\n| `pageToken` | `string` The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"#kind\": \"youtube#groupListResponse\",\n \"#etag\": etag,\n \"#items[]\": [\n group Resource\n ],\n \"#nextPageToken\": string\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#groupListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of groups that match the API request parameters. Each item in the list represents a [group](/youtube/analytics/reference/groups) resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n\nErrors\n------\n\nThe API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the [error message](/youtube/analytics/reference/errors#general) documentation.\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
