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 صفحه بعدی قابل بازیابی را مشخص می کند.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

پاسخ

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#groupListResponse خواهد بود.
etag etag
Etag این منبع
items[] list
لیستی از گروه هایی که با پارامترهای درخواست API مطابقت دارند. هر مورد در لیست نشان دهنده یک منبع group است.
nextPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.

خطاها

API هیچ پیام خطایی را که منحصر به این روش API باشد تعریف نمی کند. با این حال، این روش همچنان می تواند خطاهای عمومی API فهرست شده در اسناد پیام خطا را بازگرداند.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.

،

فهرستی از گروه‌هایی را برمی‌گرداند که با پارامترهای درخواست 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 صفحه بعدی قابل بازیابی را مشخص می کند.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

پاسخ

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#groupListResponse خواهد بود.
etag etag
Etag این منبع
items[] list
لیستی از گروه هایی که با پارامترهای درخواست API مطابقت دارند. هر مورد در لیست نشان دهنده یک منبع group است.
nextPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.

خطاها

API هیچ پیام خطایی را که منحصر به این روش API باشد تعریف نمی کند. با این حال، این روش همچنان می تواند خطاهای عمومی API فهرست شده در اسناد پیام خطا را بازگرداند.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.

،

فهرستی از گروه‌هایی را برمی‌گرداند که با پارامترهای درخواست 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 صفحه بعدی قابل بازیابی را مشخص می کند.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

پاسخ

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#groupListResponse خواهد بود.
etag etag
Etag این منبع
items[] list
لیستی از گروه هایی که با پارامترهای درخواست API مطابقت دارند. هر مورد در لیست نشان دهنده یک منبع group است.
nextPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.

خطاها

API هیچ پیام خطایی را که منحصر به این روش API باشد تعریف نمی کند. با این حال، این روش همچنان می تواند خطاهای عمومی API فهرست شده در اسناد پیام خطا را بازگرداند.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.