Event

حدث تفاعل في تطبيق Google 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)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
الحقول
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 المعلومات التي يرسلها المستخدمون الذين يتفاعلون مع المربّعات الحوارية، مثل البيانات التي يتم إدخالها في بطاقة.
appCommandMetadata

object (AppCommandMetadata)

يتمّ تعبئتها لأوامر التطبيقات، بما في ذلك الأوامر التي تبدأ بشرطة مائلة والطلبات السريعة.

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.

AppCommandMetadata

البيانات الوصفية المرتبطة بأوامر التطبيق أوامر التطبيقات هي طريقة تتيح للمستخدمين استدعاء تطبيق Chat والتفاعل معه. ويمكن أن تكون هذه الأوامر أوامر تبدأ بشرطة مائلة يتم كتابتها في مربّع الإنشاء، أو عناصر يتم اختيارها مباشرةً من قائمة الدمج.

تمثيل JSON 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
الحقول
appCommandId

integer

معرّف الأمر لتفاعل التطبيق المحدّد.
appCommandType

enum (AppCommandType)

نوع طلب التطبيق