Список пространств

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

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

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

В списке пространств с аутентификацией приложения перечислены пространства, к которым приложение Chat имеет доступ. В списке пространств с аутентификацией пользователя перечислены пространства, к которым имеет доступ аутентифицированный пользователь.

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

Питон

Node.js

Пространства списка с аутентификацией пользователя

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

В следующем примере перечислены именованные пространства и групповые чаты (но не прямые сообщения, которые отфильтровываются), видимые аутентифицированному пользователю:

Питон

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

  2. Включите следующий код chat_space_list.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 lists named spaces and group chats (but not direct messages)
    visible to the authenticated user.
    '''

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

          # An optional filter that returns named spaces or unnamed group chats,
          # but not direct messages (DMs).
          filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

      ).execute()

    # Prints the returned list of spaces.
    print(result)

if __name__ == '__main__':
    main()

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

    python3 chat_space_list.py

Node.js

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

  2. Включите следующий код в list-spaces.js :

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

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  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.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

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

    node list-spaces.js

Chat API возвращает разбитый на страницы массив именованных пространств и групповых чатов .

Список пространств с аутентификацией приложения

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

В следующем примере перечислены именованные пространства и групповые чаты (но не прямые сообщения), видимые в приложении «Чат»:

Питон

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

  2. Включите следующий код в chat_space_list_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().list(

        # An optional filter that returns named spaces or unnamed
        # group chats, but not direct messages (DMs).
        filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

    ).execute()

print(result)

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

    python3 chat_space_list_app.py

Node.js

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

  2. Включите следующий код в app-list-spaces.js :

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

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  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.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

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

    node app-list-spaces.js

Chat API возвращает массив пробелов с разбивкой на страницы.

Настройте нумерацию страниц или отфильтруйте список

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

  • pageSize : максимальное количество возвращаемых пробелов. Служба может вернуть меньше этого значения. Если не указано, возвращается не более 100 пробелов. Максимальное значение — 1000; значения выше 1000 автоматически изменяются на 1000.
  • pageToken : токен страницы, полученный в результате предыдущего вызова пространств списка. Предоставьте этот токен для получения следующей страницы. При разбиении на страницы значение фильтра должно соответствовать вызову, который предоставил токен страницы. Передача другого значения может привести к неожиданным результатам.
  • filter : фильтр запроса. Подробности о поддерживаемых запросах см. в методе spaces.list .