Encontrar um espaço de mensagem direta

Neste guia, explicamos como usar o método findDirectMessage no recurso Space da API Google Chat para receber detalhes sobre um espaço de mensagem direta (DM).

O recurso Space representa um lugar onde as pessoas e os apps de chat podem enviar mensagens, compartilhar arquivos e colaborar. Existem vários tipos de espaços:

  • As mensagens diretas são conversas entre dois usuários ou um usuário e um app do Chat.
  • Os chats em grupo são conversas entre três ou mais usuários e apps de chat.
  • Os espaços nomeados são lugares permanentes em que as pessoas enviam mensagens, compartilham arquivos e colaboram.

A autenticação com a autenticação de apps permite que um app do Chat receba as mensagens diretas que ele pode acessar no Google Chat (por exemplo, mensagens diretas de que ele participa). A autenticação com autenticação de usuário retorna mensagens diretas que podem ser acessadas pelo usuário autenticado.

Pré-requisitos

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 o app do Chat. Encontrar uma mensagem direta aceita ambos:

Encontrar uma mensagem direta

Para encontrar uma mensagem direta no Google Chat, transmita 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.spaces.readonly ou chat.spaces.
  • Chame o método findDirectMessage no recurso User, transmitindo o name do outro usuário na mensagem direta a ser retornada. Com a autenticação do usuário, esse método retorna uma mensagem direta entre o usuário que fez a chamada e o usuário especificado. Com a autenticação do app, esse método retorna uma mensagem direta entre o app que fez a chamada e o usuário especificado.
  • Para adicionar um usuário humano como participante do espaço, especifique users/{user}, em que {user} é o {person_id} do person da API People ou o ID de um user na API Directory. Por exemplo, se a pessoa resourceName da API People for people/123456789, você poderá adicionar o usuário ao espaço incluindo uma associação com users/123456789 como member.name.

Encontrar uma mensagem direta com autenticação de usuário

Veja como encontrar uma mensagem direta com a autenticação do usuário:

Python

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

  2. Inclua o seguinte código em chat_space_find_dm_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.spaces.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then returns details about a specified DM.
    '''

    # 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().findDirectMessage(

          # The other user in the direct message (DM) to return.
          #
          # Replace USER with a user name.
          name='users/USER'

      ).execute()

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

if __name__ == '__main__':
    main()

  3. No código, substitua USER pelo name de uma User no Google Chat.

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

    python3 chat_space_find_dm_user.py

A API Chat retorna uma instância de Space que detalha o DM especificado.

Encontrar uma mensagem direta com a autenticação de apps

Veja como encontrar uma mensagem direta com a autenticação do app:

Python

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

  2. Inclua o seguinte código em chat_space_find_dm_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()))

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

    # The other user in the direct message (DM) to return.
    #
    # Replace USER with a user name.
    name='users/USER'

).execute()

print(result)

  3. No código, substitua USER pelo name de uma User no Google Chat.

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

    python3 chat_space_find_dm_app.py

A API Chat retorna uma instância de Space que detalha o DM especificado.