Groups: list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Gibt eine Liste der Gruppen zurück, die den API-Anfrageparametern entsprechen. Sie können beispielsweise alle Gruppen abrufen, die dem authentifizierten Nutzer gehören, oder Sie können eine oder mehrere Gruppen anhand ihrer eindeutigen ID abrufen.
Anfrage
HTTP-Anfrage
GET https://youtubeanalytics.googleapis.com/v2/groups
Autorisierung
Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).
| Ebenen |
| https://www.googleapis.com/auth/yt-analytics.readonly |
YouTube Analytics-Berichte für deine YouTube-Inhalte abrufen Dieser Bereich bietet Zugriff auf Messwerte zur Nutzeraktivität, z. B. die Anzahl der Aufrufe und Bewertungen. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
YouTube Analytics-Finanzberichte für deine YouTube-Inhalte abrufen Diese Zugriffsebene bietet Zugriff auf Messwerte zu Nutzeraktivitäten sowie auf geschätzte Umsatz- und Anzeigenleistungsmesswerte. |
| https://www.googleapis.com/auth/youtube |
YouTube-Konto verwalten In der YouTube Analytics API können Kanalinhaber mit diesem Umfang YouTube Analytics-Gruppen und -Gruppenelemente verwalten. |
| https://www.googleapis.com/auth/youtubepartner |
YouTube-Assets und zugehörige Inhalte auf YouTube abrufen und verwalten In der YouTube Analytics API verwenden Rechteinhaber diesen Umfang, um YouTube Analytics-Gruppen und -Gruppenelemente zu verwalten. |
Parameter
In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.
| Parameter |
| Filter (genau einen der folgenden Parameter angeben) |
id |
string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Gruppen-IDs für die abgerufenen Ressourcen an. Jede Gruppe muss dem authentifizierten Nutzer gehören. In einer group-Ressource gibt das Attribut id die YouTube-Gruppen-ID der Gruppe an.
Wenn du keinen Wert für den Parameter id angibst, musst du den Parameter mine auf true setzen. |
mine |
boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf true fest, um alle Gruppen abzurufen, deren Eigentümer der authentifizierte Nutzer ist. |
| Optionale Parameter |
onBehalfOfContentOwner |
string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis:Dieser Parameter ist ausschließlich für YouTube-Inhaltspartner gedacht, die Inhaber und Administrator vieler verschiedener YouTube-Kanäle sind.
Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsdaten der Anfrage einen YouTube-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Rechteinhaber können sich nur einmal authentifizieren und erhalten Zugriff auf alle ihre Video- und Kanaldaten, ohne dass sie für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben müssen. Das Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein. |
pageToken |
string
Der Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort gibt die Property nextPageToken die nächste Seite an, die abgerufen werden kann. |
Anfragetext
Geben Sie beim Aufruf dieser Methode keinen Anfragetext an.
Antwort
Attribute
In der folgenden Tabelle werden die Eigenschaften definiert, die in dieser Ressource angezeigt werden:
| Attribute |
kind |
string
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#groupListResponse. |
etag |
etag
Das ETag dieser Ressource. |
items[] |
list
Eine Liste von Gruppen, die den API-Anfrageparametern entsprechen. Jedes Element in der Liste stellt eine group-Ressource dar. |
nextPageToken |
string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite in der Ergebnismenge abzurufen. |
Fehler
Die API definiert keine Fehlermeldungen, die nur für diese API-Methode gelten. Mit dieser Methode können jedoch weiterhin allgemeine API-Fehler zurückgegeben werden, die in der Dokumentation der Fehlermeldung aufgeführt sind.
Testen!
Verwenden Sie die APIs Explorer, um diese API aufzurufen und die API-Anfrage und ‑Antwort zu sehen.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-08-21 (UTC).
[null,null,["Zuletzt aktualisiert: 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."]]
