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

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

تشير رسالة الأشكال البيانية مرجع SpaceReadState هو مورد فرديتون يمثل تفاصيل حول آخر رسالة مقروءة للمستخدم المحدّد في مساحة Google Chat.

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

Python

  • Python 3.6 أو أحدث
  • أداة إدارة حزم pip
  • أحدث مكتبات عملاء Google. لتثبيت التطبيقات أو تحديثها، قم بتشغيل الأمر التالي في واجهة سطر الأوامر: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

برمجة تطبيقات

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

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

  • حدِّد نطاق تفويض 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 لمطابقة أحدث وقت لإنشاء الرسالة. يُرجى ملاحظة أنّ حالة قراءة المساحة لا تؤثّر إلا في حالة قراءة الرسائل التي تظهر في المحادثة ذات المستوى الأعلى في المساحة. الردود في سلاسل المحادثات هي ستتأثر بهذا الطابع الزمني وستعتمد بدلاً من ذلك على حالة قراءة سلسلة المحادثات.

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

Python

  1. في دليل العمل، أنشئ ملفًا باسم chat_spaceReadState_update.py

  2. أدرِج الرمز التالي في 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()

  3. في الرمز، استبدل ما يلي:

  4. في دليل العمل، أنشئ النموذج وشغِّله:

    python3 chat_spaceReadState_update.py

Node.js

  1. في دليل العمل، أنشئ ملفًا باسم chat_spaceReadState_update.js

  2. أدرِج الرمز التالي في 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);

  3. في الرمز، استبدل ما يلي:

  4. في دليل العمل، أنشئ النموذج وشغِّله:

    node chat_spaceReadState_update.js

برمجة تطبيقات

يستدعي هذا المثال واجهة برمجة تطبيقات Chat باستخدام خدمة Chat المتقدّمة

  1. إضافة نطاق تفويض chat.users.readstate إلى ملف appsscript.json لمشروع برمجة التطبيقات:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate"
]

  2. أضف دالة كهذه إلى مشروع "برمجة تطبيقات Google" الرمز:

    /**
* 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);
  }
}

تعمل Google Chat API على تعديل حالة قراءة المساحة المحدّدة وعرض مثيل على مرجع SpaceReadState