Activities: list

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

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

تأثیر سهمیه: تماس با این روش هزینه سهمیه ۱ واحدی دارد.

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

درخواست

درخواست 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
توجه: این پارامتر منسوخ شده است.
برای درخواست‌هایی که این پارامتر را تنظیم می‌کنند، پاسخ میانای برنامه‌سازی کاربردی حاوی مواردی مشابه مواردی است که کاربر خارج‌شده از سیستم در صفحه اصلی YouTube می‌بیند. توجه داشته باشید که این پارامتر فقط در درخواست مجاز مناسب قابل‌استفاده است.
mine boolean
از این پارامتر فقط می‌توان در درخواست مجاز مناسب استفاده کرد. برای بازیابی فید فعالیت‌های کاربر اصالت‌سنجی‌شده، مقدار این پارامتر را روی true تنظیم کنید.
پارامترهای اختیاری
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شود مشخص می‌کند. مقادیر پذیرفتنی از 0 تا 50 است. مقدار پیش‌فرض 5 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج شناسایی می‌کند که باید برگردانده شود. در پاسخ میانای برنامه‌سازی کاربردی، ویژگی‌های nextPageToken و prevPageToken صفحه‌های دیگری را که می‌توان بازیابی کرد شناسایی می‌کنند.
publishedAfter datetime
پارامتر publishedAfter زودترین تاریخ و زمانی را که ممکن است فعالیتی رخ داده باشد مشخص می‌کند تا آن فعالیت در پاسخ میانای برنامه‌سازی کاربردی گنجانده شود. اگر مقدار پارامتر روز را مشخص کند، اما زمان را مشخص نکند، همه فعالیت‌هایی که در آن روز رخ داده است در مجموعه نتایج گنجانده خواهد شد. مقدار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) مشخص شده است.
publishedBefore datetime
پارامتر publishedBefore تاریخ و زمانی را مشخص می‌کند که فعالیت باید قبل‌از آن رخ داده باشد تا آن فعالیت در پاسخ API گنجانده شود. اگر مقدار پارامتر روزی را مشخص کند، اما زمان را مشخص نکند، هر فعالیتی که در آن روز رخ داده باشد از مجموعه نتایج مستثنی خواهد شد. مقدار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) مشخص شده است.
regionCode string
پارامتر regionCode به «میانای برنامه‌سازی کاربردی» دستور می‌دهد نتایج را برای کشور مشخص‌شده برگرداند. مقدار پارامتر کد کشور 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
نوع منبع میانای برنامه‌سازی کاربردی را مشخص می‌کند. مقدار youtube#activityListResponse خواهد بود.
etag etag
Etag این منبع.
nextPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.
prevPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه قبلی در مجموعه نتایج استفاده شود.
pageInfo object
شیء pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله‌سازی می‌کند.
pageInfo.totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo.resultsPerPage integer
تعداد نتایج موجود در پاسخ میانای برنامه‌سازی کاربردی.
items[] list
فهرستی از فعالیت‌ها یا رویدادها که با معیارهای درخواست مطابقت دارد.

خطاها

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

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

امتحان کنید!

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