Enviar uma mensagem

Neste guia, explicamos as diferentes maneiras como os apps do Google Chat enviam mensagens:

  • Envie mensagens de texto e de cartão em tempo real respondendo a uma interação do usuário.
  • Envie mensagens de texto e de cartão de forma assíncrona chamando o método create no recurso Message.
  • Inicie ou responda a uma conversa.
  • Envie e nomeie uma mensagem.

O recurso Message representa uma mensagem de texto ou card no Google Chat. Você pode create, get, update ou delete em uma mensagem na API Google Chat chamando os métodos correspondentes. Para saber mais sobre mensagens de texto e card, consulte Visão geral das mensagens do Google Chat.

O tamanho máximo da mensagem (incluindo qualquer texto ou cartão) é de 32.000 bytes. Se uma mensagem exceder esse tamanho, o app do Chat poderá enviar várias mensagens.

Em vez de chamar o método create no recurso Message da API Google Chat para enviar uma mensagem de texto ou card de forma assíncrona, os apps do Google Chat também podem criar mensagens para responder às interações do usuário em tempo real. As respostas às interações do usuário não exigem autenticação e são compatíveis com outros tipos de mensagens, incluindo caixas de diálogo interativas e visualizações de links. Confira mais detalhes em Receber e responder a interações com o app Google Chat.

Pré-requisitos

Node.js

Python

  • Uma conta do Google Workspace com acesso ao Google Chat.
  • Python 3.6 ou superior
  • pip (em inglês)

  • As bibliotecas de cliente mais recentes do Google para Python. Para instalá-los ou atualizá-los, execute o seguinte comando na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth
  • Um projeto do Google Cloud com a API Google Chat ativada e configurada. Para ver as etapas, consulte Criar um app do Google Chat.

  • Autorização configurada para que o app do Chat envie mensagens assíncronas. Nenhuma configuração de autorização é necessária para enviar mensagens em tempo real.

Apps Script

Enviar mensagens de texto

Esta seção descreve como enviar mensagens de texto de duas maneiras:

  • Envie uma mensagem de texto em tempo real respondendo a uma interação do usuário.
  • Envie uma mensagem de texto chamando a API Google Chat de forma assíncrona.

Enviar uma mensagem de texto em tempo real

Neste exemplo, o app do Chat cria e envia uma mensagem de texto sempre que é adicionada a um espaço. Para saber mais sobre as práticas recomendadas para integração de usuários, consulte Introdução à integração útil de pessoas e espaços.

Para enviar uma mensagem de texto quando um usuário adiciona seu app do Chat a um espaço, o app do Chat responde a um evento de interação ADDED_TO_SPACE. Para responder a eventos de interação ADDED_TO_SPACE com uma mensagem de texto, use o seguinte código:

