Список сообщений

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

Ресурс Message представляет собой текстовое сообщение или карточку в Google Chat. Вы можете create , get , update или delete сообщение в Google Chat API, вызвав соответствующие методы. Дополнительную информацию о текстовых сообщениях и карточках см. в разделе Обзор сообщений Google Chat .

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

Питон

  • Python 3.6 или выше
  • Инструмент управления пакетами pip

  • Новейшие клиентские библиотеки Google для Python. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .

  • Авторизация настроена для приложения Чат. Для вывода сообщений требуется аутентификация пользователя с областью авторизации chat.messages.readonly или chat.messages .

Список сообщений

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

В следующем примере перечислены сообщения в чате, отправленные после 16 марта 2023 г.:

Питон

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

  2. Включите следующий код chat_messages_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.messages.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists messages in a space sent after March 16, 2023.
    '''

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

          # The space for which to list messages.
          parent = 'spaces/SPACE',

          # An optional filter that returns messages
          # created after March 16, 2023.
          filter = 'createTime > "2023-03-16T00:00:00-00:00"'

      ).execute()

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

if __name__ == '__main__':
    main()

  3. В коде замените SPACE именем пространства, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

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

    python3 chat_messages_list.py

API Google Chat возвращает список сообщений, отправленных в указанное пространство после 16 марта 2023 года.