Configurar a API Google Chat

Cada app do Google Chat que você cria precisa ter um projeto do Google Cloud próprio com a API Chat ativada e configurada. Esta página mostra como configurar a API Chat.

Pré-requisitos

Escolha um nome de exibição, um avatar e uma descrição para o app de chat

Ao ativar a API Chat, você configura os detalhes sobre seu app de chat que aparecem para os usuários no Chat, incluindo um nome de exibição, avatar e descrição. Esses detalhes só aparecem no Chat. Para publicar seu app de chat no Marketplace, você também precisa especificar os detalhes que aparecem na página do Marketplace do app de chat.

Para chamar a API Chat, você precisa configurar um app do Google Chat com as seguintes informações:

Campo Descrição Formato
Nome do app O nome de exibição do app Chat. Até 25 caracteres alfanuméricos
URL do avatar A imagem que aparece como avatar do seu app Chat. Um URL HTTPS que aponta para uma imagem gráfica quadrada (PNG ou JPEG). O tamanho recomendado é de 256 x 256 pixels ou mais.
Descrição Uma breve descrição da finalidade do app Chat. Até 40 caracteres alfanuméricos

O nome, o avatar e a descrição do app do Chat são mostrados aos usuários na interface do Chat. Para algumas solicitações de gravação da API Chat, o Chat usa essas informações para atribuir as ações que um app do Chat realiza.

Por exemplo, se você chamar o método spaces.create(), o Chat vai incluir o nome do app Chat na descrição de quem criou o espaço, conforme mostrado na imagem a seguir:

O app Google Chat cria um espaço para um usuário.
Figura 1. A mensagem de atribuição que o Chat mostra quando o método spaces.create() é usado para criar um espaço em nome de um usuário.

Para interagir com os apps do Chat, os usuários também podem conferir ou usar essas informações das seguintes maneiras:

  • Invoque o app Chat mencionando o nome dele.
  • Encontre e inicie uma mensagem direta com o app Chat. No menu Apps, as mensagens diretas mostram o nome e o avatar do app Chat.
  • Na barra de criação, os usuários podem navegar pelos apps de chat e conferir o nome, o avatar e a descrição deles.

Configurar o app Chat no console do Google Cloud

Quando você tiver os detalhes do app do Chat, abra seu projeto do Cloud e configure a API Chat:

  1. No console do Google Cloud, acesse a página da API Chat e clique em Configuração:

    Acessar a página de configuração da API Chat

  2. Em Informações do aplicativo, preencha os campos Nome do app, URL do avatar e Descrição.

  3. Em Recursos interativos, clique na opção Ativar recursos interativos para desativar os recursos interativos do app Chat. Você pode configurar isso mais tarde. Para saber como configurar e criar recursos interativos, consulte Receber e responder a interações do usuário.

  4. Opcional: em Logs, marque a caixa de seleção Registrar erros no Logging para usar o Google Cloud Logging. Para mais informações, consulte Consultar registros de erros de apps do Chat.

  5. Clique em Salvar.

Conceder permissão a outras pessoas para configurar a API Chat

É possível conceder acesso a usuários específicos à página de configuração do app de chat concedendo a eles o Papel de proprietário de apps de chat ou Leitor de apps de chat do Google Cloud Identity Access Management (IAM). Os usuários com essas funções não podem navegar até a página de configuração dos apps de chat usando o painel APIs e serviços, mas podem acessar a página de configuração navegando até o console do Google Cloud para o projeto de hospedagem do app de chat da seguinte maneira:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

em que PROJECT_ID é o ID do projeto do Google Cloud que hospeda o app Chat.