Comments: list

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

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

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

درخواست

درخواست HTTP

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

مولفه های

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

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

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

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

توجه: این پارامتر برای استفاده همراه با پارامتر id پشتیبانی نمی شود. مقادیر قابل قبول شامل 1 تا 100 است. مقدار پیش فرض 20 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. در یک پاسخ API، ویژگی 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
نوع منبع API را مشخص می کند. مقدار youtube#commentListResponse خواهد بود.
etag etag
Etag این منبع
nextPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.
pageInfo object
شی pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند.
pageInfo. totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo. resultsPerPage integer
تعداد نتایج موجود در پاسخ API.
items[] list
فهرستی از نظراتی که با معیارهای درخواست مطابقت دارند.

خطاها

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

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

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

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