Показывает список модераторов чата. Запрос должен быть авторизован владельцем канала, на котором проводится трансляция.
Примеры использования
Запрос
HTTP-запрос
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
Параметры
В таблице ниже перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.
| Параметры | ||
|---|---|---|
| Обязательные параметры | ||
liveChatId |
stringПараметр liveChatId указывает чат YouTube, для которого API должен возвращать модераторов. Идентификатор чата, связанного с трансляцией, возвращается в свойстве snippet.liveChatId ресурса liveBroadcast. |
|
part |
stringПараметр part указывает, какие части ресурса liveChatModerator будут включены в ответ API. Допустимые значения: 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 и ответ.