Comments

comment 資源包含單一 YouTube 留言的相關資訊。comment 資源可以代表影片或頻道的留言。此外，該留言可以是頂層評論，或是對頂層評論的回覆。

方法

這個 API 支援下列 comments 資源的方法：

list

傳回符合 API 要求參數的註解清單。立即試用。

插入

對現有留言進行回覆。注意：如要建立頂層註解，請使用 commentThreads.insert 方法。 立即試用。

更新

修改留言。 立即試用。

刪除

刪除留言。 立即試用。

setModerationStatus

設定一或多則留言的審核狀態。API 要求必須由與留言相關的頻道或影片的擁有者授權。立即試用。

MarkAsSpam

指出來電者認為一或多則留言應標記為垃圾內容。立即試用。

資源表示法

以下 JSON 結構顯示了 comments 資源的格式：

{
  "kind": "youtube#comment",
  "etag": etag,
  "id": string,
  "snippet": {
    "authorDisplayName": string,
    "authorProfileImageUrl": string,
    "authorChannelUrl": string,
    "authorChannelId": {
      "value": string
    },
    "channelId": string,
    "videoId": 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 在識別留言時使用的 ID。
snippet	object snippet 物件包含註解的基本詳細資料。
snippet.authorDisplayName	string 留言的顯示名稱。
snippet.authorProfileImageUrl	string 留言張貼者的顯示圖片網址。
snippet.authorChannelUrl	string 留言作者的 YouTube 頻道網址 (如果有的話)。
snippet.authorChannelId	object 這個物件會封裝有關留言作者 YouTube 頻道的資訊 (如果有的話)。
snippet.authorChannelId.value	string 留言者 YouTube 頻道的 ID (如果有的話)。
snippet.channelId	string 與留言相關聯的 YouTube 頻道 ID。 如果是影片評論，這個屬性可用來識別影片的頻道，snippet.videoId 屬性可用來識別影片。 如果該留言是頻道留言，則此屬性可識別與留言相關的頻道。
snippet.videoId	string 留言所參考影片 ID。只有對影片發表過評論的這個屬性才會顯示。
snippet.textDisplay	string 留言文字。則可以使用純文字或 HTML 格式擷取文字。(comments.list 和 commentThreads.list 方法都支援 textFormat 參數，能指定所需的文字格式)。 請注意，即使是純文字之外的文字，也可能與原始評論文字不同。例如用影片標題取代影片連結。
snippet.textOriginal	string 最初發布或上次更新評論的原始原始文字。只有經過驗證的使用者能夠存取原始文字，且只有留言的作者才會保證原始文字。
snippet.parentId	string 父項留言的專屬 ID。此註解只會在將留言提交為其他留言的回覆時設定。
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 格式指定。