Event

حدث تفاعل مع تطبيق Google Chat يمثّل بيانات عن تفاعل المستخدم مع تطبيق Chat ويتضمّن بيانات حول تفاعل المستخدم مع تطبيق Chat. لإعداد تطبيق Chat لتلقّي أحداث التفاعل، يُرجى الاطّلاع على مقالة تلقّي تفاعلات المستخدمين والردّ عليها.

بالإضافة إلى تلقّي أحداث ناتجة من تفاعلات المستخدمين، يمكن لتطبيقات Chat تلقّي أحداث حول التغييرات في المساحات، مثل إضافة عضو جديد إلى مساحة. للتعرّف على أحداث المساحة، راجِع مقالة العمل مع الأحداث من Google Chat.

تمثيل JSON
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  }
}
الحقول
type

enum (EventType)

نوع تفاعل المستخدم مع تطبيق Chat، مثلاً MESSAGE أو ADDED_TO_SPACE.

eventTime

string (Timestamp format)

الطابع الزمني الذي يشير إلى وقت وقوع حدث التفاعل

token

string

قيمة سرية يمكن لتطبيقات Chat القديمة استخدامها للتحقّق مما إذا كان الطلب من Google. تنشئ Google الرمز المميّز بشكل عشوائي، وتظل قيمته ثابتة. يمكنك الحصول على الرمز المميّز أو إبطاله أو إعادة إنشائه من صفحة إعدادات Chat API في Google Cloud Console.

لا تستخدم تطبيقات Chat الحديثة هذا الحقل. ولا يظهر في ردود واجهة برمجة التطبيقات وصفحة إعدادات Chat API.

threadKey

string

المفتاح الذي يحدّده تطبيق Chat للمحادثة ذات الصلة بحدث التفاعل. يمكنك الانتقال إلى spaces.messages.thread.threadKey للاطّلاع على مزيد من المعلومات.

message

object (Message)

بالنسبة إلى أحداث التفاعل ADDED_TO_SPACE وCARD_CLICKED وMESSAGE، الرسالة التي أدّت إلى بدء حدث التفاعل، إن أمكن

user

object (User)

المستخدِم الذي تفاعل مع تطبيق Chat.

space

object (Space)

المساحة التي تفاعل فيها المستخدم مع تطبيق Chat

action

object (FormAction)

بالنسبة إلى أحداث تفاعل CARD_CLICKED، بيانات إجراءات النموذج المرتبطة عندما ينقر المستخدم على بطاقة أو مربّع حوار. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة قراءة بيانات النماذج التي يُدخلها المستخدمون على البطاقات.

configCompleteRedirectUrl

string

بالنسبة إلى أحداث التفاعل MESSAGE، يجب إعادة توجيه المستخدمين إلى عنوان URL هذا بعد إكمال عملية تفويض أو عملية ضبط خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على ربط تطبيق Chat بخدمات وأدوات أخرى.

isDialogEvent

boolean

بالنسبة إلى أحداث التفاعل بين CARD_CLICKED وMESSAGE، سواء كان المستخدم يتفاعل مع مربع حوار أو على وشك التفاعل معه.

dialogEventType

enum (DialogEventType)

نوع حدث التفاعل المربّع الذي تم تلقّيه.

common

object (CommonEventObject)

يمثّل معلومات عن برنامج العميل الخاص بالمستخدم، مثل اللغة والتطبيق المضيف والنظام الأساسي. بالنسبة إلى تطبيقات Chat، يتضمن CommonEventObject المعلومات التي يرسلها المستخدمون يتفاعلون مع مربعات الحوار، مثل البيانات التي يتم إدخالها في البطاقة.

CommonEventObject

يمثّل معلومات عن برنامج العميل الخاص بالمستخدم، مثل اللغة والتطبيق المضيف والنظام الأساسي. بالنسبة إلى تطبيقات Chat، تتضمّن CommonEventObject البيانات التي يرسلها المستخدمون الذين يتفاعلون مع البطاقات، مثل البيانات التي يتم إدخالها في المحادثات.

تمثيل JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
الحقول
userLocale

string

تمثّل هذه السمة locale.displayName الكاملة بتنسيق [رمز اللغة ISO 639]-[رمز البلد/المنطقة ISO 3166]، مثل en-US.

hostApp

enum (HostApp)

تعداد HostApp الذي يشير إلى التطبيق الذي تم استدعاء الإضافة منه CHAT دائمًا لتطبيقات Chat.

platform

enum (Platform)

قائمة الأرقام المحددة للنظام الأساسي التي تشير إلى النظام الأساسي الذي نشأ منه الحدث (WEB أو IOS أو ANDROID). لا تتيح تطبيقات Chat استخدام هذا الحقل.