Node.js

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
exports.onMessage = function onMessage(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    res.send(
      'Hello! This function is meant to be used in a Google Chat space.');
  }

  // Send an onboarding message when added to a Chat space
  if (req.body.type === 'ADDED_TO_SPACE') {
    res.json({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar
      from Google Chat. Take a look at your schedule today by typing
      `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To
      learn what else I can do, type `/help`.'
    });
  }
};

Apps Script

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
function onAddToSpace(event) {

  return {
    'text': 'Hi, Cymbal at your service. I help you manage your calendar
    from Google Chat. Take a look at your schedule today by typing
    `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn
    what else I can do, type `/help`.'
  }
}

O exemplo de código retorna a seguinte mensagem de texto:

Exemplo de mensagem de integração.

Enviar uma mensagem de texto de forma assíncrona

A seção a seguir explica como enviar uma mensagem de texto de forma assíncrona com a autenticação do app e do usuário.

Para enviar uma mensagem de texto, faça o seguinte na sua solicitação:

  • Com a autenticação do app, especifique o escopo de autorização chat.bot. Com a autenticação do usuário, especifique o escopo de autorização chat.messages.create.
  • Chame o método create no recurso Message.

Enviar uma mensagem de texto com a autenticação do app

Veja como enviar uma mensagem de texto com a autenticação do app:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_create_text_message_app.py.

  2. Inclua o seguinte código em chat_create_text_message_app.py:

    from apiclient.discovery import build
from google.oauth2 import service_account

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = service_account.Credentials.from_service_account_file(
    'credentials.json', scopes=SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Create a Chat message.
result = chat.spaces().messages().create(

    # The space to create the message in.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE',

    # The message to create.
    body={'text': 'Hello, world!'}

).execute()

print(result)

  3. No código, substitua SPACE por um nome de espaço, que pode ser encontrado no método spaces.list() na API Chat ou no URL de um espaço.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_create_text_message_app.py

A API Chat retorna uma instância de Message que detalha a mensagem enviada.

Enviar uma mensagem de texto com a autenticação do usuário

Veja como enviar uma mensagem de texto com a autenticação do usuário:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_create_text_message_user.py.

  2. Inclua o seguinte código em chat_create_text_message_user.py:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.messages.create"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then creates a text message in a Chat space.
    '''

    # Start with no credentials.
    creds = None

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                    'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().messages().create(

        # The space to create the message in.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        parent='spaces/SPACE',

        # The message to create.
        body={'text': 'Hello, world!'}

    ).execute()

    # Prints details about the created message.
    print(result)

if __name__ == '__main__':
    main()

  3. No código, substitua SPACE por um nome de espaço, que pode ser encontrado no método spaces.list() na API Chat ou no URL de um espaço.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_create_text_message_user.py

A API Chat retorna uma instância de Message que detalha a mensagem enviada.

Enviar mensagens do card

Esta seção descreve como enviar mensagens de cards de duas maneiras:

  • Envie uma mensagem de cartão em tempo real respondendo a uma interação do usuário.
  • Envie uma mensagem de cartão chamando a API Google Chat de forma assíncrona.

Enviar uma mensagem de cartão em tempo real

Os apps do Chat podem criar mensagens de card para responder a uma interação do usuário, como quando um usuário envia uma mensagem ou adiciona o app do Chat a um espaço. Para saber mais sobre como responder às interações do usuário, consulte Receber e responder aos eventos de interação com o app do Chat.

Neste exemplo, um usuário envia uma mensagem para um app do Chat, e o app do Chat responde enviando uma mensagem de card que mostra o nome do usuário e a imagem do avatar:

Um app do Chat respondendo com um card com o nome de exibição e a imagem do avatar do remetente.

Node.js

nó/avatar-app/index.js
/**
 * Google Cloud Function that responds to messages sent from a
 * Google Chat room.
 *
 * @param {Object} req Request sent from Google Chat room
 * @param {Object} res Response to send back
 */
exports.helloChat = function helloChat(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    res.send('Hello! This function is meant to be used in a Google Chat ' +
      'Room.');
  }

  const sender = req.body.message.sender.displayName;
  const image = req.body.message.sender.avatarUrl;

  const data = createMessage(sender, image);

  res.send(data);
};

/**
 * Creates a card with two widgets.
 * @param {string} displayName the sender's display name
 * @param {string} imageUrl the URL for the sender's avatar
 * @return {Object} a card with the user's avatar.
 */
function createMessage(displayName, imageUrl) {
  const cardHeader = {
    title: `Hello ${displayName}!`,
  };

  const avatarWidget = {
    textParagraph: {text: 'Your avatar picture: '},
  };

  const avatarImageWidget = {
    image: {imageUrl},
  };

  const avatarSection = {
    widgets: [
      avatarWidget,
      avatarImageWidget,
    ],
  };

  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: cardHeader,
        sections: [avatarSection],
      }
    }],
  };
}

Python

python/avatar-app/main.py
from typing import Any, Mapping

import flask
import functions_framework


# Google Cloud Function that responds to messages sent in
# Google Chat.
#
# @param {Object} req Request sent from Google Chat.
# @param {Object} res Response to send back.
@functions_framework.http
def hello_chat(req: flask.Request) -> Mapping[str, Any]:
  if req.method == "GET":
    return "Hello! This function must be called from Google Chat."

  request_json = req.get_json(silent=True)

  display_name = request_json["message"]["sender"]["displayName"]
  avatar = request_json["message"]["sender"]["avatarUrl"]

  response = create_message(name=display_name, image_url=avatar)

  return response


# Creates a card with two widgets.
# @param {string} name the sender's display name.
# @param {string} image_url the URL for the sender's avatar.
# @return {Object} a card with the user's avatar.
def create_message(name: str, image_url: str) -> Mapping[str, Any]:
  avatar_image_widget = {"image": {"imageUrl": image_url}}
  avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
  avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}

  header = {"title": f"Hello {name}!"}

  cards = {
      "text": "Here's your avatar",
      "cardsV2": [
          {
              "cardId": "avatarCard",
              "card": {
                  "name": "Avatar Card",
                  "header": header,
                  "sections": [avatar_section],
              },
          }
      ]
  }

  return cards

Apps Script

Neste exemplo, uma mensagem de cartão é enviada retornando o JSON do cartão. Você também pode usar o serviço de card do Apps Script.

apps-script/avatar-app/hello-chat.gs
/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onMessage(event) {
  const displayName = event.message.sender.displayName;
  const avatarUrl = event.message.sender.avatarUrl;

  return createMessage(displayName, avatarUrl);
}

/**
 * Creates a card with two widgets.
 * @param {string} displayName the sender's display name
 * @param {string} avatarUrl the URL for the sender's avatar
 * @return {Object} a card with the sender's avatar.
 */
function createMessage(displayName, avatarUrl) {
  const cardHeader = {
    title: `Hello ${displayName}!`
  };

  const avatarWidget = {
    textParagraph: {text: 'Your avatar picture: '}
  };

  const avatarImageWidget = {
    image: {imageUrl: avatarUrl}
  };

  const avatarSection = {
    widgets: [
      avatarWidget,
      avatarImageWidget
    ],
  };

  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: cardHeader,
        sections: [avatarSection],
      }
    }],
  };
}

Enviar uma mensagem de cartão de forma assíncrona

Para enviar uma mensagem de cartão, transmita o seguinte na sua solicitação:

  • Com a autenticação do app, especifique o escopo de autorização chat.bot. Não é possível enviar uma mensagem de cartão com autenticação do usuário.
  • Chame o método create no recurso Message.

Este é um exemplo de mensagem de cartão:

Uma mensagem de cartão enviada com a API Chat.

Veja como enviar uma mensagem de cartão com a autenticação do app:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_create_card_message.py.

  2. Inclua o seguinte código em chat_create_card_message.py:

    from apiclient.discovery import build
from google.oauth2 import service_account

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = service_account.Credentials.from_service_account_file(
    'credentials.json', scopes=SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Create a Chat message.
result = chat.spaces().messages().create(

    # The space to create the message in.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE',

    # The message to create.
    body=
    {
      'cardsV2': [{
        'cardId': 'createCardMessage',
        'card': {
          'header': {
            'title': 'A card message!',
            'subtitle': 'Created with the Chat API',
            'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png',
            'imageType': 'CIRCLE'
          },
          'sections': [
            {
              'widgets': [
                {
                  'buttonList': {
                    'buttons': [
                      {
                        'text': 'Read the docs!',
                        'onClick': {
                          'openLink': {
                            'url': 'https://developers.google.com/chat'
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      }]
    }

).execute()

print(result)

  3. No código, substitua SPACE por um nome de espaço, que pode ser encontrado no método spaces.list na API Chat ou no URL de um espaço.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_create_card_message.py

Iniciar ou responder a uma conversa

Para iniciar uma conversa, envie uma mensagem e deixe thread.name em branco. O Google Chat a preencherá ao criar a conversa. Se quiser personalizar o nome da linha de execução, especifique o campo thread.threadKey.

Para responder a uma conversa, envie uma mensagem que especifique o campo threadKey ou name da linha de execução. Se a linha de execução tiver sido criada por uma pessoa ou outro app do Chat, use o campo thread.name.

Se nenhuma linha de execução correspondente for encontrada, você poderá especificar se uma mensagem precisa iniciar uma nova linha de execução ou não ser postada definindo o campo messageReplyOption.

Se messageReplyOption estiver definido, você também precisará definir thread.name ou thread.threadKey.

Confira como iniciar ou responder a uma conversa com o campo threadKey definido como nameOfThread:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_create_message_thread.py.

  2. Inclua o seguinte código em chat_create_message_thread.py:

    from apiclient.discovery import build
from google.oauth2 import service_account

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = service_account.Credentials.from_service_account_file(
    'credentials.json', scopes=SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Create a Chat message.
result = chat.spaces().messages().create(

    # The space to create the message in.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE',

    # Whether to start a thread or reply to an existing one.
    #
    # Required when threading is enabled in a space unless starting a
    # thread.  Ignored in other space types. Threading is enabled when
    # space.spaceThreadingState is THREADED_MESSAGES.
    #
    # REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD replies to an existing thread
    # if one exists, otherwise it starts a new one.
    messageReplyOption='REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD',

    # The message body.
    body={

        # The message to create.
        'text': 'Start or reply to another message in a thread!',

        # The thread to start or reply to.
        'thread': {
            'threadKey': 'nameOfThread'
        }
    }

).execute()

print(result)

  3. No código, substitua SPACE por um nome de espaço, que pode ser encontrado no método spaces.list na API Chat ou no URL de um espaço.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_create_message_thread.py

A API Chat retorna uma instância de Message que detalha a mensagem enviada.

Nomear uma mensagem

Esta seção explica como nomear uma mensagem definindo um ID personalizado para ela. Você pode usar IDs personalizados para receber, atualizar ou excluir mensagens. Os IDs personalizados permitem especificar uma mensagem sem precisar armazenar o ID atribuído pelo sistema do nome do recurso da mensagem (representado no campo name). O nome do recurso é gerado no corpo da resposta quando você cria a mensagem.

Por exemplo, para recuperar uma mensagem usando o método get(), use o nome do recurso para especificar qual mensagem recuperar. O nome do recurso é formatado como spaces/{space}/messages/{message}, em que {message} representa o ID atribuído pelo sistema. Se você nomeou a mensagem, poderá substituir o valor de {message} pelo ID personalizado.

Para nomear uma mensagem, especifique um ID personalizado no campo messageId ao criá-la. O campo messageId define o valor do campo clientAssignedMessageId do recurso Message.

Só é possível nomear uma mensagem quando ela é criada. Não é possível nomear ou modificar um ID personalizado para mensagens existentes. O ID personalizado precisa atender aos seguintes requisitos:

  • Começa com client-. Por exemplo, client-custom-name é um ID personalizado válido, mas custom-name não é.
  • Contém até 63 caracteres e apenas letras minúsculas, números e hifens.
  • É único em um espaço. Um app do Chat não pode usar o mesmo ID personalizado para mensagens diferentes.

Veja como enviar uma mensagem com um ID personalizado:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_create_named_message.py.

  2. Inclua o seguinte código em chat_create_named_message.py:

    from apiclient.discovery import build
from google.oauth2 import service_account

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = service_account.Credentials.from_service_account_file(
    'credentials.json', scopes=SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Create a Chat message with a custom name.
result = chat.spaces().messages().create(

    # The space to create the message in.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE',

    # Custom name for the message used to facilitate later operations.
    messageId='client-NAME',

    # The message to create.
    body={'text': 'Hello, world!'}

).execute()

print(result)

  3. No código, substitua o seguinte:

    • SPACE: o ID do espaço em que você quer postar a mensagem, que pode ser encontrado no método spaces.list na API Chat ou no URL de um espaço.
    • NAME: o nome personalizado da mensagem.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_create_named_message.py

A API Chat retorna uma instância de Message.

Adicionar widgets interativos na parte inferior de uma mensagem

Também é possível anexar mensagens com widgets de acessórios. Os widgets de acessórios aparecem depois de qualquer texto ou card em uma mensagem. É possível usar esses widgets para solicitar que os usuários interajam com sua mensagem de várias maneiras, incluindo as seguintes:

  • Avalie a precisão ou satisfação de uma mensagem.
  • Denuncie um problema com a mensagem ou com o app do Chat.
  • Abre um link para conteúdo relacionado, como a documentação.
  • Dispense ou adie mensagens semelhantes do app do Chat por um período específico.

Para adicionar widgets de acessório, inclua o objeto accessoryWidgets[] na mensagem e especifique um ou mais AccessoryWidgets que você quer incluir. A mensagem precisa estar visível para todos no espaço. Não é possível adicionar widgets de acessório a mensagens privadas.

A imagem a seguir mostra um app do Chat que anexa uma mensagem de texto com widgets acessórios para que os usuários possam avaliar a experiência deles com o app do Chat.

Exemplos de widgets de acessórios

O exemplo de código a seguir mostra o JSON dessa mensagem. Quando um usuário clica em um dos botões, a interação aciona a função correspondente (como doUpvote) que processa a classificação.


 "text": "Rate your experience with this Chat app.",
 "accessoryWidgets": [
   {
     "buttonList": {
       "buttons": [
         {
           "icon": {
             "material_icon": {
               "name": "thumb_up"
             }
           },
           "color": {
             "red": 0,
             "blue": 255,
             "green": 0
           },
           "onClick": {
             "action": {
               "function": "doUpvote",
             }
           }
         },
         {
           "icon": {
             "material_icon": {
               "name": "thumb_down"
             }
           },
           "color": {
             "red": 0,
             "blue": 255,
             "green": 0
           },
           "onClick": {
             "action": {
               "function": "doDownvote",
             }
           }
         }
       ]
     }
   }
 ]

Envie mensagens em particular

Os apps de chat podem enviar mensagens de texto e cards de forma privada, de modo que a mensagem fique visível apenas para um usuário no espaço. Para enviar uma mensagem privada, especifique o campo privateMessageViewer nela. Somente apps do Chat podem enviar mensagens privadas. Para enviar uma mensagem privada de forma assíncrona, use a autenticação do app.

Veja mais detalhes em Enviar mensagens privadas para usuários do Google Chat.

Resolver problemas

Quando um app ou card do Google Chat retorna um erro, a interface do Chat mostra uma mensagem dizendo "Algo deu errado". ou "Não foi possível processar sua solicitação". Às vezes, a interface do Chat não exibe nenhuma mensagem de erro, mas o app ou card produz um resultado inesperado. Por exemplo, uma mensagem de card pode não aparecer.

Embora uma mensagem de erro possa não ser exibida na interface do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar você a corrigir erros quando a geração de registros de erros para apps do Chat está ativada. Se precisar de ajuda para visualizar, depurar e corrigir erros, consulte Resolver problemas e corrigir erros do Google Chat.