Groups: list
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
API isteği parametreleriyle eşleşen grupların listesini döndürür. Örneğin, kimliği doğrulanmış kullanıcının sahip olduğu tüm grupları veya benzersiz kimliklerine göre bir veya daha fazla grubu alabilirsiniz.
İstek
HTTP isteği
GET https://youtubeanalytics.googleapis.com/v2/groups
Yetkilendirme
Bu istek, aşağıdaki kapsamlardan en az biriyle yetkilendirme gerektirir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).
Kapsamlar |
https://www.googleapis.com/auth/yt-analytics.readonly |
YouTube içeriğiniz için YouTube Analytics raporlarını görüntüleyin. Bu kapsam, görüntüleme sayısı ve puan sayısı gibi kullanıcı etkinliği metriklerine erişim sağlar. |
https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
YouTube içeriğiniz için YouTube Analytics'teki parasal raporları görüntüleyin. Bu kapsam, kullanıcı etkinliği metriklerine, tahmini gelir ve reklam performansı metriklerine erişim sağlar. |
https://www.googleapis.com/auth/youtube |
YouTube hesabınızı yönetin. YouTube Analytics API'de kanal sahipleri, YouTube Analytics gruplarını ve grup öğelerini yönetmek için bu kapsamı kullanır. |
https://www.googleapis.com/auth/youtubepartner |
YouTube'daki YouTube öğelerini ve ilişkili içeriği görüntüleyin ve yönetin. YouTube Analytics API'de içerik sahipleri, YouTube Analytics gruplarını ve grup öğelerini yönetmek için bu kapsamı kullanır. |
Parametreler
Aşağıdaki tabloda bu sorgunun desteklediği parametreler listelenmiştir. Listelenen tüm parametreler sorgu parametreleridir.
Parametreler |
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin) |
id |
string
id parametresi, alınan kaynakların YouTube grup kimliklerinin virgülle ayrılmış listesini belirtir. Her grubun, kimliği doğrulanmış kullanıcıya ait olması gerekir. Bir group kaynağında id özelliği, grubun YouTube grup kimliğini belirtir.
id parametresi için değer belirtmezseniz mine parametresini true olarak ayarlamanız gerektiğini unutmayın. |
mine |
boolean
Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. Kimliği doğrulanmış kullanıcının sahip olduğu tüm grupları almak için bu parametrenin değerini true olarak ayarlayın. |
İsteğe bağlı parametreler |
onBehalfOfContentOwner |
string
Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. Not: Bu parametre, birçok farklı YouTube kanalına sahip olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır.
onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin, parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube kullanıcısını tanımladığını gösterir. Bu sayede içerik sahipleri, her kanal için kimlik doğrulama kimlik bilgilerini sağlamak zorunda kalmadan tek seferde kimlik doğrulama yapabilir ve tüm video ve kanal verilerine erişebilir. Kullanıcının kimliğini doğruladığı hesap, belirtilen YouTube içerik sahibine bağlı olmalıdır. |
pageToken |
string
pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. API yanıtında nextPageToken mülkü, alınabilecek bir sonraki sayfayı tanımlar. |
İstek içeriği
Bu yöntemi çağırırken istek gövdesini belirtmeyin.
Yanıt
Özellikler
Aşağıdaki tabloda bu kaynakta görünen özellikler tanımlanmaktadır:
Özellikler |
kind |
string
API kaynağının türünü tanımlar. Değer youtube#groupListResponse olur. |
etag |
etag
Bu kaynağın Etag değeri. |
items[] |
list
API isteği parametreleriyle eşleşen grupların listesi. Listedeki her öğe bir group kaynağını temsil eder. |
nextPageToken |
string
Sonuç kümesindeki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilen jeton. |
Hatalar
API, bu API yöntemine özgü herhangi bir hata mesajı tanımlamaz. Ancak bu yöntem yine de hata mesajı dokümanlarında listelenen genel API hatalarını döndürebilir.
Deneyin!
Bu API'yi çağırmak ve API isteğini ve yanıtını görmek için APIs Explorer simgesini kullanın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-08-21 UTC.
[null,null,["Son güncelleme tarihi: 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."]]