Wyświetla listę moderatorów czatu na żywo. Prośba musi być zatwierdzona przez właściciela kanału czatu na żywo.
Typowe przypadki użycia
Prośba
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
Parametry
W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.
Parametry | ||
---|---|---|
Parametry wymagane | ||
liveChatId |
string Parametr liveChatId określa czat na żywo w YouTube, w przypadku którego interfejs API powinien zwrócić moderatorów. Identyfikator czatu na żywo powiązany z transmisją jest zwracany we właściwości snippet.liveChatId zasobu liveBroadcast . |
|
part |
string Parametr part określa części zasobów liveChatModerator , które będzie zawierać odpowiedź interfejsu API. Obsługiwane wartości to id i snippet . |
|
Parametry opcjonalne | ||
maxResults |
unsigned integer Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zbiorze wyników. Akceptowane wartości to od 0 do 50 (włącznie). Wartością domyślną jest 5 . |
|
pageToken |
string Parametr pageToken wskazuje w zestawie wyników konkretną stronę, która ma zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken identyfikują inne strony, które można pobrać. |
Treść żądania
Nie podawaj treści żądania podczas wywoływania tej metody.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:
{ "kind": "youtube#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator Resource ] }
Właściwości
Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:
Właściwości | |
---|---|
kind |
string Określa typ zasobu interfejsu API. Wartością będzie youtube#liveChatModeratorListResponse . |
etag |
etag ETag tego zasobu. |
prevPageToken |
string Token, który może być używany jako wartość parametru pageToken do pobierania poprzedniej strony w zestawie wyników. |
nextPageToken |
string Token, który może być używany jako wartość parametru pageToken w celu pobrania następnej strony w zestawie wyników. |
pageInfo |
object Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników. |
pageInfo.totalResults |
integer Łączna liczba wyników w zestawie. |
pageInfo.resultsPerPage |
integer Liczba wyników uwzględnionych w odpowiedzi interfejsu API. |
items[] |
list Lista moderatorów spełniających kryteria żądania. |
Błędy
Interfejs API nie definiuje żadnych komunikatów o błędach, które są unikalne dla tej metody interfejsu API. Ta metoda może jednak nadal zwracać ogólne błędy interfejsu API wymienione w dokumentacji komunikatów o błędach.
Wypróbuj
Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.