Resolver problemas e corrigir erros no app Google Chat

Esta seção descreve problemas comuns que podem ocorrer ao criar e testar apps de chat.

Uma mensagem de card, uma caixa de diálogo ou uma prévia de link não é renderizada ou não funciona como esperado

Para receber ajuda com a solução de problemas de erros de cartão, consulte Resolver problemas e corrigir cards.

O app não está respondendo

Se você enviar uma mensagem para o app Chat e ele responder "O app não está respondendo", verifique a configuração do app Chat:

  1. No console de APIs do Google, clique em Menu > APIs e serviços > APIs e serviços ativados > API Google Chat > Configuração.

    Acessar a configuração da API Chat

  2. Em Recursos interativos, verifique se as configurações são adequadas para a funcionalidade do app. Se o app do Chat interage com os usuários, ative a opção Ativar recursos interativos:

    1. Por padrão, os apps podem responder a mensagens diretas dos usuários.
    2. Se o app responder a mensagens em espaços e grupos de chat, selecione Participar de espaços e conversas em grupo.
    3. Em Configurações de conexão, verifique se a arquitetura e os gatilhos (como o URL do endpoint HTTP, o ID de implantação e o nome da função do projeto do Apps Script, o nome do tópico do Cloud Pub/Sub ou o agente do Dialogflow) estão definidos corretamente e se o app foi implantado.
    4. Em Visibilidade, confira se os usuários adequados têm acesso ao app com um endereço de e-mail ou um grupo no domínio do Google Workspace. Se o app for implantado com o SDK do Google Workspace Marketplace, as configurações de visibilidade não serão necessárias porque as configurações do Google Workspace Marketplace têm precedência.
  3. Se o app for publicado com o SDK do Google Workspace Marketplace, revise as configurações do Google Workspace Marketplace.

  4. Clique em Salvar.

  5. Tente enviar uma mensagem para o app de novo.

A API Google Chat está disponível apenas para usuários do Google Workspace

Ao configurar o app Chat, você pode receber o erro Google Chat API is only available to Google Workspace users. Essa mensagem significa que a Conta do Google usada para configurar a API Chat não faz parte de uma organização do Google Workspace. Para criar um app do Chat ou usar a API Chat, você precisa ter uma conta do Google Workspace.

Os usuários do Google Chat podem usar os apps do Chat sem uma conta do Google Workspace. Para saber como os usuários descobrem e instalam apps do Chat, consulte Criar apps interativos do Google Chat.

Os usuários podem ser excluídos dos espaços

Se um administrador do Google Workspace impedir que os usuários ativem ou desativem o histórico de chat, talvez eles não consigam entrar ou permanecer em um espaço devido a um conflito entre uma configuração no nível do usuário que ativa ou desativa o histórico de chat e um espaço que herda a configuração forçada no nível da organização.

Por exemplo, se um usuário tiver uma configuração de histórico de chat definida como "ativada" e um espaço tiver uma configuração de histórico de chat definida como "desativada", talvez esse usuário não consiga entrar no espaço. Além disso, o usuário pode ser removido do espaço se tiver entrado antes do conflito e postar uma mensagem depois dele.

Nesse cenário e em outros em que há conflitos entre as configurações de histórico de chat, a API Chat talvez não consiga criar uma associação. Além disso, criar uma mensagem com autenticação do usuário pode remover do espaço o usuário autenticado com uma configuração de histórico de chat conflitante.

Para saber mais, consulte Os usuários podem ser excluídos dos espaços na Central de Ajuda para admins do Google Workspace.

Resolver problemas do serviço avançado de chat no Google Apps Script

Consulte a página do Apps Script sobre o Serviço avançado de chat.

Os usuários não conseguem adicionar um app do Chat a um espaço

Se os usuários encontrarem a mensagem de erro This organization's administrator must allow users to install this Chat app ao tentar adicionar um app do Chat a um espaço, esse erro pode ser causado por um dos seguintes motivos:

  • A organização desativou os apps do Chat.
  • A organização não adicionou esse app de chat específico à lista de permissões.

Se um usuário encontrar essa mensagem de erro ao tentar interagir com um app de chat, isso pode ser causado pela organização concedendo acesso a uma subunidade organizacional sem ativar para a unidade organizacional principal.

Para saber como resolver esse problema, consulte Permitir que os usuários instalem apps do Chat.

O administrador precisa conceder ao app o escopo de autorização OAuth necessário para essa ação.

Ao autenticar como um app do Chat, você pode receber o seguinte erro:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}?alt=json returned "The administrator must grant the app the required OAuth authorization scope for this action.". Details: "The administrator must grant the app the required OAuth authorization scope for this action.">

