REST Resource: projects.chatAppConfig

المورد: ChatAppConfig

تمثّل إعدادات تطبيق Google Chat الذي تم إنشاؤه كإضافة في Google Workspace.

تمثيل JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
الحقول
name

string

الحقل مطلوب. المعرّف. اسم مورد إعدادات تطبيق Chat

التنسيق: projects/{project}/chatAppConfig، حيث يمثّل {project} رقم مشروع Google Cloud.
displayName

string

الحقل مطلوب. الاسم المعروض لتطبيق Chat، ويجب أن يتراوح طوله بين 3 و25 حرفًا.
description

string

الحقل مطلوب. وصف موجز لتطبيق Chat، ويجب أن يتراوح طوله بين حرف واحد و40 حرفًا.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

اختيارية: إعدادات الميزات التفاعلية للتطبيق: في حال عدم توفير هذه الإعدادات، سيكون التطبيق غير تفاعلي، ما يعني أنّه يمكنه استخدام Chat API، ولكن لا يمكن للمستخدمين التفاعل معه.
avatarUri

string

اختيارية: عنوان URL لصورة الأفاتار الخاصة بالتطبيق يجب أن يكون عنوان URL يستخدم HTTPS ويستضيف صورة مربّعة (نسبة العرض إلى الارتفاع 1:1) بتنسيق PNG. الحدّ الأدنى المقترَح للحجم: 256 × 256 بكسل سيتم استخدام صورة رمزية تلقائية للتطبيق في حال عدم تحديد صورة.
state

enum (AppState)

اختيارية: حالة التطبيق، ويتم ضبطها تلقائيًا على ACTIVE في حال عدم تحديدها.
errorLoggingEnabled

boolean

اختيارية: ما إذا كان سيتم تسجيل الأخطاء في Cloud Logging أم لا ويتم ضبط القيمة على false تلقائيًا في حال عدم تحديدها.
markupSyntax

enum (MarkupSyntax)

اختيارية: بناء جملة الترميز التلقائي للرسائل التي يرسلها تطبيق Chat هذا أو يقرأها. يتم ضبطه تلقائيًا على MARKUP_SYNTAX_MARKDOWN في حال عدم تحديده.

AppState

الحالة الحالية لتطبيق Chat

عمليات التعداد
APP_STATE_UNSPECIFIED القيمة التلقائية غير محدد
ACTIVE يتم ربطها بـ LIVE في صفحة إعدادات Chat API. التطبيق نشط، ويمكن للمستخدمين الذين لديهم إذن بالاطّلاع عليه العثور عليه واستخدامه.
DISABLED تم إيقاف التطبيق، ولن يتمكّن أحد من العثور عليه أو التحدّث إليه بعد الآن.

InteractiveFeatureConfig

إعدادات الميزات التفاعلية في التطبيق

تمثيل JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
الحقول
connectionConfig

object (ConnectionConfig)

الحقل مطلوب. كيفية تلقّي التطبيق للأحداث من Google Chat
appCommands[]

object (AppCommand)

اختيارية: إعدادات أوامر التطبيق
urlPatterns[]

object (UrlPattern)

اختيارية: إعدادات معاينات الروابط
allowlistedTestingPrincipals[]

string

اختيارية: عناوين البريد الإلكتروني للمستخدمين والمجموعات في نطاق Google Workspace الذين يمكنهم العثور على التطبيق واستخدامه
supportsMultiuserSpaces

boolean

اختيارية: ما إذا كان يمكن إضافة التطبيق إلى الرسائل المباشرة بين شخصين والمحادثات الجماعية والمساحات ويتم ضبط القيمة على false تلقائيًا في حال عدم تحديدها.

ConnectionConfig

كيفية تلقّي التطبيق للأحداث

تمثيل JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
الحقول
نوع الاتصال في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
httpEndpointConfig

object (HttpEndpointConfig)

إعدادات نقطة نهاية HTTP
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

إعدادات نشر "برمجة تطبيقات Google"
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

إعدادات موضوع Pub/Sub
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

إعدادات Dialogflow
نهاية الحقول التي يستبعد كلّ منها الآخر

HttpEndpointConfig

إعدادات نقطة نهاية HTTP

تمثيل JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
الحقول
إعدادات عنوان URL لنقطة نهاية HTTP في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
commonUrl

