Comments

منبع comment حاوی اطلاعاتی درباره یک نظر YouTube است. منبع comment می‌تواند نشان‌دهنده نظری درباره ویدیو یا کانال باشد. علاوه‌براین، نظر می‌تواند یک نظر سطح بالا یا پاسخی به یک نظر سطح بالا باشد.

روش‌ها

«میانای برنامه‌سازی کاربردی» از روش‌های زیر برای منابع comments پشتیبانی می‌کند:

فهرست
فهرستی از نظراتی را که با پارامترهای درخواست API مطابقت دارند برمی‌گرداند. اکنون امتحان کنید.
درج کردن
پاسخی به نظر موجود ایجاد می‌کند. توجه: برای ایجاد نظر سطح بالا، از روش commentThreads.insert استفاده کنید. اکنون امتحان کنید.
به‌روزرسانی
نظری را اصلاح می‌کند. اکنون امتحان کنید.
حذف
نظری را حذف می‌کند. اکنون امتحان کنید.
setModerationStatus
وضعیت تعدیل یک یا چند نظر را تنظیم می‌کند. درخواست API باید توسط مالک کانال یا ویدیو مرتبط با نظرات مجاز شود. اکنون امتحان کنید.

وکالت منابع

ساختار JSON زیر قالب منبع comments را نشان می‌دهد:

{
  "kind": "youtube#comment",
  "etag": etag,
  "id": string,
  "snippet": {
    "authorDisplayName": string,
    "authorProfileImageUrl": string,
    "authorChannelUrl": string,
    "authorChannelId": {
      "value": string
    },
    "channelId": string,
    "textDisplay": string,
    "textOriginal": string,
    "parentId": string,
    "canRate": boolean,
    "viewerRating": string,
    "likeCount": unsigned integer,
    "moderationStatus": string,
    "publishedAt": datetime,
    "updatedAt": datetime,
    "imageUrl": string
  }
}

مشخصات

جدول زیر خصوصیات نشان‌داده‌شده در این منبع را تعریف می‌کند:

مشخصات
kind string
نوع منبع «میانای برنامه‌سازی کاربردی» را مشخص می‌کند. مقدار youtube#comment خواهد بود.
etag etag
‫Etag این منبع.
id string
شناسه‌ای که YouTube برای شناسایی منحصربه‌فرد نظر استفاده می‌کند.
snippet object
شیء snippet حاوی جزئیات پایه درباره نظر است.
snippet.authorDisplayName string
نام نمایشی کاربری که نظر را پست کرده است.
snippet.authorProfileImageUrl string
نشانی وب چهرک کاربری که نظر را پست کرده است.
snippet.authorChannelUrl string
نشانی وب کانال YouTube نویسنده نظر، درصورت وجود.
snippet.authorChannelId object
این شیء اطلاعات مربوط به کانال YouTube نویسنده نظر را، درصورت وجود، کپسوله می‌کند.
snippet.authorChannelId.value string
شناسه کانال YouTube نویسنده نظر، درصورت دردسترس بودن.
snippet.channelId string
شناسه کانال YouTube مرتبط با نظر.
snippet.textDisplay string
متن نظر. نوشتار را می‌توان به‌صورت نوشتار ساده یا HTML بازیابی کرد. (روش‌های comments.list و commentThreads.list هر دو از پارامتر textFormat پشتیبانی می‌کنند که قالب نوشتار انتخاب‌شده را مشخص می‌کند.)

حتی نوشتار ساده ممکن است با نوشتار نظر اصلی متفاوت باشد. برای مثال، ممکن است پیوندهای ویدیو را با عنوان‌های ویدیو جایگزین کند.
snippet.textOriginal string
متن اصلی و خام نظر همان‌گونه که ابتدا پست شده یا آخرین‌بار به‌روزرسانی شده است. نوشتار اصلی تنها درصورتی به کاربر اصیل‌سازی‌شده برگردانده می‌شود که نویسنده نظر باشد.
snippet.parentId string
شناسه یکتای نظر اصلی. این دارایی فقط درصورتی تنظیم می‌شود که نظر به‌عنوان پاسخی به نظر دیگری ارسال شده باشد.
snippet.canRate boolean
این تنظیم نشان می‌دهد که آیا بیننده فعلی می‌تواند به نظر امتیاز دهد یا نه.
snippet.viewerRating string
رده‌بندی که بیننده به این نظر داده است. این ویژگی رده‌بندی‌های dislike را شناسایی نمی‌کند، هرچند این رفتار ممکن است تغییر کند. در این میان، اگر بیننده به نظر امتیاز مثبت داده باشد، مقدار ویژگی like است. در همه موارد دیگر، ازجمله زمانی که کاربر به نظر رده‌بندی منفی داده باشد یا به نظر رده‌بندی نداده باشد، مقدار none است.

مقادیر معتبر برای این ویژگی عبارتند از:
  • like
  • none
snippet.likeCount unsigned integer
تعداد کل پسندیدن‌ها (رده‌بندی‌های مثبت) که نظر دریافت کرده است.
snippet.moderationStatus string
وضعیت نظارت نظر. این ویژگی فقط درصورتی برگردانده می‌شود که درخواست API توسط مالک کانال یا ویدیویی که نظرات درخواستی روی آن گذاشته شده است، مجاز شده باشد. همچنین، اگر درخواست API از پارامتر فیلتر id استفاده کرده باشد، این ویژگی تنظیم نمی‌شود.

مقادیر معتبر برای این ویژگی عبارتند از:
  • heldForReview
  • likelySpam
  • published
  • rejected
snippet.publishedAt datetime
تاریخ و زمانی که نظر در ابتدا منتشر شده است. مقدار در قالب ISO 8601 مشخص شده است.
snippet.updatedAt datetime
تاریخ و زمان آخرین به‌روزرسانی نظر. مقدار در قالب ISO 8601 مشخص شده است.
snippet.imageUrl string
نشانی وب تصویر یا گیف پویانمایی‌شده پیوست‌شده به نظر، درصورت وجود. این ویژگی فقط زمانی وجود دارد که نظر حاوی تصویر یا گیف باشد. نشانی وب به‌عنوان پیوند امضاشده با زمان زنده بودن (TTL) شش ساعته ارائه می‌شود و شش ساعت پس‌از بازیابی منقضی می‌شود.