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. 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, 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 aguardar antes de solicitar outros resultados.
pageToken
com o valor nextPageToken
, e o servidor da API retorna mensagens de chat adicionais, se disponíveis. Novamente, dentro desse conjunto de resultados, as mensagens são ordenadas da mais antiga para a mais recente.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 dos recursos liveChatMessage que serão incluídas pela resposta da API. Os valores aceitos 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 do aplicativo específico com suporte no site do YouTube. Por exemplo, em inglês, a moeda aparece como $1.50 , mas em francês, como 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 de 200 a 2000 , inclusive. O valor padrão é 500 . |
|
pageToken |
string O parâmetro pageToken identifica uma página específica no conjunto de resultados que será retornado. 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 do 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 têm 88 x 88 pixels. Os valores aceitáveis estão na faixa de 16 a 720 , inclusive. |
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#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ 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 A 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 do conjunto de resultados. |
pollingIntervalMillis |
unsigned integer O tempo, em milissegundos, que o cliente precisa esperar antes de pesquisar novas mensagens de chat ao vivo novamente. |
offlineAt |
datetime A data e a hora em que a transmissão ao vivo subjacente ficou off-line. Essa propriedade só estará 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 da lista é um recurso liveChatMessage . |
activePollItem |
object Os dados da enquete na mensagem. Cada enquete é um recurso de liveChatMessage com o tipo pollEvent , que representa uma enquete ativa. Só pode haver uma enquete por chat. |
Erros
A tabela a seguir identifica 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 |
O chat ao vivo que você está tentando recuperar não foi encontrado. Verifique o valor do parâmetro liveChatId da solicitação para garantir que ele está correto. |
rateLimitExceeded |
rateLimitExceeded |
A solicitação foi enviada muito rapidamente depois da solicitação anterior. Esse erro ocorre quando as solicitações da 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.