LiveChatModerators: list

Lista moderadores de um chat ao vivo. A solicitação precisa ser autorizada pelo proprietário do canal do chat ao vivo.

Casos de uso comuns

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/youtube/v3/liveChat/moderators

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
liveChatId string
O parâmetro liveChatId especifica o chat ao vivo do YouTube em que a API precisa retornar moderadores. O ID do chat ao vivo associado a uma transmissão é retornado na propriedade snippet.liveChatId do recurso liveBroadcast.
part string
O parâmetro part especifica as partes dos recursos liveChatModerator que serão incluídas pela resposta da API. Os valores aceitos são id e snippet.
Parâmetros opcionais
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados. Os valores aceitáveis são de 0 a 50, inclusive. O valor padrão é 5.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que será retornado. Em uma resposta da API, as propriedades nextPageToken e prevPageToken identificam outras páginas que podem ser recuperadas.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "youtube#liveChatModeratorListResponse",
  "etag": etag,
  "prevPageToken": string,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatModerator Resource
  ]
}

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
Identifica o tipo de recurso da API. O valor será youtube#liveChatModeratorListResponse.
etag etag
A Etag desse recurso.
prevPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior do conjunto de resultados.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página do conjunto de resultados.
pageInfo object
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer
O número de resultados incluídos na resposta da API.
items[] list
Uma lista de moderadores que correspondem aos critérios de solicitação.

Erros

A API não define mensagens de erro exclusivas para esse método de API. No entanto, esse método ainda pode retornar erros gerais da API listados na documentação da mensagem de erro.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.