במדריך הזה מוסבר איך משתמשים ב-method update במשאב ThreadReadState של Google Chat API כדי לסמן שרשורי הודעות כ"כבר קראתי" או כ"עוד לא קראתי".
המשאב ThreadReadState הוא משאב יחיד שמייצג פרטים על ההודעה האחרונה שמשתמש מסוים קרא בשרשור הודעות ב-Google Chat.
דרישות מוקדמות
Node.js
- חשבון Business או Enterprise ב-Google Workspace עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציה ל-Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
-
יוצרים פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה שבמדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בוחרים היקף הרשאה שתומך באימות משתמשים.
Python
- חשבון Business או Enterprise ב-Google Workspace עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציה ל-Chat.
- מתקינים את ספריית הלקוח של Cloud ב-Python.
-
יוצרים פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה שבמדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בוחרים היקף הרשאה שתומך באימות משתמשים.
עדכון מצב הקריאה של השרשור של המשתמש שמתקשר
כדי לעדכן את סטטוס הקריאה של משתמש בשרשור הודעות, צריך לכלול בבקשה את הפרטים הבאים:
- מציינים את היקף ההרשאה של
chat.users.readstate. - מבצעים קריאה ל-method
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חייב להיות בראשית זמן יוניקס (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של המרחב המשותף. אפשר לקבל את המזהה באמצעות הפעלת ה-methodListSpacesאו מכתובת ה-URL של המרחב המשותף. -
THREAD_NAME: המזהה מהשדהnameשל השרשור. אפשר לקבל את המזהה מגוף התשובה שמוחזרת אחרי שיוצרים הודעה באופן אסינכרוני באמצעות Chat API, או באמצעות השם בהתאמה אישית שהוקצה להודעה בזמן היצירה.
Chat API מעדכן את סטטוס הקריאה של השרשור שצוין ומחזיר מופע של ThreadReadState.