Event

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

للتعرّف على أحداث التفاعل، اطّلِع على المقالة تلقّي التفاعلات مع تطبيق Google Chat والردّ عليها. للتعرّف على أنواع الأحداث ومثل حمولات الأحداث، اطّلِع على أنواع أحداث التفاعل مع تطبيق Google 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)

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

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)

الرسالة التي أدت إلى بدء حدث التفاعل، إذا كان ذلك منطبقًا.

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 المعلومات التي يرسلها المستخدمون الذين يتفاعلون مع مربعات الحوار، مثل البيانات التي تم إدخالها في بطاقة.

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.