Comments: list

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

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

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

درخواست

درخواست HTTP

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

پارامترها

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

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

فهرست زیر حاوی نام‌های part است که می‌توانید در مقدار پارامتر اضافه کنید:
  • id
  • snippet
فیلترها (دقیقاً یکی از پارامترهای زیر را مشخص کنید)
id string
پارامتر id فهرست جداشده با کاما از شناسه‌های نظر را برای منابعی که درحال بازیابی هستند مشخص می‌کند. در منبع comment، ویژگی id شناسه نظر را مشخص می‌کند.
parentId string
پارامتر parentId شناسه نظری را که پاسخ‌های آن باید بازیابی شود مشخص می‌کند.

توجه: YouTube درحال‌حاضر فقط از پاسخ به نظرات سطح بالا پشتیبانی می‌کند. بااین‌حال، پاسخ به پاسخ ممکن است در آینده پشتیبانی شود.
پارامترهای اختیاری
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شود مشخص می‌کند.

توجه: این پارامتر برای استفاده همراه با پارامتر id پشتیبانی نمی‌شود. مقادیر پذیرفتنی از 1 تا 100 (شامل این دو عدد) است. مقدار پیش‌فرض 20 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج شناسایی می‌کند که باید برگردانده شود. در پاسخ میانای برنامه‌سازی کاربردی، ویژگی nextPageToken صفحه بعدی نتیجه را که قابل‌بازیابی است شناسایی می‌کند.

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

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

متن درخواست

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

پاسخ

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

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

مشخصات

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

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

خطاها

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

نوع خطا جزئیات خطا شرح
badRequest (400) operationNotSupported فیلتر شناسه فقط با نظرات مبتنی بر Google+ سازگار است.
forbidden (403) forbidden یک یا چند نظر درخواست‌شده به‌دلیل نداشتن اجازه‌های کافی بازیابی نشد. ممکن است درخواست به‌درستی مجاز نشده باشد.
notFound (404) commentNotFound یک یا چند نظر مشخص‌شده پیدا نشد. مقادیر پارامترهای id و parentId درخواست را بررسی کنید تا مطمئن شوید درست هستند.

امتحان کنید!

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