Эта страница переведена с помощью Cloud Translation API.

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

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

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

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

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

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

Питон

Python 3.6 или выше
Инструмент управления пакетами pip
Новейшие клиентские библиотеки Google для Python. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:
```
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
```
Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .
Авторизация настроена для приложения Чат. Пространства листинга поддерживают оба следующих метода аутентификации:
- Аутентификация пользователя с областью авторизации chat.spaces.readonly или chat.spaces .
- Аутентификация приложения с областью авторизации chat.bot .

Node.js

Node.js и npm
Новейшие клиентские библиотеки Google для Node.js. Чтобы установить их, выполните следующую команду в интерфейсе командной строки:
```
npm install @google-cloud/local-auth @googleapis/chat
```
Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .
Авторизация настроена для приложения Чат. Пространства листинга поддерживают оба следующих метода аутентификации:
- Аутентификация пользователя с областью авторизации chat.spaces.readonly или chat.spaces .
- Аутентификация приложения с областью авторизации chat.bot .

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

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

При аутентификации пользователя укажите chat.spaces.readonly авторизацииchat.spaces.readonly chat.spaces .
Вызовите метод list для ресурса Space .

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

Питон

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

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

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

Node.js

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

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

В своем рабочем каталоге запустите образец:
```
node list-spaces.js
```

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