Method: users.spaces.threads.getThreadReadState

הפונקציה מחזירה פרטים על מצב הקריאה של המשתמש בשרשור, ומשמשת לזיהוי הודעות שנקראו והודעות שלא נקראו. דוגמה לכך מופיעה במאמר איך מקבלים פרטים על מצב הקריאה של משתמש בשרשור.

נדרש אימות משתמש עם אחד מהיקפי ההרשאה הבאים:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

בקשת HTTP

GET https://chat.googleapis.com/v1/{name=users/*/spaces/*/threads/*/threadReadState}

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב של מצב הקריאה של השרשור שרוצים לאחזר.

התכונה תומכת רק בקבלת סטטוס הקריאה של המשתמש הקורא.

כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:

  • הכינוי me. לדוגמה, users/me/spaces/{space}/threads/{thread}/threadReadState.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • מזהה המשתמש שלהם. לדוגמה, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

פורמט: users/{user}/spaces/{space}/threads/{thread}/threadReadState

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של ThreadReadState.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

מידע נוסף זמין במדריך ההרשאות.