SuperChatEvents: list

列出頻道過去 30 天內直播的超級留言活動。

常見用途

要求

HTTP 要求

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

授權

這項要求需要至少具備下列其中一個範圍的授權。如要進一步瞭解驗證和授權，請參閱「實作 OAuth 2.0 驗證」。

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

參數

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

參數
必要參數
part string
part 參數會指定 API 回應中要包含的 superChatEvent 資源部分。支援的值為 id 和 snippet。
選用參數
hl string
hl 參數會指示 API 伺服器依特定語言的慣例，設定 snippet.displayString 屬性值的格式，以便顯示超級聊天的購買金額和幣別。參數值必須是 i18nLanguages.list 方法傳回清單中的語言代碼。預設值為 en，這表示預設行為會將顯示字串格式化為英文。舉例來說，根據預設，字串的格式為 $1.00，而非 $1,00。
maxResults unsigned integer
maxResults 參數會指定結果集應傳回的項目數量上限。可接受的值介於 1 到 50 (包含這兩者) 之間。預設值為 5。
pageToken string
pageToken 參數會在結果集中標示應傳回的特定網頁。在 API 回應中，nextPageToken 和 prevPageToken 屬性會標示可擷取的其他網頁。

要求主體

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

回應

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

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

屬性

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

屬性
kind string
識別 API 資源的類型。值為 youtube#superChatEventListResponse。
etag etag
這項資源的 Etag。
nextPageToken string
可用於做為 pageToken 參數值的符記，用於擷取結果集的下一頁。
pageInfo object
pageInfo 物件封裝結果集的分頁資訊。
pageInfo.totalResults integer
結果集中的結果總數。
pageInfo.resultsPerPage integer
API 回應中包含的結果數量。
items[] list
符合要求條件的超級留言購買交易清單。

錯誤

下表列出 API 在回應對此方法的呼叫時可能傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。

錯誤類型 錯誤詳細資料 說明
forbidden (403) insufficientPermissions 要求未獲得適當授權，無法擷取超級留言事件。

試試看！

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