В этом руководстве рассказывается, как использовать метод update ресурса ThreadReadState Google Chat API, чтобы помечать цепочки сообщений как прочитанные или непрочитанные.
Ресурс ThreadReadState – это одноэлементный ресурс, который содержит сведения о последнем прочитанном сообщении указанного пользователя в цепочке сообщений Google Chat.
Требования
Node.js
- Аккаунт Google Workspace Business или Enterprise с доступом к Google Chat.
- Настройте среду:
- Создайте проект Google Cloud.
- Настройте окно запроса доступа OAuth.
- Включите и настройте Google Chat API, указав название, значок и описание приложения Chat.
- Установите клиентскую библиотеку Cloud для Node.js.
- Создайте учетные данные идентификатора клиента OAuth для компьютерного приложения. Чтобы запустить пример из этого руководства, сохраните учетные данные в виде JSON-файла с именем
credentials.jsonв локальном каталоге.
- Выберите область авторизации, которая поддерживает аутентификацию пользователей.
Python
- Аккаунт Google Workspace Business или Enterprise с доступом к Google Chat.
- Настройте среду:
- Создайте проект Google Cloud.
- Настройте окно запроса доступа OAuth.
- Включите и настройте Google Chat API, указав название, значок и описание приложения Chat.
- Установите клиентскую библиотеку Cloud для Python.
- Создайте учетные данные идентификатора клиента OAuth для компьютерного приложения. Чтобы запустить пример из этого руководства, сохраните учетные данные в виде JSON-файла с именем
credentials.jsonв локальном каталоге.
- Выберите область авторизации, которая поддерживает аутентификацию пользователей.
Обновляет статус прочтения цепочки вызывающего пользователя.
Чтобы обновить статус прочтения пользователя в цепочке сообщений, включите в запрос следующее:
- Укажите область авторизации
chat.users.readstate. - Вызовите метод
UpdateThreadReadState. - Передайте
updateMaskсо значениемlastReadTime. - Передайте
threadReadStateкак экземплярThreadReadStateсо следующими параметрами:- Поле
name, в котором задается статус прочтения цепочки, подлежащий обновлению. Включает идентификатор пользователя или псевдоним, идентификатор чат-группы и идентификатор цепочки. При обновлении статуса цепочки поддерживается только изменение статуса для вызывающего пользователя, который можно указать одним из следующих способов:- Псевдоним
me. Пример:users/me/spaces/SPACE/threads/THREAD/threadReadState. - Адрес электронной почты пользователя Workspace, который совершает вызов. Пример:
users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState. - Идентификатор пользователя, совершающего вызов. Пример:
users/USER/spaces/SPACE/threads/THREAD/threadReadState.
- Псевдоним
- Поле
lastReadTime, в котором указана временная метка, обозначающая последнее прочитанное пользователем сообщение в цепочке, например временная метка последнего прочитанного сообщения или текущее время:- Отметить как непрочитанное. Установите для
lastReadTimeвременную метку, которая предшествует времени создания последнего сообщения в цепочке. В Chat цепочка будет помечена как непрочитанная с этой временной метки. Значки непрочитанных сообщений обновятся, цепочка будет выделена полужирным шрифтом и появится на главном экране. - Отметить как прочитанное. Установите для
lastReadTimeвременную метку, равную времени создания последнего сообщения в цепочке или более позднюю. Если вы укажете временную метку в будущем, API принудительно установит для параметраlastReadTimeвремя текущего запроса. - Минимальная временная метка. Значение в поле
lastReadTimeдолжно быть не раньше начала эпохи Unix (1970-01-01T00:00:00Z). Если указать отрицательную временную метку (до1970-01-01T00:00:00Z), возвращается ошибкаINVALID_ARGUMENT(400).
- Отметить как непрочитанное. Установите для
- Поле
В следующем примере обновляется статус прочтения цепочки вызывающего пользователя:
Node.js
/**
* This sample shows how to update the calling user's thread read state.
*
* It relies on the @google-apps/chat npm package.
*/
// Read the documentation for more details:
// https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState
const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');
async function main() {
// Create a client
const chatClient = new ChatServiceClient({
authClient: await auth.getClient({
scopes: ['https://www.googleapis.com/auth/chat.users.readstate']
})
});
// Initialize request arguments.
const request = {
threadReadState: {
name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState',
lastReadTime: {
seconds: Math.floor(Date.now() / 1000),
nanos: 0
}
},
updateMask: {
paths: ['last_read_time']
}
};
// Make the request
const response = await chatClient.updateThreadReadState(request);
console.log(response);
}
main().catch(console.error);
Python
"""
This sample shows how to update the calling user's thread read state.
"""
from google.apps import chat_v1
import google.auth
from google.protobuf import timestamp_pb2
# Read the documentation for more details:
# https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState
def update_thread_read_state():
# Authenticate with Chat API using user credentials.
credentials, _ = google.auth.default(
scopes=["https://www.googleapis.com/auth/chat.users.readstate"]
)
client = chat_v1.ChatServiceClient(credentials=credentials)
# Set timestamp for last read time.
now = timestamp_pb2.Timestamp()
now.GetCurrentTime()
thread_read_state = chat_v1.ThreadReadState(
name="users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState",
last_read_time=now,
)
request = chat_v1.UpdateThreadReadStateRequest(
thread_read_state=thread_read_state,
update_mask={"paths": ["last_read_time"]},
)
response = client.update_thread_read_state(request=request)
print(response)
if __name__ == "__main__":
update_thread_read_state()
Чтобы запустить этот пример, замените следующие значения:
SPACE_NAME– идентификатор изnameчат-группы. Идентификатор можно получить, вызвав методListSpaces, или из URL чат-группы.THREAD_NAME– идентификатор изnameцепочки. Идентификатор можно получить из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени, назначенного сообщению при создании.
Chat API обновляет статус прочтения указанной цепочки и возвращает экземпляр ThreadReadState.