列出特定即時通訊的聊天室訊息。
當您第一次提出擷取即時通訊訊息的要求時,API 會根據該記錄的時間長度,傳回部分或所有即時通訊記錄。回應中的訊息會由舊到新排序。
當您第一次提出擷取即時通訊訊息的要求時,API 會根據該記錄的時間長度,傳回部分或所有即時通訊記錄。回應中的訊息會由舊到新排序。
- 回應中的
nextPageToken
會提供權杖,請在下一個要求中識別下一組 API 用戶端應擷取的結果。 pollingIntervalMillis
屬性表示 API 用戶端在要求其他結果前應等待的時間長度。
pageToken
參數設為 nextPageToken
值,API 伺服器會傳回其他即時通訊訊息 (如果有的話)。同樣,在結果集中,郵件會按照由舊到新的順序排序。常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/liveChat/messages
參數
下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
liveChatId |
string liveChatId 參數會指定要傳回訊息的即時通訊 ID。與廣播相關聯的聊天室 ID 會在 liveBroadcast 資源的 snippet.liveChatId 屬性中傳回。 |
|
part |
string part 參數會指定 API 回應會包含的 liveChatMessage 資源部分。支援的值為 id 、snippet 和 authorDetails 。 |
|
選用參數 | ||
hl |
string hl 參數會指示 API 根據 YouTube 網站支援的特定應用程式語言,擷取本地化幣別顯示字串。舉例來說,貨幣會顯示為 $1.50 ,但在法文中會顯示為 1,50$ 。參數值必須是 i18nLanguages.list 方法所傳回的清單中所含的語言代碼。 |
|
maxResults |
unsigned integer maxResults 參數會指定結果集應傳回的訊息數量上限。可接受的值為 200 到 2000 (含頭尾)。預設值為 500 。 |
|
pageToken |
string pageToken 參數可在結果集中指明應傳回的特定網頁。在 API 回應中,nextPageToken 屬性會識別可擷取的其他網頁。 |
|
profileImageSize |
unsigned integer profileImageSize 參數會指定結果集應傳回的使用者個人資料圖片大小。圖片為正方形。預設值為 88 ,代表圖片的尺寸為 88px x 88px。可接受的值介於 16 到 720 之間 (含頭尾)。 |
要求主體
呼叫此方法時,不要提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "youtube#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatMessage Resource ] }
屬性
下表定義了這項資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源的類型。值為 youtube#liveChatMessageListResponse 。 |
etag |
etag 這項資源的 Etag。 |
nextPageToken |
string 可做為 pageToken 參數值的權杖,用於擷取結果集中的下一頁。 |
pollingIntervalMillis |
unsigned integer 在輪詢新聊天室訊息之前,用戶端應等待的時間長度 (以毫秒為單位)。 |
offlineAt |
datetime 基礎直播離線的日期與時間。只有在串流處於離線狀態時,系統才會顯示這項資源。這個值是以 ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) 格式指定。 |
pageInfo |
object pageInfo 物件會封裝結果集的分頁資訊。 |
pageInfo.totalResults |
integer 結果集的結果總數。 |
pageInfo.resultsPerPage |
integer API 回應中包含的結果數量。 |
items[] |
list 訊息清單。清單中的每個項目都是 liveChatMessage 資源。 |
activePollItem |
object 訊息中的意見調查資料。每個意見調查都是類型為 pollEvent 的 liveChatMessage 資源,代表進行中的意見調查。每個聊天室只能有一個意見調查。 |
錯誤
下表列出 API 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
forbidden (403) |
forbidden |
你沒有擷取指定聊天室訊息所需的權限。 |
forbidden (403) |
liveChatDisabled |
指定的播送內容未啟用即時通訊功能。 |
forbidden (403) |
liveChatEnded |
指定的聊天室已不存在。 |
notFound (404) |
liveChatNotFound |
找不到你要擷取的聊天室。檢查要求的 liveChatId 參數值,確認值正確無誤。 |
rateLimitExceeded |
rateLimitExceeded |
在先前的要求後,系統太快傳送該要求。當 API 要求擷取訊息的頻率高於 YouTube 的重新整理頻率,就會發生這個錯誤,導致不必要的頻寬浪費。 |
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。