Event

حدث تفاعل مع تطبيق Google Chat.

للتعرُّف على أحداث التفاعل، يُرجى الاطّلاع على استلام التفاعلات مع تطبيق Google 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)

نوع حدث التفاعل. للتعرُّف على التفاصيل، يُرجى الاطِّلاع على أنواع أحداث التفاعل مع تطبيق Google Chat.

eventTime

string (Timestamp format)

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

token

string

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

لا تستخدم تطبيقات Chat الحديثة هذا الحقل. ولا تتوفّر هذه الواجهة في استجابات واجهة برمجة التطبيقات وصفحة ضبط واجهة برمجة تطبيقات Chat.

threadKey

string

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

message

object (Message)

الرسالة التي أدت إلى تشغيل حدث التفاعل، إن وُجد.

user

object (User)

المستخدم الذي بدأ حدث التفاعل.

space

object (Space)

المساحة التي وقع فيها حدث التفاعل.

action

object (FormAction)

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

configCompleteRedirectUrl

string

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

isDialogEvent

boolean

بالنسبة إلى أحداث التفاعل CARD_CLICKED، سواء تفاعل المستخدم مع مربّع حوار أم لا.

dialogEventType

enum (DialogEventType)

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

common

object (CommonEventObject)

يمثل معلومات حول برنامج المستخدم، مثل اللغة وتطبيق المضيف والنظام الأساسي. بالنسبة إلى تطبيقات Chat، يتضمّن 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] مثل "ar-AE".

hostApp

enum (HostApp)

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

platform

enum (Platform)

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

timeZone

object (TimeZone)

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

formInputs

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

خريطة تحتوي على القيم الحالية للتطبيقات المصغّرة في بطاقة. مفاتيح الخريطة هي أرقام تعريف السلاسل التي تم تخصيصها لكل أداة، وتمثّل القيم إدخالات في الأداة. استنادًا إلى نوع بيانات الإدخال، يمثل عنصر مختلف كل إدخال: بالنسبة إلى التطبيقات المصغّرة ذات القيمة الواحدة، StringInput. بالنسبة إلى التطبيقات المصغّرة المتعددة القيم، هي مصفوفة من عناصر StringInput. أداة اختيار التاريخ DateTimeInput منتقي التاريخ فقط، وهو DateInput. منتقي الوقت فقط: TimeInput يتطابق مع البيانات التي أدخلها المستخدم على بطاقة في مربّع حوار.

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)

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

dateTimeInput

object (DateTimeInput)

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

dateInput

object (DateInput)

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

timeInput

object (TimeInput)

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

مدخلات السلسلة

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

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

string

مصفوفة من السلاسل التي أدخلها المستخدم.

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

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

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

string (int64 format)

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

hasDate

boolean

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

hasTime

boolean

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

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

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

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

string (int64 format)

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

الإدخال الزمني

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

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

integer

الساعة بتنسيق 24 ساعة

minutes

integer

عدد الدقائق التي تتجاوز الساعة. تتراوح القيم الصالحة بين 0 و59.