Videos: batchGetStats

擷取符合 API 要求參數的影片統計資料清單。

配額影響：呼叫此方法會產生 1 個單位的配額費用。

要求

HTTP 要求

GET https://www.googleapis.com/youtube/v3/videos:batchGetStats

授權

如要對非公開影片使用這個方法，必須進行驗證，但公開影片則不需驗證。如果提供授權，要求必須至少使用下列其中一個範圍授權 (進一步瞭解驗證和授權)。

範圍
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

參數

下表列出這項查詢支援的參數。所有列出的參數都是查詢參數。

參數
必要參數
id string
id 參數會指定要擷取資源的 YouTube 影片 ID 清單 (以半形逗號分隔)。在 videoStat 資源中，id 屬性會指定影片的 ID。
part string
part 參數會指定以半形逗號分隔的一或多個 videoStat 資源屬性清單，API 回應會包含這些屬性。

下列清單包含可納入參數值的 part 名稱：
  • contentDetails
  • id
  • snippet
  • statistics
選用參數
onBehalfOfContentOwner string
這個參數只能用於已獲得授權的要求。注意：這個參數僅供 YouTube 內容合作夥伴使用。

onBehalfOfContentOwner 參數表示要求授權憑證會識別 YouTube 內容管理系統使用者，該使用者代表參數值中指定的內容擁有者行事。這項參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次，就能存取所有影片和頻道資料，不必為每個頻道提供驗證憑證。使用者用來驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。

要求主體

呼叫這個方法時，請勿提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "youtube#batchGetStatsResponse",
  "etag": etag,
  "items": [
    {
      "kind": "youtube#videoStats",
      "etag": etag,
      "id": string,
      "snippet": {
        "publishTime": datetime
      },
      "statistics": {
        "viewCount": unsigned long,
        "likeCount": unsigned long,
        "commentCount": unsigned long
      },
      "contentDetails": {
        "duration": string,
        "durationMillis": unsigned long
      }
    }
  ],
  "summary": {
    "requestedVideoCount": unsigned long,
    "succeededVideoCount": unsigned long,
    "failedVideoCount": unsigned long,
    "failedVideoIds": [
      string
    ]
  }
}

屬性

下表定義這個資源中顯示的屬性：

屬性
kind string
識別 API 資源的類型。值為 youtube#batchGetStatsResponse。
etag etag
這項資源的 Etag。
items[] list
符合要求條件的影片統計資料清單。
items[].id string
YouTube 用於識別影片的專屬 ID。
items[].snippet.publishTime datetime
影片上傳的日期和時間。
items[].statistics.viewCount unsigned long
影片的觀看次數。
items[].statistics.likeCount unsigned long
表示喜歡影片的使用者人數。
items[].statistics.commentCount unsigned long
影片的留言數。
items[].contentDetails.duration string
影片長度。
items[].contentDetails.durationMillis unsigned long
影片長度 (以毫秒為單位)。
summary object
batchGetStats 要求的摘要。
summary.requestedVideoCount unsigned long
要求的影片數量。
summary.succeededVideoCount unsigned long
成功上傳的影片數量。
summary.failedVideoCount unsigned long
失敗的影片數量。
summary.failedVideoIds[] list
失敗的影片 ID。

錯誤

API 未定義任何專屬於這個 API 方法的錯誤訊息。不過，這個方法仍可能會傳回 錯誤訊息說明文件中列出的一般 API 錯誤。