CommentThreads: list

فهرستی از رشته‌های نظر را برمی‌گرداند که با پارامترهای درخواست API مطابقت دارند.

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

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

درخواست

درخواست HTTP

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

مولفه های

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

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

لیست زیر شامل نام part است که می توانید در مقدار پارامتر بگنجانید:
  • id
  • replies
  • snippet
فیلترها (دقیقا یکی از پارامترهای زیر را مشخص کنید)
allThreadsRelatedToChannelId string
پارامتر allThreadsRelatedToChannelId به API دستور می دهد تا تمام رشته های نظر مرتبط با کانال مشخص شده را برگرداند.
id string
پارامتر id فهرستی از شناسه‌های رشته نظر جدا شده با کاما را برای منابعی که باید بازیابی شوند مشخص می‌کند.
videoId string
پارامتر videoId به API دستور می دهد تا رشته های نظر مرتبط با شناسه ویدیوی مشخص شده را برگرداند.
پارامترهای اختیاری
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند.

توجه: این پارامتر برای استفاده همراه با پارامتر id پشتیبانی نمی شود. مقادیر قابل قبول شامل 1 تا 100 است. مقدار پیش فرض 20 است.
moderationStatus string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. این پارامتر را به گونه ای تنظیم کنید که رشته های نظرات بازگشتی را به یک حالت تعدیل خاص محدود کند.

توجه: این پارامتر برای استفاده همراه با پارامتر id پشتیبانی نمی شود. مقدار پیش فرض published است.

مقادیر قابل قبول عبارتند از:
  • heldForReview – موضوعات نظراتی که در انتظار بررسی توسط ناظم هستند را بازیابی کنید. اگر نظر سطح بالا یا حداقل یکی از پاسخ‌های آن نظر در انتظار بررسی باشد، می‌توان یک موضوع نظر در پاسخ گنجانده شود.
  • likelySpam - موضوعات نظرات طبقه بندی شده به عنوان احتمال هرزنامه را بازیابی کنید. اگر نظر سطح بالا یا حداقل یکی از پاسخ‌ها به آن نظر به‌عنوان هرزنامه در نظر گرفته شود، می‌توان یک رشته نظر در پاسخ گنجانده شود.
  • published - موضوعات نظرات منتشر شده را بازیابی کنید. این مقدار پیش فرض است. در صورتی که نظر سطح بالای آن منتشر شده باشد، می توان یک رشته نظر در پاسخ گنجانده شود.
order string
پارامتر order ترتیبی را مشخص می‌کند که پاسخ API باید رشته‌های نظر را فهرست کند. مقادیر معتبر عبارتند از:
  • time - موضوعات نظرات بر اساس زمان مرتب شده اند. این رفتار به طور پیش فرض است.
  • relevance - موضوعات نظرات بر اساس ارتباط مرتب شده اند.
توجه: این پارامتر برای استفاده همراه با پارامتر id پشتیبانی نمی شود.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. در یک پاسخ API، ویژگی nextPageToken صفحه بعدی نتیجه قابل بازیابی را مشخص می کند.

توجه: این پارامتر برای استفاده همراه با پارامتر id پشتیبانی نمی شود.
searchTerms string
پارامتر searchTerms به API دستور می دهد تا پاسخ API را فقط شامل نظراتی باشد که شامل عبارات جستجوی مشخص شده باشد.

توجه: این پارامتر برای استفاده همراه با پارامتر id پشتیبانی نمی شود.
textFormat string
مقدار این پارامتر را بر روی html یا plainText تنظیم کنید تا به API دستور دهید نظرات ارسال شده توسط کاربران را با فرمت html یا متن ساده بازگرداند. مقدار پیش فرض html است.

مقادیر قابل قبول عبارتند از:
  • html - نظرات را در قالب HTML برمی گرداند. این مقدار پیش فرض است.
  • plainText - نظرات را در قالب متن ساده برمی گرداند.

درخواست بدن

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

واکنش

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

{
  "kind": "youtube#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread Resource
  ]
}

خواص

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

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

خطاها

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

نوع خطا جزئیات خطا شرح
badRequest (400) operationNotSupported فیلتر id فقط با نظرات مبتنی بر +Google سازگار است.
badRequest (400) processingFailure سرور API نتوانست درخواست را با موفقیت پردازش کند. در حالی که این می تواند یک خطای گذرا باشد، معمولاً نشان می دهد که ورودی درخواست نامعتبر است. ساختار منبع commentThread را در بدنه درخواست بررسی کنید تا مطمئن شوید که معتبر است.
forbidden (403) commentsDisabled ویدیویی که با پارامتر videoId شناسایی شده است، نظرات را غیرفعال کرده است.
forbidden (403) forbidden یک یا چند تا از رشته‌های نظر درخواستی به دلیل مجوزهای ناکافی قابل بازیابی نیستند. ممکن است درخواست به درستی مجاز نباشد.
notFound (404) channelNotFound کانال شناسایی شده توسط پارامتر allThreadsRelatedToChannelId یافت نشد.
notFound (404) commentThreadNotFound یک یا چند تا از رشته های نظر مشخص شده یافت نمی شود. مقادیر پارامتر id درخواست را بررسی کنید تا مطمئن شوید که درست است.
notFound (404) videoNotFound ویدیوی شناسایی شده توسط پارامتر videoId یافت نشد.

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

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