Lista moderatorów czatu na żywo. Prośba musi zostać zatwierdzona przez właściciela kanału czatu na żywo.
Typowe przypadki użycia
Żądanie
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
Parametry
W poniższej tabeli podano 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, dla którego interfejs API powinien zwracać 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 liveChatModerator części zasobów, które będą uwzględnione w odpowiedzi 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 zestawie wyników. Akceptowane wartości to 0 –50 (włącznie). Wartością domyślną jest 5 . |
|
pageToken |
string Parametr pageToken wskazuje konkretną stronę w zestawie wyników, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken wskazują inne strony, które można pobrać. |
Treść żądania
Podczas wywoływania tej metody nie podawaj treści żądania.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź w następującym formacie:
{ "kind": "youtube#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator Resource ] }
Usługi
Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:
Usługi | |
---|---|
kind |
string Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#liveChatModeratorListResponse . |
etag |
etag Otagowanie tego zasobu. |
prevPageToken |
string Token, którego można użyć jako wartości parametru pageToken w celu pobrania poprzedniej strony z zestawu wyników. |
nextPageToken |
string Token, który może zostać użyty jako wartość parametru pageToken , by pobrać następną stronę z zestawu wyników. |
pageInfo |
object Obiekt pageInfo zawiera informacje o stronicowaniu dla zestawu wyników. |
pageInfo.totalResults |
integer Łączna liczba wyników w zestawie wyników. |
pageInfo.resultsPerPage |
integer Liczba wyników zawartych 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. Może jednak zwrócić ogólne błędy interfejsu API wymienione w dokumentacji komunikatu o błędzie.
Wypróbuj
Użyj APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.