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 استفاده کنید.