Список модераторов для живого чата. Запрос должен быть одобрен владельцем канала чата.
Распространенные случаи использования
Запрос
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 Этаг этого ресурса. |
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.