GroupItems: list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
مهم: درخواست‌های API به این روش نیاز به دسترسی به یکی از موارد زیر دارند:
- محدوده
https://www.googleapis.com/auth/youtube
یا - محدوده
https://www.googleapis.com/auth/youtube.readonly
و
محدوده https://www.googleapis.com/auth/yt-analytics.readonly
گزینه اول از یک محدوده استفاده می کند که اتفاقاً یک محدوده خواندن-نوشتن است، در حالی که گزینه دوم از دو محدوده فقط خواندنی استفاده می کند.
مجموعه ای از موارد گروهی را برمی گرداند که با پارامترهای درخواست API مطابقت دارند.
درخواست کنید
درخواست HTTP
GET https://youtubeanalytics.googleapis.com/v2/groupItems
مجوز
این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).
| محدوده ها |
|---|
| 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 استفاده می‌کنند. |
پارامترها
جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.
| پارامترها |
|---|
| پارامترهای مورد نیاز |
groupId | string
پارامتر id شناسه منحصربه‌فرد گروهی را که می‌خواهید آیتم‌های گروه را برای آن بازیابی کنید، مشخص می‌کند. |
| پارامترهای اختیاری |
onBehalfOfContentOwner | string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند.
پارامتر onBehalfOfContentOwner نشان می‌دهد که اعتبارنامه مجوز درخواست، کاربر YouTube را شناسایی می‌کند که از طرف مالک محتوای مشخص‌شده در مقدار پارامتر اقدام می‌کند. این به صاحبان محتوا امکان می‌دهد یک بار احراز هویت کنند و به تمام داده‌های ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حسابی که کاربر با آن احراز هویت می‌کند باید به مالک محتوای YouTube مشخص شده مرتبط باشد. |
درخواست بدن
هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.
پاسخ
در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:
{
"kind": "youtube#groupItemListResponse",
"etag": etag,
"items": [
groupItem Resource
]
} خواص
جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:
| خواص |
|---|
kind | string
نوع منبع API را مشخص می کند. مقدار youtube#groupItemListResponse خواهد بود. |
etag | etag
Etag این منبع |
items[] | list
لیستی از مواردی که گروه شامل می شود. هر مورد در لیست نشان دهنده یک منبع groupItem است. |
خطاها
API هیچ پیام خطایی را که منحصر به این روش API باشد تعریف نمی کند. با این حال، این روش همچنان می تواند خطاهای عمومی API فهرست شده در اسناد پیام خطا را بازگرداند.
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.
،
مهم: درخواست‌های API به این روش نیاز به دسترسی به یکی از موارد زیر دارند:
- محدوده
https://www.googleapis.com/auth/youtube
یا - محدوده
https://www.googleapis.com/auth/youtube.readonly
و
محدوده https://www.googleapis.com/auth/yt-analytics.readonly
گزینه اول از یک محدوده استفاده می کند که اتفاقاً یک محدوده خواندن-نوشتن است، در حالی که گزینه دوم از دو محدوده فقط خواندنی استفاده می کند.
مجموعه ای از موارد گروهی را برمی گرداند که با پارامترهای درخواست API مطابقت دارند.
درخواست کنید
درخواست HTTP
GET https://youtubeanalytics.googleapis.com/v2/groupItems
مجوز
این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).
| محدوده ها |
|---|
| 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 استفاده می‌کنند. |
پارامترها
جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.
| پارامترها |
|---|
| پارامترهای مورد نیاز |
groupId | string
پارامتر id شناسه منحصربه‌فرد گروهی را که می‌خواهید آیتم‌های گروه را برای آن بازیابی کنید، مشخص می‌کند. |
| پارامترهای اختیاری |
onBehalfOfContentOwner | string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند.
پارامتر onBehalfOfContentOwner نشان می‌دهد که اعتبارنامه مجوز درخواست، کاربر YouTube را شناسایی می‌کند که از طرف مالک محتوای مشخص‌شده در مقدار پارامتر اقدام می‌کند. این به صاحبان محتوا امکان می‌دهد یک بار احراز هویت کنند و به تمام داده‌های ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حسابی که کاربر با آن احراز هویت می‌کند باید به مالک محتوای YouTube مشخص شده مرتبط باشد. |
درخواست بدن
هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.
پاسخ
در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:
{
"kind": "youtube#groupItemListResponse",
"etag": etag,
"items": [
groupItem Resource
]
} خواص
جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:
| خواص |
|---|
kind | string
نوع منبع API را مشخص می کند. مقدار youtube#groupItemListResponse خواهد بود. |
etag | etag
Etag این منبع |
items[] | list
لیستی از مواردی که گروه شامل می شود. هر مورد در لیست نشان دهنده یک منبع groupItem است. |
خطاها
API هیچ پیام خطایی را که منحصر به این روش API باشد تعریف نمی کند. با این حال، این روش همچنان می تواند خطاهای عمومی API فهرست شده در اسناد پیام خطا را بازگرداند.
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThis API method retrieves a collection of group items that match the specified request parameters.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this method requires authorization with either the \u003ccode\u003ehttps://www.googleapis.com/auth/youtube\u003c/code\u003e scope or the combination of \u003ccode\u003ehttps://www.googleapis.com/auth/youtube.readonly\u003c/code\u003e and \u003ccode\u003ehttps://www.googleapis.com/auth/yt-analytics.readonly\u003c/code\u003e scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egroupId\u003c/code\u003e parameter is required to specify the unique ID of the group for which you want to retrieve items.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter is an optional parameter allowing content owners to authenticate once to access data for all their channels, and it is intended exclusively for YouTube content partners managing multiple channels.\u003c/p\u003e\n"],["\u003cp\u003eThe response body structure includes a \u003ccode\u003ekind\u003c/code\u003e property identifying the type as \u003ccode\u003eyoutube#groupItemListResponse\u003c/code\u003e, an \u003ccode\u003eetag\u003c/code\u003e, and an \u003ccode\u003eitems[]\u003c/code\u003e list containing the requested groupItem resources.\u003c/p\u003e\n"]]],["To retrieve group items, use a `GET` request to `https://youtubeanalytics.googleapis.com/v2/groupItems`. Authorization requires either the `https://www.googleapis.com/auth/youtube` or both `https://www.googleapis.com/auth/youtube.readonly` and `https://www.googleapis.com/auth/yt-analytics.readonly` scopes. The `groupId` parameter is required. The `onBehalfOfContentOwner` parameter is optional for content partners. The API returns a collection of group items; response properties include `kind`, `etag`, and a list of `items`. There is no request body.\n"],null,["# GroupItems: list\n\n**Important:** API requests to this method require access to either:\n\n- the `https://www.googleapis.com/auth/youtube` scope \n or\n- the `https://www.googleapis.com/auth/youtube.readonly` scope \n *and* \n the `https://www.googleapis.com/auth/yt-analytics.readonly` scope\n\nThe first option uses one scope, which happens to be a read-write scope, while the second option uses two read-only scopes.\nReturns a collection of group items that match the API request parameters.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://youtubeanalytics.googleapis.com/v2/groupItems\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| **Required parameters** |||\n| `groupId` | `string` The **id** parameter specifies the unique ID of the group for which you want to retrieve group items. |\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\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#groupItemListResponse\",\n \"#etag\": etag,\n \"#items[]\": [\n groupItem Resource\n ]\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#groupItemListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of items that the group contains. Each item in the list represents a [groupItem](/youtube/analytics/reference/groupItems) resource. |\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."]]