string

اختيارية: عنوان URL الذي يستخدم HTTPS والذي يرسل إليه Google Chat جميع الأحداث التفاعلية
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

اختيارية: عناوين URL منفصلة تستخدم HTTPS يرسل إليها Google Chat كل نوع من الأحداث التفاعلية.
نهاية الحقول التي يستبعد كلّ منها الآخر

HttpPerEventEndpointConfig

إعدادات نقطة نهاية HTTP لأنواع أحداث معيّنة

تمثيل JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
الحقول
appCommandEndpoint

string

الحقل مطلوب. نقطة نهاية عنوان URL يستخدم HTTPS لأحداث أوامر التطبيق
addedToSpaceEndpoint

string

الحقل مطلوب. نقطة نهاية عنوان URL يستخدم HTTPS لأحداث الإضافة إلى المساحة
messageEndpoint

string

الحقل مطلوب. نقطة نهاية عنوان URL يستخدم HTTPS لأحداث الرسائل
removedFromSpaceEndpoint

string

الحقل مطلوب. نقطة نهاية عنوان URL يستخدم HTTPS للأحداث التي تمت إزالتها من المساحة

AppsScriptEndpointConfig

إعدادات نقطة نهاية "برمجة تطبيقات Google"

تمثيل JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
الحقول
deploymentId

string

الحقل مطلوب. رقم تعريف عملية نشر "برمجة تطبيقات Google"
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

اختيارية: أسماء دوال "برمجة تطبيقات Google" التي يستدعيها Google Chat لكل نوع من الأحداث التفاعلية في حال عدم تحديدها، يستدعي Chat الدالة التلقائية لكل نوع حدث.

AppsScriptPerEventEndpointConfig

إعدادات نقطة نهاية "برمجة تطبيقات Google" لأنواع أحداث معيّنة

تمثيل JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
الحقول
appCommandEndpoint

string

اختيارية: اسم الدالة لأحداث أوامر التطبيق في حال عدم تحديد اسم، سيتم استخدام اسم دالة onAppCommand التلقائي.
addedToSpaceEndpoint

string

اختيارية: اسم الدالة للأحداث التي تمت إضافتها إلى المساحة في حال عدم تحديد اسم، سيتم استخدام اسم دالة onAddedToSpace التلقائي.
messageEndpoint

string

اختيارية: اسم الدالة لأحداث الرسائل في حال عدم تحديد اسم، سيتم استخدام اسم دالة onMessage التلقائي.
removedFromSpaceEndpoint

string

اختيارية: اسم الدالة للأحداث التي تمت إزالتها من المساحة في حال عدم تحديد اسم، سيتم استخدام اسم دالة onRemovedFromSpace التلقائي.

CloudPubSubEndpointConfig

إعدادات نقطة نهاية Pub/Sub

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

string

الحقل مطلوب. موضوع Pub/Sub الذي ينشر Google Chat جميع الأحداث التفاعلية فيه. يجب أن يكون الموضوع في مشروع Google Cloud نفسه الذي يتضمّن التطبيق، ويجب أن يكون لدى Chat إذن لنشر الرسائل في الموضوع. لمعرفة التفاصيل، يُرجى الاطّلاع على المقالة إنشاء تطبيق Google Chat باستخدام Pub/Sub.

التنسيق: projects/{project}/topics/{topic}

DialogflowEndpointConfig

إعدادات نقطة نهاية Dialogflow

تمثيل JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
الحقول
dialogflowEdition

enum (DialogflowEdition)

الحقل مطلوب. إصدار Dialogflow
agent

string

اختيارية: اسم وكيل Dialogflow CX أو بيئته مطلوب لـ Dialogflow CX. لا تضبط هذه السمة لـ Dialogflow ES.

التنسيق: projects/{project}/locations/{location}/agents/{agent} أو projects/{project}/locations/{location}/agents/{agent}/environments/{environment}

DialogflowEdition

نوع إصدار Dialogflow

