LiveChatMessages: list

Lista as mensagens de chat ao vivo de um chat específico.

Quando você faz sua primeira solicitação para recuperar mensagens de chat, a API retorna parte ou todo o histórico de chat, dependendo da duração dele. As mensagens na resposta são ordenadas da mais antiga para a mais recente.
  • O nextPageToken na resposta fornece um token que, na próxima solicitação, vai identificar o próximo conjunto de resultados que o cliente da API precisa recuperar.
  • A propriedade pollingIntervalMillis indica quanto tempo o cliente da API precisa esperar antes de solicitar mais resultados.
Quando você solicita mais resultados, define o parâmetro pageToken como o valor nextPageToken, e o servidor de API retorna mais mensagens de chat, se disponíveis. Novamente, nesse conjunto de resultados, as mensagens são ordenadas da mais antiga para a mais recente.

Impacto na cota:uma chamada para esse método tem um custo de cota de 5 unidades.

Casos de uso comuns

Solicitação

Solicitação HTTP

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

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 ID do chat cujas mensagens serão retornadas. 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 do recurso liveChatMessage que a resposta da API vai incluir. Os valores compatíveis são id, snippet e authorDetails.
Parâmetros opcionais
hl string
O parâmetro hl instrui a API a recuperar uma string de exibição de moeda localizada para um idioma específico do aplicativo compatível com o site do YouTube. Por exemplo, em inglês, a moeda seria exibida como $1.50, mas em francês, seria 1,50$.

O valor do parâmetro precisa ser um código de idioma incluído na lista retornada pelo método i18nLanguages.list.
maxResults unsigned integer

O parâmetro maxResults especifica o número máximo de mensagens que precisam ser retornadas no conjunto de resultados. Os valores aceitáveis são 200 a 2000, inclusive. O valor padrão é 500.

A solicitação inicial feita sem um token de continuação só vai conter as mensagens mais recentes. Esse valor pode ser menor que maxResults, se fornecido.

A API não recupera mensagens mais antigas do que as retornadas pela solicitação inicial feita sem um token de continuação.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que precisa ser retornada. Em uma resposta da API, a propriedade nextPageToken identifica outras páginas que podem ser recuperadas.
profileImageSize unsigned integer
O parâmetro profileImageSize especifica o tamanho das fotos de perfil do usuário que precisam ser retornadas no conjunto de resultados. As imagens são quadradas. O valor padrão é 88, o que significa que as imagens serão de 88 x 88 pixels. Os valores aceitáveis estão no intervalo de 16 a 720, inclusive.

Corpo da solicitação

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

Resposta

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

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage 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#liveChatMessageListResponse.
etag etag
O Etag desse recurso.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados.
pollingIntervalMillis unsigned integer
O período, em milissegundos, que o cliente precisa esperar antes de pesquisar novamente novas mensagens de chat ao vivo.
offlineAt datetime
A data e a hora em que a transmissão ao vivo subjacente ficou off-line. Essa propriedade só está presente se o stream já estiver off-line. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
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 mensagens. Cada item na lista é um recurso liveChatMessage.
activePollItem object
Os dados da enquete na mensagem. Cada enquete é um recurso liveChatMessage com o tipo pollEvent, que representa uma enquete ativa. Só pode haver uma enquete por chat.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação da mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
forbidden (403) forbidden Você não tem as permissões necessárias para recuperar mensagens do chat ao vivo especificado.
forbidden (403) liveChatDisabled O chat ao vivo não está ativado para a transmissão especificada.
forbidden (403) liveChatEnded O chat ao vivo especificado não está mais ativo.
notFound (404) liveChatNotFound Não foi possível encontrar o chat ao vivo que você está tentando recuperar. Verifique se o valor do parâmetro liveChatId da solicitação está correto.
rateLimitExceeded rateLimitExceeded A solicitação foi enviada muito rapidamente após a anterior. Esse erro ocorre quando as solicitações de API para recuperar mensagens são enviadas com mais frequência do que as taxas de atualização do YouTube, o que desperdiça largura de banda desnecessariamente.

Confira!

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