Configurar a API Google Chat

Cada app do Google Chat criado exige um projeto do Google Cloud próprio com a API Chat ativada e configurada. Nesta página, mostramos como configurar a API Chat.

Pré-requisitos

Escolher um nome de exibição, avatar e descrição para o app do Chat

Ao ativar a API Chat, você configura os detalhes do app do 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 o app do Chat no Marketplace, você também precisa especificar os detalhes que aparecem na listagem do Marketplace do app do Chat.

Para chamar a API Chat, configure um app do Google Chat com as seguintes informações:

Campo Descrição Formato
Nome do app O nome de exibição do app do Chat. Até 25 caracteres alfanuméricos
URL do avatar A imagem que aparece como o avatar do app do Chat avatar. 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 do 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 no Chat.

Por exemplo, se você chamar o método spaces.create(), o Chat vai incluir o nome do app do 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 apps do Chat, os usuários também podem ver ou usar essas informações das seguintes maneiras:

  • Invocar o app do Chat mencionando o nome dele.
  • Encontrar e iniciar uma mensagem direta com o app do Chat. No menu Apps, as mensagens diretas mostram o nome e o avatar do app do Chat.
  • Na barra de escrita, os usuários podem navegar pelos apps do Chat e ver o nome, o avatar e a descrição deles.

Configurar o app do Chat no console do Google Cloud

Quando tiver os detalhes do app do Chat, abra o projeto na nuvem e configure a API Chat:

  1. No console do Google Cloud, acesse a página da API Chat e clique na página 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 no botão Ativar recursos interativos para desativar os recursos interativos do app do 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 Registros, marque a caixa de seleção Registrar erros no Cloud 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

Você pode conceder a usuários específicos acesso à página de configuração do app do Chat concedendo a eles o papel do Proprietário de apps do Chat ou Visualizador de apps do Chat Google Cloud Identity and Access Management (IAM). Os usuários com esses papéis não podem navegar até a página de configuração dos apps do 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 na nuvem host do app do 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 do Chat.