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,
    "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.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 格式指定。