В этом руководстве объясняется, как использовать метод updateSpaceReadState
ресурса SpaceReadState
API Google Chat, чтобы помечать пространства как прочитанные или непрочитанные.
Ресурс SpaceReadState
— это одноэлементный ресурс, который представляет сведения о последнем прочитанном сообщении определенного пользователя в пространстве Google Chat.
Предварительные условия
Питон
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Python 3.6 или выше
- Инструмент управления пакетами pip
- Новейшие клиентские библиотеки Google. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Создайте учетные данные идентификатора клиента OAuth для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учетные данные в виде файла JSON (
client_secrets.json
) в локальном каталоге.
- Выберите область авторизации , которая поддерживает аутентификацию пользователей.
Node.js
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Node.js 14 или более поздней версии
- Инструмент управления пакетами npm
- Новейшие клиентские библиотеки Google. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:
npm install @google-cloud/local-auth @googleapis/chat
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Создайте учетные данные идентификатора клиента OAuth для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учетные данные в виде файла JSON (
client_secrets.json
) в локальном каталоге.
- Выберите область авторизации , которая поддерживает аутентификацию пользователей.
Скрипт приложений
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Создайте автономный проект Apps Script и включите расширенную службу чата .
- Выберите область авторизации , которая поддерживает аутентификацию пользователей.
Обновить состояние чтения пространства вызывающего пользователя
Чтобы обновить состояние чтения пользователя в пространстве, включите в свой запрос следующее:
- Укажите область
chat.users.readstate
. - Вызовите метод
updateSpaceReadState
для ресурсаSpaceReadState
. - Передайте
name
состояния чтения пространства, которое нужно получить, которое включает идентификатор пользователя или псевдоним и идентификатор пространства. Получение состояния чтения пространства поддерживает только получение состояния чтения вызывающего пользователя, которое можно указать, установив один из следующих параметров:-
me
псевдоним. Например,users/me/spaces/ SPACE /spaceReadState
. - Адрес электронной почты Workspace звонящего пользователя. Например,
users/user@example.com/spaces/ SPACE /spaceReadState
. - Идентификатор пользователя вызывающего пользователя. Например,
users/ USER /spaces/ SPACE /spaceReadState
.
-
- Передайте
updateMask
, который определяет аспекты состояния чтения пространства для обновления, который поддерживает следующие пути к полям:-
lastReadTime
: время обновления состояния чтения пространства пользователя. Обычно это соответствует либо временной метке последнего прочитанного сообщения, либо временной метке, указанной пользователем для обозначения последней прочитанной позиции в пробеле. Если значениеlastReadTime
предшествует времени создания последнего сообщения, пространство отображается в пользовательском интерфейсе как непрочитанное. Чтобы пометить пространство как прочитанное, установите дляlastReadTime
любое значение, позднее (большее) времени создания последнего сообщения.lastReadTime
принудительно соответствует времени создания последнего сообщения. Обратите внимание, что состояние чтения пространства влияет только на состояние чтения сообщений, которые видны в диалоге верхнего уровня пространства. Эта временная метка не влияет на ответы в потоках, а вместо этого они зависят от состояния чтения потока.
-
В следующем примере обновляется состояние чтения пространства вызывающего пользователя:
Питон
- В своем рабочем каталоге создайте файл с
chat_spaceReadState_update.py
. Включите следующий код в
chat_spaceReadState_update.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.users.readstate"] def main(): ''' Authenticates with Chat API via user credentials, then updates the space read state for the calling 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.users().spaces().updateSpaceReadState( # The space read state to update. # # Replace USER with the calling user's ID, Workspace email, # or the alias me. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='users/me/spaces/SPACE/spaceReadState', updateMask='lastReadTime', body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'} ).execute() # Prints the API's response. print(result) if __name__ == '__main__': main()
В коде замените следующее:
-
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.
-
В своем рабочем каталоге соберите и запустите пример:
python3 chat_spaceReadState_update.py
Node.js
- В своем рабочем каталоге создайте файл с
chat_spaceReadState_update.js
. Включите следующий код в
chat_spaceReadState_update
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @return {!Promise<!Object>} */ async function updateSpaceReadState() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.users.readstate', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.users.spaces.updateSpaceReadState({ /** * The space read state to update. * * Replace USER with the calling user's ID, Workspace email, * or the alias me. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. */ name: 'users/me/spaces/SPACE/spaceReadState', updateMask: 'lastReadTime', requestBody: { lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z' } }); } /** * Use the service endpoint to call Chat API. */ getSpaceReadState().then(console.log);
В коде замените следующее:
-
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.
-
В своем рабочем каталоге соберите и запустите пример:
node chat_spaceReadState_update.js
Скрипт приложений
В этом примере API чата вызывается с помощью Advanced Chat Service .
Добавьте область
chat.users.readstate
в файлappsscript.json
проекта Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate" ]
Добавьте такую функцию в код проекта Apps Script:
/** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @param {string} spaceReadStateName The resource name of the space read state. */ function updateSpaceReadState(spaceReadStateName) { try { const time = new Date('January 1, 2000')).toJSON(); const body = {'lastReadTime': time}; Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to update read state with error %s', err.message); } }
API Google Chat обновляет указанное состояние чтения пространства и возвращает экземпляр ресурса SpaceReadState
.
Связанные темы
- Получите состояние чтения пространства вызывающего пользователя .
- Получить состояние чтения потока вызывающего пользователя .