Enviar uma mensagem

Este guia explica as diferentes maneiras como os apps do Google Chat podem enviar mensagens:

  • Envie mensagens de texto e cards em tempo real respondendo a uma interação do usuário.
  • Envie mensagens de texto e cards 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. É possível create, get, update ou delete uma mensagem na API Google Chat chamando métodos correspondentes. Para saber mais sobre mensagens de texto e cards, consulte Visão geral das mensagens do Google Chat.

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 a interações do usuário não exigem autenticação e oferecem suporte a outros tipos de mensagens, como caixas de diálogo interativas e visualizações de links. Para mais detalhes, consulte Receber e responder a interações com seu app do Google Chat.

Pré-requisitos

Node.js

Python

  • Python 3.6 ou posterior
  • A ferramenta de gerenciamento de pacotes pip

  • 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-httplib2 google-auth-oauthlib oauth2client

  • Um app do Chat publicado. Para criar e publicar um app do Chat, 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.

Envie uma mensagem de texto em tempo real

Neste exemplo, o app do Chat cria e envia uma mensagem de texto sempre que é adicionado a um espaço. Para saber mais sobre as práticas recomendadas para integrar usuários, consulte Começar a usar uma integração útil para 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 do ADDED_TO_SPACE com uma mensagem de texto, use este 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

Na seção a seguir, explicamos como enviar uma mensagem de texto de maneira assíncrona com a autenticação de app e do usuário.

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

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

Enviar uma mensagem de texto com a autenticação de apps

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

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 httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

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

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

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

# 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 de 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 membership.
    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() da 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 cartão

Nesta seção, descrevemos como enviar mensagens com cards de duas maneiras:

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

Envie uma mensagem de cartão em tempo real

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

Neste exemplo, um usuário envia uma mensagem a 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 de chat respondendo com um card com o nome de exibição do remetente e a imagem do avatar.

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

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 card de forma assíncrona

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

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

Este é um exemplo de mensagem de card:

Uma mensagem de card enviada com a API Chat.

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

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 httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

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

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

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

# 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 preenche ao criar a linha de execução. Para 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 conversa. Se a conversa 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, defina o campo messageReplyOption para especificar se uma mensagem precisa iniciar uma nova conversa ou não.

Veja 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 httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

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

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

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

# 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.

Enviar e nomear uma mensagem

Nesta seção, explicamos como enviar uma mensagem com um nome personalizado. Use nomes de mensagens para receber, atualizar ou excluir mensagens. A atribuição de um nome personalizado também permite que um app do Chat cancele a mensagem sem salvar a name do corpo da resposta retornada ao enviar a mensagem.

A atribuição de um nome personalizado não substitui o campo name gerado, o nome do recurso da mensagem. Em vez disso, ele define o nome personalizado como o campo clientAssignedMessageId, que pode ser referenciado ao processar operações posteriores, como atualizar ou excluir a mensagem.

Os nomes personalizados têm os seguintes requisitos:

  • Comece com client-. Por exemplo, client-custom-name é um nome personalizado válido, mas custom-name não é.
  • Conter apenas letras minúsculas, números e hifens.
  • ter no máximo 63 caracteres;
  • A especificação de um nome personalizado usado ao enviar uma mensagem retorna um erro, mas outros métodos, como update e delete, funcionam conforme esperado.

Veja como enviar e nomear uma mensagem:

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 httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

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

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

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

# 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-custom-name',

    # 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_named_message.py

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

Resolver problemas

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

Embora uma mensagem de erro talvez não apareça na IU do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar a corrigir erros quando o registro de erros nos apps do Chat está ativado. Se precisar de ajuda para ver, depurar e corrigir erros, consulte Resolver problemas e corrigir erros do Google Chat.