Comments

یک منبع comment حاوی اطلاعاتی درباره یک نظر YouTube است. یک منبع 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
  }
}

خواص

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

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#comment خواهد بود.
etag etag
Etag این منبع
id string
شناسه ای که YouTube برای شناسایی منحصر به فرد نظر استفاده می کند.
snippet object
شی snippet حاوی جزئیات اولیه در مورد نظر است.
snippet. authorDisplayName string
نام نمایشی کاربری که نظر را ارسال کرده است.
snippet. authorProfileImageUrl string
نشانی اینترنتی آواتار کاربری که نظر را ارسال کرده است.
snippet. authorChannelUrl string
URL کانال YouTube نویسنده نظر، در صورت وجود.
snippet. authorChannelId object
این شیء در صورت موجود بودن، اطلاعات مربوط به کانال یوتیوب نویسنده نظر را محصور می کند.
snippet.authorChannelId. value string
شناسه کانال یوتیوب نویسنده نظر، در صورت وجود.
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 مشخص شده است.