列出聊天室管理員。這項要求必須由聊天室頻道擁有者授權。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
參數
下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
liveChatId |
string liveChatId 參數會指定 API 應傳回管理員的 YouTube 聊天室。與廣播相關聯的聊天室 ID 會在 liveBroadcast 資源的 snippet.liveChatId 屬性中傳回。 |
|
part |
string part 參數會指定 API 回應將包含的 liveChatModerator 資源部分。支援的值為 id 和 snippet 。 |
|
選用參數 | ||
maxResults |
unsigned integer maxResults 參數會指定要在結果集中傳回的項目數量上限。可接受的值為 0 到 50 (含首尾)。預設值為 5 。 |
|
pageToken |
string pageToken 參數可指定要傳回結果集中的網頁。在 API 回應中,nextPageToken 和 prevPageToken 屬性可識別其他可擷取的網頁。 |
要求主體
呼叫此方法時請不要提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "youtube#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator Resource ] }
屬性
下表定義此資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源類型。這個值會是 youtube#liveChatModeratorListResponse 。 |
etag |
etag 這項資源的 Etag。 |
prevPageToken |
string 這個符記可用做 pageToken 參數的值,以擷取結果集的上一頁。 |
nextPageToken |
string 這個符記可用做 pageToken 參數的值,以擷取結果集的下一頁。 |
pageInfo |
object pageInfo 物件會封裝結果集的分頁資訊。 |
pageInfo.totalResults |
integer 結果集中的結果總數。 |
pageInfo.resultsPerPage |
integer API 回應中包含的結果數量。 |
items[] |
list 符合要求條件的管理員清單。 |
錯誤
API 不會定義任何專屬於此 API 方法的錯誤訊息。但這個方法仍可能傳回錯誤訊息文件中所列的一般 API 錯誤。
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。