تعديل حالة قراءة سلسلة محادثات لمستخدم

يشرح هذا الدليل كيفية استخدام طريقة update في المورد ThreadReadState من Google Chat API لوضع علامة "مقروءة" أو "غير مقروءة" على سلاسل الرسائل.

ThreadReadState المورد هو مورد مفرد يمثّل تفاصيل حول آخر رسالة محادثة قرأها مستخدم معيّن في سلسلة رسائل Google Chat.

المتطلبات الأساسية

Node.js

Python

تعديل حالة قراءة سلسلة المحادثات للمستخدم المتصل

لتعديل حالة قراءة مستخدم ضمن سلسلة رسائل، أدرِج ما يلي في طلبك:

  • حدِّد نطاق التفويض 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 على طابع زمني يساوي وقت إنشاء آخر رسالة في سلسلة المحادثات أو يقع بعده. إذا حدّدت طابعًا زمنيًا مستقبليًا، ستفرض واجهة برمجة التطبيقات قيمة 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 الخاص بالمساحة يمكنك الحصول على المعرّف من خلال استدعاء الطريقة ListSpaces أو من عنوان URL الخاص بالمساحة.
  • ‫THREAD_NAME: المعرّف من السلسلة name. يمكنك الحصول على المعرّف من نص الردّ الذي يتم عرضه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API، أو باستخدام الاسم المخصّص الذي تم تعيينه للرسالة عند إنشائها.

تعدّل Chat API حالة قراءة سلسلة المحادثات المحدّدة وتعرض مثيلاً من ThreadReadState.