Groups: list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הפונקציה מחזירה רשימה של קבוצות שתואמות לפרמטרים של בקשת ה-API. לדוגמה, אפשר לאחזר את כל הקבוצות שבבעלות המשתמש המאומת, או לאחזר קבוצה אחת או יותר לפי המזהים הייחודיים שלהן.
בקשה
בקשת HTTP
GET https://youtubeanalytics.googleapis.com/v2/groups
אישור
הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
| טווחים |
| https://www.googleapis.com/auth/yt-analytics.readonly |
עיון בדוחות YouTube Analytics עבור התוכן שלכם ב-YouTube. ההיקף הזה מספק גישה למדדים של פעילות המשתמשים, כמו מספר הצפיות ומספר הדירוגים. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
תוכלו לצפות בדוחות כספיים של YouTube Analytics לגבי התוכן שלכם ב-YouTube. ההיקף הזה מספק גישה למדדי פעילות המשתמשים ולמדדים של ההכנסות המשוערות וביצועי המודעות. |
| https://www.googleapis.com/auth/youtube |
ניהול חשבון YouTube. ב-YouTube Analytics API, בעלי ערוצים משתמשים בהיקף הזה כדי לנהל קבוצות ופריטי קבוצות ב-YouTube Analytics. |
| https://www.googleapis.com/auth/youtubepartner |
הצגה וניהול של נכסי YouTube והתכנים המשויכים ב-YouTube. ב-YouTube Analytics API, בעלי תוכן משתמשים בהיקף הזה כדי לנהל קבוצות ופריטי קבוצות ב-YouTube Analytics. |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים הרשומים הם פרמטרים של שאילתות.
| פרמטרים |
| מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים) |
id |
string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי הקבוצות ב-YouTube של המשאבים שאתם מאתרים. כל קבוצה צריכה להיות בבעלות המשתמש המאומת. במשאב group, המאפיין id מציין את מזהה הקבוצה של YouTube.
לתשומת ליבכם: אם לא מציינים ערך לפרמטר id, צריך להגדיר את הפרמטר mine ל-true. |
mine |
boolean
ניתן להשתמש בפרמטר הזה רק בבקשה מורשית תקינה. כדי לאחזר את כל הקבוצות שבבעלות המשתמש המאומת, מגדירים את הערך של הפרמטר הזה כ-true. |
| פרמטרים אופציונליים |
onBehalfOfContentOwner |
string
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube שבבעלותם מנוהלים הרבה ערוצים שונים ב-YouTube.
הפרמטר onBehalfOfContentOwner מציין שהפרטים המזהים של הרשאת הגישה של הבקשה מזהים משתמש ב-YouTube שפועל בשם בעלי התוכן שצוין בערך הפרמטר. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ שלהם, בלי שיצטרכו לספק פרטי כניסה לאימות לכל ערוץ בנפרד. החשבון שבו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן ב-YouTube שצוין. |
pageToken |
string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובה מה-API, המאפיין nextPageToken מזהה את הדף הבא שאפשר לאחזר. |
גוף הבקשה
אין לספק גוף בקשה בקריאה ל-method הזה.
תשובה
מאפיינים
בטבלה הבאה מפורטים המאפיינים שמופיעים במשאב הזה:
| מאפיינים |
kind |
string
מזהה את סוג משאב ה-API. הערך יהיה youtube#groupListResponse. |
etag |
etag
ה-Etag של המשאב הזה. |
items[] |
list
רשימה של קבוצות שתואמות לפרמטרים של בקשת ה-API. כל פריט ברשימה מייצג משאב group. |
nextPageToken |
string
האסימון שאפשר להשתמש בו כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות. |
שגיאות
ה-API לא מגדיר הודעות שגיאה ייחודיות ל-method של ה-API הזה. עם זאת, עדיין יכולות להתקבל מהשיטה הזו שגיאות API כלליות שמפורטות במסמכי העזרה של הודעת השגיאה.
נסה בעצמך!
משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-21 (שעון UTC).
[null,null,["עדכון אחרון: 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."]]
