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

LiveBroadcasts: list

傳回與 API 要求參數相符的 YouTube 廣播訊息清單。

常見用途

要求

HTTP 要求

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

授權

這項要求需要授權，至少擁有下列其中一個範圍。閱讀更多有關驗證和授權的資訊，請參閱實作 OAuth 2.0 驗證。

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

參數

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

參數
必要參數
`part`	`string` `part` 參數會指定一份以半形逗號分隔的清單，其中包含 API 回應將包含的一或多個 `liveBroadcast` 資源屬性。可加入參數值的 `part` 名稱包括 `id`、`snippet`、`contentDetails`、`monetizationDetails` 和 `status`。
篩選器 (僅指定下列其中一個參數)
`broadcastStatus`	`string` `broadcastStatus` 參數會篩選 API 回應，只納入具有指定狀態的廣播訊息。可接受的值如下： `active` – 傳回目前的現場直播內容。 `all` – 傳回所有廣播訊息。 `completed` – 傳回已經結束的廣播。 `upcoming` – 傳回尚未開始的廣播。
`id`	`string` `id` 參數會指定以半形逗號分隔的 YouTube 廣播 ID 清單，識別要擷取的廣播訊息。在 `liveBroadcast` 資源中，`id` 屬性會指定廣播的 ID。
`mine`	`boolean` `mine` 參數可用來指示 API 只傳回已驗證使用者擁有的廣播訊息。如果只要擷取您自己的廣播訊息，請將參數值設為 `true`。
選用參數
`broadcastType`	`string` `broadcastType` 參數會篩選 API 回應，只納入指定類型的廣播訊息。這個參數應用於將 `mine` 參數設為 `true`，或是使用 `broadcastStatus` 參數的要求。預設值為 `event`。可接受的值為： `all` – 傳回所有廣播訊息。 `event`：只傳回已排定的活動直播。 `persistent`：僅傳回永久廣播訊息。
`maxResults`	`unsigned integer` `maxResults` 參數會指定結果集中應傳回的項目數量上限。可接受的值為 `0` 到 `50` (含頭尾)。預設值為 `5`。
`onBehalfOfContentOwner`	`string` 這個參數只能用於正確的授權請求。注意：這個參數僅適用於 YouTube 內容合作夥伴。「`onBehalfOfContentOwner`」參數代表要求的授權憑證可識別 YouTube 內容管理系統 (CMS) 使用者，該使用者代表參數值中指定的內容擁有者。這個參數適用於擁有並管理許多不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要進行驗證一次，就能存取所有的影片和頻道資料，不必分別提供各個頻道的驗證憑證。使用者驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。
`onBehalfOfContentOwnerChannel`	`string` 這個參數只能用於正確的授權請求。注意：這個參數僅適用於 YouTube 內容合作夥伴。 `onBehalfOfContentOwnerChannel` 參數可用於指定影片待加入頻道的 YouTube 頻道 ID。要求指定 `onBehalfOfContentOwner` 參數值時，這是必要參數，並只能搭配該參數使用。此外，請求必須使用與 `onBehalfOfContentOwner` 參數指定的內容擁有者相連結的 CMS 帳戶進行授權。最後，`onBehalfOfContentOwnerChannel` 參數值指定的頻道必須與 `onBehalfOfContentOwner` 參數指定的內容擁有者連結。這個參數適用於擁有並管理許多不同 YouTube 頻道的 YouTube 內容合作夥伴。讓內容擁有者只需進行驗證一次，就能代表參數值中指定的頻道執行動作，而不用為各個頻道提供驗證憑證。
`pageToken`	`string` `pageToken` 參數會指定結果集中應傳回的特定網頁。在 API 回應中，`nextPageToken` 和 `prevPageToken` 屬性會識別可擷取的其他網頁。

要求主體

呼叫此方法時，不要提供要求主體。

回應

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

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

屬性

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

屬性
`kind`	`string` 識別 API 資源的類型。值為 `youtube#liveBroadcastListResponse`。
`etag`	`etag` 這項資源的 Etag。
`nextPageToken`	`string` 可做為 `pageToken` 參數值的權杖，用來擷取結果集的下一頁。
`prevPageToken`	`string` 可做為 `pageToken` 參數值的權杖，用來擷取結果集中的上一頁。
`pageInfo`	`object` `pageInfo` 物件會封裝結果集的分頁資訊。
`pageInfo.totalResults`	`integer` 結果集的結果總數。
`pageInfo.resultsPerPage`	`integer` API 回應中包含的結果數量。
`items[]`	`list` 符合要求標準的廣播清單。

錯誤

下表顯示 API 為回應呼叫這個方法。詳情請參閱錯誤訊息。

錯誤類型	錯誤詳情	說明
`insufficientPermissions`	`insufficientLivePermissions`	這項要求未取得授權，無法擷取現場直播。
`insufficientPermissions`	`liveStreamingNotEnabled`	已授權請求的使用者不具備在 YouTube 上串流播放即時影像的功能。詳情請參閱功能使用資格。

試試看！

請使用 APIs Explorer 呼叫這個 API，並查看 API 要求和回應。