Google Chat API  |  Google for Developers (original) (raw)

Com a API Google Chat, é possível criar apps do Chat para integrar seus serviços ao Google Chat e gerenciar recursos da plataforma, como espaços, participantes e mensagens.

Serviço: chat.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso o aplicativo precise usar bibliotecas próprias para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins de IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de descoberta:

Endpoint de serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir, e todos os URIs abaixo são relativos a ele:

Recurso REST: v1.customEmojis

Métodos
create POST /v1/customEmojis Cria um emoji personalizado.
delete DELETE /v1/{name=customEmojis/*} Exclui um emoji personalizado.
get GET /v1/{name=customEmojis/*} Retorna detalhes sobre um emoji personalizado.
list GET /v1/customEmojis Lista os emojis personalizados visíveis para o usuário autenticado.
Métodos
download GET /v1/media/{resourceName=**} Baixa mídia.
upload POST /upload/v1/{parent=spaces/*}/attachments:upload Faz upload de um anexo.

Recurso REST: v1.spaces

Métodos
completeImport POST /v1/{name=spaces/*}:completeImport Conclui o processo de importação do espaço especificado e o torna visível para os usuários.
create POST /v1/spaces Cria um espaço.
delete DELETE /v1/{name=spaces/*} Exclui um espaço nomeado.
findDirectMessage GET /v1/spaces:findDirectMessage Retorna a mensagem direta com o usuário especificado.
findGroupChats GET /v1/spaces:findGroupChats Retorna todos os espaços com spaceType == GROUP_CHAT, cujas associações humanas contêm exatamente o usuário de chamada e os usuários especificados em FindGroupChatsRequest.memberships.
get GET /v1/{name=spaces/*} Retorna detalhes sobre um espaço.
list GET /v1/spaces Lista os espaços de que o autor da chamada faz parte.
patch PATCH /v1/{space.name=spaces/*} Atualiza um espaço.
search GET /v1/spaces:search Retorna uma lista de espaços em uma organização do Google Workspace com base na pesquisa de um administrador.
setup POST /v1/spaces:setup Cria um espaço e adiciona usuários especificados a ele.

Recurso REST: v1.spaces.members

Métodos
create POST /v1/{parent=spaces/*}/members Cria uma assinatura para o app de chat chamador, um usuário ou um Grupo do Google.
delete DELETE /v1/{name=spaces/*/members/*} Exclui uma assinatura.
get GET /v1/{name=spaces/*/members/*} Retorna detalhes sobre uma assinatura.
list GET /v1/{parent=spaces/*}/members Lista as assinaturas em um espaço.
patch PATCH /v1/{membership.name=spaces/*/members/*} Atualiza uma assinatura.

Recurso REST: v1.spaces.messages

Métodos
create POST /v1/{parent=spaces/*}/messages Cria uma mensagem em um espaço do Google Chat.
delete DELETE /v1/{name=spaces/*/messages/*} Exclui uma mensagem.
get GET /v1/{name=spaces/*/messages/*} Retorna detalhes sobre uma mensagem.
list GET /v1/{parent=spaces/*}/messages Lista as mensagens em um espaço de que o usuário é participante, incluindo mensagens de participantes e espaços bloqueados.
patch PATCH /v1/{message.name=spaces/*/messages/*} Atualiza uma mensagem.
update PUT /v1/{message.name=spaces/*/messages/*} Atualiza uma mensagem.

Recurso REST: v1.spaces.messages.attachments

Métodos
get GET /v1/{name=spaces/*/messages/*/attachments/*} Recebe os metadados de um anexo de mensagem.

Recurso REST: v1.spaces.messages.reactions

Métodos
create POST /v1/{parent=spaces/*/messages/*}/reactions Cria uma reação e a adiciona a uma mensagem.
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*} Exclui uma reação a uma mensagem.
list GET /v1/{parent=spaces/*/messages/*}/reactions Lista as reações a uma mensagem.

Recurso REST: v1.spaces.spaceEvents

Métodos
get GET /v1/{name=spaces/*/spaceEvents/*} Retorna um evento de um espaço do Google Chat.
list GET /v1/{parent=spaces/*}/spaceEvents Lista eventos de um espaço do Google Chat.

Recurso REST: v1.users.sections

Métodos
create POST /v1/{parent=users/*}/sections Cria uma seção no Google Chat.
delete DELETE /v1/{name=users/*/sections/*} Exclui uma seção do tipo CUSTOM_SECTION.
list GET /v1/{parent=users/*}/sections Lista as seções disponíveis para o usuário do Chat.
patch PATCH /v1/{section.name=users/*/sections/*} Atualiza uma seção.
position POST /v1/{name=users/*/sections/*}:position Muda a ordem de classificação de uma seção.

Recurso REST: v1.users.sections.items

Métodos
list GET /v1/{parent=users/*/sections/*}/items Lista os itens em uma seção.
move POST /v1/{name=users/*/sections/*/items/*}:move Move um item de uma seção para outra.

Recurso REST: v1.users.spaces

Métodos
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState} Retorna detalhes sobre o estado de leitura de um usuário em um espaço, usado para identificar mensagens lidas e não lidas.
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState} Atualiza o estado de leitura de um usuário em um espaço, usado para identificar mensagens lidas e não lidas.

Recurso REST: v1.users.spaces.spaceNotificationSetting

Métodos
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting} Recebe a configuração de notificação do espaço.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting} Atualiza a configuração de notificação do espaço.

Recurso REST: v1.users.spaces.threads

Métodos
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState} Retorna detalhes sobre o estado de leitura de um usuário em uma conversa, usado para identificar mensagens lidas e não lidas.