timeZone

object (TimeZone)

رقم تعريف المنطقة الزمنية والمعادلة من التوقيت العالمي المنسق (UTC). لا تتوفّر هذه السمة إلا لنوعَي الحدث CARD_CLICKED وSUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

خريطة تحتوي على القيم التي يُدخلها المستخدم في أداة من بطاقة أو مربّع حوار مفاتيح الخريطة هي أرقام تعريف السلاسل المخصصة لكل تطبيق مصغّر، وتمثل القيم مدخلات إلى التطبيق المصغّر.

لمعرفة التفاصيل، يمكنك الاطّلاع على معلومات العملية التي أدخلها المستخدمون.

parameters

map (key: string, value: string)

المَعلمات المخصّصة التي تم تمريرها إلى الدالة التي تمّ استدعاؤها يجب أن تكون كل من المفاتيح والقيم سلاسل.

invokedFunction

string

اسم الدالة التي تمّ استدعاؤها والمرتبطة بالتطبيق المصغّر. يتم ضبطه لتطبيقات Chat فقط.

TimeZone

رقم تعريف المنطقة الزمنية والمعادلة من التوقيت العالمي المنسق (UTC). لا تتوفّر هذه السمة إلا لنوعَي الحدث CARD_CLICKED وSUBMIT_DIALOG.

تمثيل JSON
{
  "id": string,
  "offset": integer
}
الحقول
id

string

رمز قاعدة بيانات المنطقة الزمنية IANA TZ، مثل "أمريكا/تورنتو"

offset

integer

معادلة المنطقة الزمنية للمستخدم بالمللي ثانية من التوقيت العالمي المنسَّق (UTC)

مدخلات

أنواع البيانات التي يمكن للمستخدمين إدخالها في البطاقات أو مربّعات الحوار يعتمد نوع الإدخال على نوع القيم التي تقبلها الأداة المصغّرة.

تمثيل JSON
{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}
الحقول

حقل الربط inputs

يمكن أن يكون inputs واحدًا فقط مما يلي:

stringInputs

object (StringInputs)

قائمة بالسلاسل التي تمثّل القيم التي يُدخلها المستخدم في الأداة.

إذا كان التطبيق المصغّر يقبل قيمة واحدة فقط، مثل تطبيق مصغّر TextInput، تحتوي القائمة على عنصر سلسلة واحدة. إذا كانت الأداة المصغّرة تقبل قيمًا متعدّدة، مثل أداة مصغّرة SelectionInput مربّعات اختيار، تحتوي القائمة على عنصر سلسلة لكل قيمة يدخلها المستخدم أو يختارها.

dateTimeInput

object (DateTimeInput)

قيم إدخال التاريخ والوقت من أداة DateTimePicker التي تقبل التاريخ والوقت

dateInput

object (DateInput)

قيم التاريخ الذي يتم إدخاله من تطبيق DateTimePicker المصغّر الذي لا يقبل سوى قيم التاريخ

timeInput

object (TimeInput)

قيم إدخال الوقت من تطبيق DateTimePicker المصغّر الذي لا يقبل سوى قيم الوقت

StringInputs

مَعلمة الإدخال للتطبيقات المصغّرة العادية أما بالنسبة إلى التطبيقات المصغّرة ذات القيمة الواحدة، فهي عبارة عن قائمة قيمة واحدة. بالنسبة إلى التطبيقات المصغّرة التي تتضمّن قيمًا متعددة، مثل مربّع الاختيار، يتم عرض جميع القيم.

تمثيل JSON
{
  "value": [
    string
  ]
}
الحقول
value[]

string

قائمة بالسلاسل التي أدخلها المستخدم

DateTimeInput

قيم إدخال التاريخ والوقت

تمثيل JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
الحقول
msSinceEpoch

string (int64 format)

الوقت منذ وقت الحقبة بالمللي ثانية

hasDate

boolean

ما إذا كان الإدخال datetime يتضمّن تاريخًا تقويميًا.

hasTime

boolean

ما إذا كان الإدخال datetime يتضمّن طابعًا زمنيًا

DateInput

قيم إدخال التاريخ

تمثيل JSON
{
  "msSinceEpoch": string
}
الحقول
msSinceEpoch

string (int64 format)

الوقت منذ بدء حساب الفترة، بالمللي ثانية

TimeInput

قيم إدخال الوقت

تمثيل JSON
{
  "hours": integer,
  "minutes": integer
}
الحقول
hours

integer

الساعة بنظام 24 ساعة.

minutes

integer

عدد الدقائق التي مضت بعد الساعة القيم الصالحة هي من 0 إلى 59.