Activities: list

یوتیوب ویژگی بولتن کانال را منسوخ کرده است. روش activities.list هنوز بولتن های کانال را بر نمی گرداند و روش activities.insert دیگر پشتیبانی نمی شود. برای جزئیات بیشتر، لطفاً به مرکز راهنمایی YouTube مراجعه کنید.

فهرستی از رویدادهای فعالیت کانال را برمی‌گرداند که با معیارهای درخواست مطابقت دارند. به عنوان مثال، می توانید رویدادهای مرتبط با یک کانال خاص یا با کانال خود کاربر را بازیابی کنید.

تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 1 واحدی دارد.

موارد استفاده رایج

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/activities

مولفه های

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

مولفه های
پارامترهای مورد نیاز
part string
پارامتر part یک لیست جدا شده با کاما از یک یا چند ویژگی منبع activity را مشخص می کند که پاسخ API شامل می شود.

اگر پارامتر خاصیتی را مشخص کند که حاوی ویژگی های فرزند است، ویژگی های فرزند در پاسخ گنجانده می شود. برای مثال، در یک منبع activity ، ویژگی snippet حاوی ویژگی های دیگری است که نوع فعالیت، عنوان نمایشی برای فعالیت و غیره را مشخص می کند. اگر part=snippet تنظیم کنید، پاسخ API نیز شامل تمام آن ویژگی‌های تودرتو خواهد بود.

لیست زیر شامل نام part است که می توانید در مقدار پارامتر بگنجانید:
  • contentDetails
  • id
  • snippet
فیلترها (دقیقا یکی از پارامترهای زیر را مشخص کنید)
channelId string
پارامتر channelId یک شناسه کانال YouTube منحصر به فرد را مشخص می کند. سپس API لیستی از فعالیت های آن کانال را برمی گرداند.
home boolean
توجه: این پارامتر منسوخ شده است.
برای درخواست‌هایی که این پارامتر را تنظیم می‌کنند، پاسخ API حاوی مواردی مشابه مواردی است که کاربر از سیستم خارج شده در صفحه اصلی YouTube می‌بیند. توجه داشته باشید که این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است.
mine boolean
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. مقدار این پارامتر را روی true تنظیم کنید تا فید فعالیت های کاربر احراز هویت شده را بازیابی کنید.
پارامترهای اختیاری
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند. مقادیر قابل قبول شامل 0 تا 50 است. مقدار پیش فرض 5 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. در یک پاسخ API، ویژگی های nextPageToken و prevPageToken صفحات دیگری را شناسایی می کنند که می توانند بازیابی شوند.
publishedAfter datetime
پارامتر publishedAfter اولین تاریخ و زمانی را مشخص می کند که یک فعالیت ممکن است برای آن فعالیت در پاسخ API گنجانده شود. اگر مقدار پارامتر یک روز را مشخص کند، اما یک زمان را مشخص نمی کند، هر فعالیتی که در آن روز رخ داده است در مجموعه نتایج گنجانده می شود. مقدار در قالب ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) مشخص شده است.
publishedBefore datetime
پارامتر publishedBefore تاریخ و زمانی را مشخص می کند که قبل از آن یک فعالیت باید رخ داده باشد تا آن فعالیت در پاسخ API گنجانده شود. اگر مقدار پارامتر یک روز را مشخص کند، اما یک زمان را مشخص نمی کند، هر فعالیتی که در آن روز رخ داده است از مجموعه نتایج حذف می شود. مقدار در قالب ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) مشخص شده است.
regionCode string
پارامتر regionCode به API دستور می دهد تا نتایج را برای کشور مشخص شده برگرداند. مقدار پارامتر یک کد کشور ISO 3166-1 alpha-2 است. YouTube زمانی از این مقدار استفاده می‌کند که فعالیت قبلی کاربر مجاز در YouTube اطلاعات کافی برای تولید فید فعالیت ارائه نمی‌دهد.

درخواست بدن

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

واکنش

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

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

خواص

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

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#activityListResponse خواهد بود.
etag etag
Etag این منبع
nextPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.
prevPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه قبلی در مجموعه نتایج استفاده شود.
pageInfo object
شی pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند.
pageInfo. totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo. resultsPerPage integer
تعداد نتایج موجود در پاسخ API.
items[] list
فهرستی از فعالیت ها یا رویدادهایی که با معیارهای درخواست مطابقت دارند.

خطاها

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

نوع خطا جزئیات خطا شرح
forbidden (403) forbidden درخواست به درستی مجاز نیست.
forbidden (403) homeParameterDeprecated اطلاعات فعالیت صفحه اصلی کاربر از طریق این API در دسترس نیست. اگر در یک درخواست غیرمجاز، پارامتر home را روی true تنظیم کنید، ممکن است این خطا رخ دهد.
notFound (404) channelNotFound شناسه کانال شناسایی شده توسط پارامتر channelId درخواست یافت نمی شود.
notFound (404) homeChannelNotFound فید صفحه اصلی YouTube برای کاربر تأیید شده فعلی یافت نمی شود.
unauthorized (401) authorizationRequired درخواست از پارامتر home استفاده می کند اما به درستی مجاز نیست.

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

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