Comments

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

روش‌ها

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

list
لیستی از نظراتی را که با پارامترهای درخواست API مطابقت دارند، برمی‌گرداند. همین حالا امتحان کنید .
insert
یک پاسخ به یک نظر موجود ایجاد می‌کند. توجه: برای ایجاد یک نظر سطح بالا، از متد commentThreads.insert استفاده کنید. اکنون آن را امتحان کنید .
update
یک نظر را اصلاح می‌کند. اکنون آن را امتحان کنید .
delete
یک نظر را حذف می‌کند. اکنون آن را امتحان کنید .
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
نوع منبع API را مشخص می‌کند. مقدار آن youtube#comment خواهد بود.
etag etag
برچسب E این منبع.
id string
شناسه‌ای که یوتیوب برای شناسایی منحصر به فرد نظر استفاده می‌کند.
snippet object
شیء snippet شامل جزئیات اولیه در مورد نظر است.
snippet. authorDisplayName string
نام نمایشی کاربری که نظر را ارسال کرده است.
snippet. authorProfileImageUrl string
نشانی اینترنتی (URL) آواتار کاربری که نظر را ارسال کرده است.
snippet. authorChannelUrl string
آدرس اینترنتی کانال یوتیوب نویسنده نظر، در صورت وجود.
snippet. authorChannelId object
این شیء، در صورت وجود، اطلاعات مربوط به کانال یوتیوب نویسنده نظر را کپسوله‌سازی می‌کند.
snippet.authorChannelId. value string
شناسه کانال یوتیوب نویسنده نظر، در صورت وجود.
snippet. channelId string
شناسه کانال یوتیوب مرتبط با نظر.
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
آدرس اینترنتی (URL) تصویر یا GIF متحرک پیوست شده به نظر، در صورت وجود. این ویژگی فقط زمانی وجود دارد که نظر حاوی تصویر یا GIF باشد. این URL به عنوان یک لینک امضا شده با مدت زمان ماندگاری شش ساعته (TTL) ارائه می‌شود و شش ساعت پس از بازیابی منقضی می‌شود.