عمليات التعداد
DIALOGFLOW_EDITION_UNSPECIFIED القيمة التلقائية غير محدد
ES إصدار Dialogflow ES لاستخدام هذا الإصدار، يجب أن يتوفّر وكيل Dialogflow ES في مشروع Google Cloud نفسه الذي يتضمّن التطبيق، لأنّ Google Chat يرسل جميع الأحداث التفاعلية إلى هذا الوكيل.
CX إصدار Dialogflow CX لاستخدام هذا الإصدار، يجب أن يتوفّر وكيل Dialogflow CX في مشروع Google Cloud نفسه الذي يتضمّن التطبيق، وأن يتم تحديده في الحقل agent. يرسل Google Chat جميع الأحداث التفاعلية إلى هذا الوكيل.

AppCommand

إعدادات طلب التطبيق

تمثيل JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
الحقول
commandType

enum (CommandType)

الحقل مطلوب. نوع هذا الأمر
commandId

integer

الحقل مطلوب. رقم تعريف الأمر (من 1 إلى 1000) يجب أن يكون المعرّف فريدًا داخل التطبيق.
command

string

اختيارية: اسم الأمر مطلوب لـ SLASH_COMMAND، ولا يتم ضبطه لأنواع الأوامر الأخرى. يجب أن يبدأ بـ "/"، مثل "/command".
displayName

string

اختيارية: الاسم المعروض السهل الاستخدام للأمر هذا الحقل مطلوب لـ MESSAGE_ACTION وQUICK_COMMAND، ولا يجب ضبطه لـ SLASH_COMMAND.
description

string

الحقل مطلوب. وصف موجز للأمر
dialogEnabled

boolean

اختيارية: لتحديد ما إذا كان يجب أن يؤدي هذا الأمر إلى ظهور مربّع حوار أم لا. ويتم ضبط القيمة على false تلقائيًا في حال عدم تحديدها.
loadingNotificationMessage

string

اختيارية: إشعار يتم إرساله إلى المستخدم عندما ينفّذ إجراء الرسالة لا تتوافق هذه الميزة إلا مع أوامر MESSAGE_ACTION.

CommandType

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

عمليات التعداد
COMMAND_TYPE_UNSPECIFIED القيمة التلقائية غير محدد
SLASH_COMMAND أمر يتم استدعاؤه من خلال كتابة "/" متبوعة باسم الأمر. وقد تقبل وسيطات إضافية في نص الرسالة.
QUICK_COMMAND أمر سريع يتم استدعاؤه من قائمة السياق الخاصة بإنشاء الرسائل لا تقبل الطلبات السريعة وسيطات إضافية.
MESSAGE_ACTION أمر يتم استدعاؤه من قائمة سياق الرسالة

UrlPattern

إعدادات معاينة الرابط

تمثيل JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
الحقول
hostPattern

string

الحقل مطلوب. النطاق المطلوب مطابقته يمكنك مطابقة نطاق فرعي معيّن، مثل "subdomain.example.com"، أو نطاق كامل من خلال تضمين علامة النجمة (*) كحرف بدل بادئ. على سبيل المثال، يتطابق "‎*.example.com" مع "https://subdomain.example.com" و "https://any.number.of.subdomains.example.com".
pathPrefix

string

اختيارية: بادئة المسار المُلحَقة بنمط المضيف إذا كان الحقل فارغًا، يتطابق مع جميع عناوين URL في نمط المضيف. على سبيل المثال، عند إقرانها بنمط المضيف "subdomain.example.com"، حدِّد "path/‎" لمطابقة عناوين URL للصفحات التي تبدأ بـ "https://subdomain.example.com/path/‎".

MarkupSyntax

بناء جملة الترميز المستخدَم لتنسيق نص الرسالة في تطبيق Chat هذا

عمليات التعداد
MARKUP_SYNTAX_UNSPECIFIED القيمة التلقائية غير محدد تحتوي تطبيقات Chat الحالية التي تم إنشاؤها قبل طرح markup_syntax على هذه القيمة وتستخدم MARKUP_SYNTAX_CHAT إلى أن يتم تعديلها صراحةً.
MARKUP_SYNTAX_CHAT يستخدم هذا الحقل بنية الترميز في Google Chat. لمزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN يستخدم بنية Markdown. تستند هذه البنية إلى مواصفات CommonMark، مع إضافات أخرى. لمزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/workspace/chat/format-messages#format-texts.

الطُرق

get

 للحصول على إعدادات تطبيق Chat لمشروع معيّن

patch

 تعديل إعدادات تطبيق Chat لمشروع معيّن