本頁面由 Cloud Translation API 翻譯而成。

Comments

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

方法

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

list: 會傳回與 API 要求參數相符的註解清單。立即試用。
插入: 建立回覆現有留言。注意：如要建立頂層註解，請使用 commentThreads.insert 方法。立即試用。
update: 修改註解。立即試用。
刪除: 刪除留言。立即試用。
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 格式指定。