Essa mensagem de erro significa que um administrador do Google Workspace ainda não concedeu aprovação única ao app Chat para usar escopos de autorização que começam com o nome https://www.googleapis.com/auth/chat.app.*.

Para resolver o erro:

  • Peça para o admin do Google Workspace conceder aprovação ao seu app Chat. Ao lidar com esse erro na lógica do app Chat, considere enviar uma mensagem anunciando que o app Chat precisa da aprovação do admin para realizar a ação solicitada. Por exemplo: To perform this action, I need approval. <https://support.google.com/a?p=chat-app-auth|Learn more>.
  • Se o método da API Chat for compatível com o escopo de autorização https://www.googleapis.com/auth/chat.bot, que não exige aprovação do administrador, use-o. Para verificar quais escopos de autorização um método aceita, consulte Autenticar e autorizar apps do Google Chat e solicitações de API do Google Chat.

Resolver problemas do Cloud Functions

Se o app Chat for implementado com o Cloud Functions e não estiver funcionando, as seções a seguir vão ajudar a resolver problemas e corrigir o erro.

Verificar os registros do Cloud Functions

Primeiro, verifique os registros do Cloud Functions em busca de erros.

  1. No console de APIs do Google, acesse a página do Cloud Functions:

    Acesse o Cloud Functions

  2. Para abrir os registros, encontre a função do Cloud do app do Chat e clique em Mostrar ações > Conferir registros.

A Análise de registros é aberta e executa uma consulta mostrando os registros do Cloud Functions, incluindo erros.

Se as informações padrão registradas não forem suficientes para depurar seu app, adicione mais registros do código da função do Cloud. Consulte Ver e gravar registros do Cloud Functions.

Verificar erros da função do Cloud

Além dos registros, a função do Cloud também pode informar erros encontrados durante a execução.

  1. No console de APIs do Google, acesse a página do Cloud Functions:

    Acesse o Cloud Functions

  2. Clique na função do Cloud do seu app do Chat.

  3. Na página de detalhes da função, os erros são listados em Erros.

  4. Para resolver problemas com um erro, clique nele.

Corrigir erros comuns do Cloud Functions

Os erros a seguir às vezes são encontrados ao criar um app de chat com o Cloud Functions.

A função ChatApp na região REGION_NAME do projeto PROJECT_NAME já existe

Ao implantar uma função do Cloud, você pode receber o erro Function ChatApp in region REGION_NAME in project PROJECT_NAME already exists. Essa mensagem significa que outra função do Cloud tem o mesmo nome da que você está implantando. Mude o nome e implante a função novamente. Verifique se o app do Chat usa o URL de gatilho da função do Cloud, não o URL de gatilho da função do Cloud preexistente.

Um ou mais usuários mencionados na política não pertencem a um cliente permitido

Ao implantar uma função do Cloud, você pode receber o erro The operation cannot be completed on the function: "One or more users named in the policy do not belong to a permitted customer.". Se isso acontecer e você enviar uma mensagem para o app Chat, vai receber um erro informando que o app não está respondendo porque o Google Chat não consegue acessar o servidor que hospeda a função do Cloud. Essa mensagem significa que um nome de usuário chamado "allUsers" não tem permissão para chamar a função do Cloud. Ao conceder a "allUsers" o papel "Invocador do Cloud Functions", a função do Cloud que alimenta o app fica disponível publicamente e pode ser acessada sem autenticação. Para saber como atribuir um papel, consulte Conceder um único papel.

Esse erro pode significar que o projeto do Google Cloud está restrito a um domínio. Para mais informações sobre restrições de domínio, consulte Como restringir identidades por domínio.

Para resolver esse problema, verifique se a função do Cloud permite invocações não autenticadas. Para saber como permitir invocações não autenticadas de uma função do Cloud Functions, consulte Como permitir acesso público (não autenticado).

Apps do Chat que não são complementos: resolver problemas e corrigir erros do app Google Chat

A documentação a seguir se aplica a apps do Chat que não são complementos do Google Workspace. Para migrar um app do Chat que não é um complemento, consulte Converter um app do Chat em um complemento do Google Workspace.

Se um app do Chat que não é um complemento responder com "O app não está respondendo", verifique as seguintes configurações na guia Configuração da API Chat no Console de APIs do Google:

  • Em Status do app, confira se você selecionou Ativo: disponível para usuários.
  • Em Recursos interativos > Configurações de conexão, verifique se o URL do endpoint HTTP, o ID de implantação do Apps Script, o Nome do tópico do Cloud Pub/Sub ou o agente do Dialogflow estão configurados e implantados.