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

يوضّح هذا الدليل كيفية استخدام طريقة getSpaceReadState على مورد SpaceReadState لواجهة برمجة تطبيقات Google Chat للحصول على تفاصيل حول حالة القراءة للمستخدم ضمن مساحة. لمعرفة حالة قراءة رسالة في سلسلة محادثات، يُرجى الاطّلاع على الحصول على تفاصيل حول حالة قراءة سلسلة المحادثات لمستخدم.

مورد SpaceReadState هو مورد مفرد يمثّل تفاصيل حول آخر رسالة مقروءة لمستخدم محدّد في مساحة Google Chat.

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

Python

  • Python 3.6 أو أحدث
  • تتيح لك أداة إدارة الحِزم pip

  • أحدث مكتبات عملاء Google للغة Python. لتثبيتها أو تحديثها، شغّل الأمر التالي في واجهة سطر الأوامر:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • مشروع على Google Cloud تم فيه تفعيل Google Chat API وضبطه لمعرفة الخطوات، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.

  • تم ضبط التفويض لتطبيق Chat. للحصول على تفاصيل حول حالة القراءة للمستخدم في إحدى المساحات، يجب توفُّر مصادقة المستخدم من خلال نطاق التفويض chat.users.readstate أو chat.users.readstate.readonly.

Node.js

  • Node.js وnpm

  • أحدث مكتبات عملاء Google لنظام Node.js. ولتثبيتها، شغِّل الأمر التالي في واجهة سطر الأوامر:

    npm install @google-cloud/local-auth @googleapis/chat
  • مشروع على Google Cloud تم فيه تفعيل Google Chat API وضبطه لمعرفة الخطوات، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.

  • تم ضبط التفويض لتطبيق Chat. للحصول على تفاصيل حول حالة القراءة للمستخدم في إحدى المساحات، يجب توفُّر مصادقة المستخدم من خلال نطاق التفويض chat.users.readstate أو chat.users.readstate.readonly.

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

  • حساب على Google Workspace يمكنه الوصول إلى Google Chat
  • هو تطبيق Chat منشور. لإنشاء تطبيق في Chat، اتّبِع quickstart.
  • تم ضبط التفويض لتطبيق Chat. للحصول على تفاصيل حول حالة القراءة للمستخدم في إحدى المساحات، يجب توفُّر مصادقة المستخدم من خلال نطاق التفويض chat.users.readstate أو chat.users.readstate.readonly.

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

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

  • حدِّد نطاق التفويض chat.users.readstate أو chat.users.readstate.readonly.
  • استدعِ طريقة getSpaceReadState في المورد SpaceReadState.
  • مرِّر name لحالة القراءة للمساحة للحصول عليها، والتي تتضمّن رقم تعريف المستخدم أو العنوان البديل للبريد الإلكتروني ومعرّف المساحة. لا يتيح الحصول على حالة قراءة المساحة سوى الحصول على حالة القراءة للمستخدم المتصل، والتي يمكن تحديدها من خلال ضبط أحد الخيارات التالية:
    • العنوان البديل للبريد الإلكتروني me. مثلاً، users/me/spaces/SPACE/spaceReadState.
    • عنوان البريد الإلكتروني على Workspace للمستخدم الذي يتصل بك مثلاً، users/user@example.com/spaces/SPACE/spaceReadState.
    • رقم تعريف المستخدم الخاص بالمستخدم المتصل مثلاً، users/USER/spaces/SPACE/spaceReadState.

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

Python

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

  2. ضمِّن الرمز التالي في chat_spaceReadState_get.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.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets 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().getSpaceReadState(

        # The space read state to get.
        #
        # 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'

      ).execute()

    # Prints the API's response.
    print(result)

if __name__ == '__main__':
    main()

  3. في التعليمة البرمجية، استبدل ما يلي:

    • SPACE: اسم مساحة يمكنك الحصول عليه من خلال طريقة spaces.list في Chat API أو من عنوان URL الخاص بالمساحة

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

    python3 chat_spaceReadState_get.py

Node.js

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

  2. ضمِّن الرمز التالي في chat_spaceReadState_get:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Authenticates with Chat API via user credentials,
* then gets the space read state for the calling user.
* @return {!Promise<!Object>}
*/
async function getSpaceReadState() {

  /**
  * Authenticate with Google Workspace
  * and get user authorization.
  */
  const scopes = [
    'https://www.googleapis.com/auth/chat.users.readstate.readonly',
  ];

  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.getSpaceReadState({

    /**
    * The space read state to get.
    *
    * 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'
  });
}

/**
* Use the service endpoint to call Chat API.
*/
getSpaceReadState().then(console.log);

  3. في التعليمة البرمجية، استبدل ما يلي:

    • SPACE: اسم مساحة يمكنك الحصول عليه من خلال طريقة spaces.list في Chat API أو من عنوان URL الخاص بالمساحة

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

    node chat_spaceReadState_get.js

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

يستدعي هذا المثال واجهة Chat API باستخدام Advanced Chat Service.

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

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

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

    /**
* Authenticates with Chat API via user credentials,
* then gets the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function getSpaceReadState(spaceReadStateName) {
  try {
    Chat.Users.Spaces.getSpaceReadState(spaceReadStateName);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get read state with error %s', err.message);
  }
}

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