Найдите место для прямого сообщения (DM)

В этом руководстве объясняется, как использовать метод findDirectMessage в ресурсе Space API Google Chat, чтобы получить подробную информацию о пространстве прямых сообщений (DM).

Ресурс Space представляет собой место, где люди и приложения чата могут отправлять сообщения, обмениваться файлами и сотрудничать. Есть несколько типов помещений:

  • Прямые сообщения (DM) — это разговоры между двумя пользователями или пользователем и приложением чата.
  • Групповые чаты — это разговоры между тремя или более пользователями и приложениями чата.
  • Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.

Аутентификация с помощью аутентификации приложения позволяет приложению Chat получать личные сообщения, к которым приложение Chat имеет доступ в Google Chat (например, личные сообщения, участником которых оно является). Аутентификация с аутентификацией пользователя возвращает DM, к которым имеет доступ аутентифицированный пользователь.

Предварительные условия

Питон

Node.js

Найти прямое сообщение

Чтобы найти прямое сообщение в Google Chat, передайте в запросе следующее:

  • При аутентификации приложения укажите область авторизации chat.bot . При аутентификации пользователя укажите область chat.spaces.readonly chat.spaces .
  • Вызовите метод findDirectMessage для ресурса User , передав для возврата name другого пользователя в DM. При аутентификации пользователя этот метод возвращает DM между вызывающим пользователем и указанным пользователем. При аутентификации приложения этот метод возвращает DM между вызывающим приложением и указанным пользователем.
  • Чтобы добавить пользователя-человека в качестве члена пространства, укажите users/{user} , где {user} — это либо {person_id} для person из API People, либо идентификатор user в API каталога. Например, если resourceName person API People — people/123456789 , вы можете добавить пользователя в пространство, включив членство с помощью users/123456789 в member.name .

Найдите прямое сообщение с аутентификацией пользователя

Вот как найти прямое сообщение с аутентификацией пользователя :

Питон

  1. В своем рабочем каталоге создайте файл с chat_space_find_dm_user.py .

  2. Включите следующий код в chat_space_find_dm_user.py :

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# 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 direct message.
    print(result)

if __name__ == '__main__':
    main()

  3. В коде замените USER name User в Google Chat.

  4. В своем рабочем каталоге соберите и запустите пример:

    python3 chat_space_find_dm_user.py

Node.js

  1. В своем рабочем каталоге создайте файл с именем find-direct-message-space.js .

  2. Включите следующий код в find-direct-message-space.js :

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Find a direct message Chat space for a user.
* @return {!Promise<!Object>}
*/
async function findDirectMessageSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.readonly',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.findDirectMessage(
      {name: 'users/USER'});
}

findDirectMessageSpace().then(console.log);

  3. В коде замените USER name User в Google Chat.

  4. В своем рабочем каталоге запустите образец:

    node find-direct-message-space.js

Chat API возвращает экземпляр Space , в котором подробно описан указанный DM.

Найдите прямое сообщение с аутентификацией приложения

Вот как найти прямое сообщение с аутентификацией приложения :

Питон

  1. В своем рабочем каталоге создайте файл с chat_space_find_dm_app.py .

  2. Включите следующий код в chat_space_find_dm_app.py :

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

# 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')
    .with_scopes(SCOPES)
)

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

# 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. В коде замените USER name User в Google Chat.

  4. В своем рабочем каталоге соберите и запустите пример:

    python3 chat_space_find_dm_app.py

Node.js

  1. В своем рабочем каталоге создайте файл с именем app-find-direct-message-space.js .

  2. Включите следующий код в app-find-direct-message-space.js :

    const chat = require('@googleapis/chat');

/**
* Find a direct message Chat space for a user.
* @return {!Promise<!Object>}
*/
async function findDirectMessageSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.bot',
  ];

  const auth = new chat.auth.GoogleAuth({
    scopes,
    keyFilename: 'credentials.json',
  });

  const authClient = await auth.getClient();

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.findDirectMessage(
      {name: 'users/USER'});
}

findDirectMessageSpace().then(console.log);

  3. В коде замените USER name User в Google Chat.

  4. В своем рабочем каталоге запустите образец:

    node app-find-direct-message-space.js

Chat API возвращает экземпляр Space , в котором подробно описан указанный DM.