В этом руководстве объясняется, как использовать метод list
в ресурсе Message
API Google Chat, чтобы просмотреть разбитый на страницы фильтруемый список сообщений в пространстве.
В API чата сообщение чата представлено ресурсом Message
. Хотя пользователи чата могут отправлять только текстовые сообщения, приложения чата могут использовать множество других функций обмена сообщениями, включая отображение статических или интерактивных пользовательских интерфейсов, сбор информации от пользователей и частную доставку сообщений. Дополнительную информацию о функциях обмена сообщениями, доступных для Chat API, см. в обзоре сообщений Google Chat .
Предварительные условия
Питон
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Установите клиентскую библиотеку Python Google API .
- Создайте учетные данные идентификатора клиента OAuth для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учетные данные в виде файла JSON с именем
client_secrets.json
в локальном каталоге.
- Выберите область авторизации , которая поддерживает аутентификацию пользователей.
Список сообщений
Чтобы получить список сообщений с аутентификацией пользователя , передайте в запросе следующее:
- Укажите область авторизацииchat.messages.readonly
chat.messages.readonly
chat.messages
- Вызовите метод
list
для ресурсаMessage
.
В следующем примере перечислены сообщения в чате, отправленные после 16 марта 2023 г.:
Питон
- В своем рабочем каталоге создайте файл с
chat_messages_list.py
. Включите следующий код
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 the list of messages. print(result) if __name__ == '__main__': main()
В коде замените
SPACE
именем пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.В своем рабочем каталоге соберите и запустите пример:
python3 chat_messages_list.py
Chat API возвращает список сообщений, отправленных в указанное пространство после 16 марта 2023 года. Если сообщений по запросу нет, ответ Chat API возвращает пустой объект. При использовании интерфейса REST/HTTP ответ содержит пустой объект JSON {}
.
Связанные темы
- Отформатируйте сообщение .
- Удалить сообщение .
- Получите подробную информацию о сообщении .
- Обновить сообщение .
- Отправить сообщение .