مورد بيان المحرِّر

تهيئة المورد المستخدمة لتحديد إضافة Google Workspace المحتوى والسلوك داخل المحررين. يجب أن تحتوي بيانات إضافة Google Workspace على جميع المكوّنات التي تم وضع علامة مطلوب عليها في حال توسيع المحرّر.

المحرّرون

إعداد بيان إضافة Google Workspace للنطاق إضافات المحرّر عرض توسيع نطاق عمل "المحرِّرين" باستخدام إضافات Google Workspace لمزيد من المعلومات.

تمثيل JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
الحقول
homepageTrigger

object (HomepageTrigger)

تنشئ دالة المشغل هذه الإضافة الصفحة الرئيسية في التطبيق المضيف. يؤدي هذا الإجراء إلى التجاهل addOns.common.homepageTrigger

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

مطلوبة إذا كانت إضافتك تتضمن سلوكًا خاصًا بالإعداد الحالي مستند المحرّر، يتم تشغيله عندما يفوّض المستخدم نطاق drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

مطلوب لمعاينات الروابط. قائمة المشغلات لـ معاينة الروابط في ملف في "مستندات Google" أو "جداول بيانات Google" أو "العروض التقديمية من Google". لمعرفة التفاصيل، يُرجى الاطّلاع على معاينة الروابط التي تحتوي على شرائح ذكية.

createActionTriggers[]

object (createActionTriggers)

مطلوبة لإنشاء موارد تابعة لجهات خارجية قائمة بالعوامل المُشغِّلة لإنشاء الموارد في خدمة تابعة لجهة خارجية من القائمة @ لمعرفة التفاصيل، يُرجى الاطّلاع على المقالة إنشاء موارد تابعة لجهات خارجية باستخدام الشرائح الذكية.

OnFileScopeGrantedTrigger

يشير هذا المصطلح إلى ضبط للمشغّل السياقي الذي يتم تشغيله عند استخدام مربّع حوار طلب مستوى الملف باستخدام CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); ويمنح المستخدم drive.file تفويض النطاق.

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

string

اسم الدالة المطلوب تنفيذها إذا كان نطاق drive.file ممنوح. إذا تم تحديدها، يجب تنفيذ هذه الدالة لإنشاء إرجاع صفيف من عناصر Card للعرض في واجهة مستخدم الإضافة.

LinkPreviewTriggers

ضبط مشغِّل يتم تنشيطه عندما يكتب المستخدم رابطًا أو يلصقه. من جهة خارجية أو غير تابعة لـ Google إلى المستندات، أو "جداول بيانات Google" أو "العروض التقديمية من Google".

لإعداد هذا المشغِّل لإضافة Google Workspace، الرؤية معاينة الروابط التي تحتوي على شرائح ذكية

تمثيل JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
الحقول
labelText

string

يجب ملء هذا الحقل. نص نموذج شريحة ذكية يطلب من المستخدمين لمعاينة الرابط، مثل Example: Support case. هذا النص ثابت ويتم عرضه قبل أن ينفِّذ المستخدمون الإضافة.
localizedLabelText

map (key: string, value: string)

اختياريّ. خريطة لـ labelText للترجمة إلى لغات أخرى. تنسيق اللغة وفقًا لمعيار ISO 639 والبلد/المنطقة في ISO 3166، مفصولة بواصلة -. مثلاً: en-US

إذا كانت لغة المستخدم موجودة في مفاتيح الخريطة، فسيشاهد المستخدم نسخة مترجمة من labelText.

patterns[]

object (UriPattern)

يجب ملء هذا الحقل. مصفوفة من أنماط عناوين URL تؤدي إلى تشغيل الإضافة لمعاينة الروابط
runFunction

string

يجب ملء هذا الحقل. اسم الدالة المطلوب تشغيلها عندما يسمح المستخدم باستخدام نطاق https://www.googleapis.com/auth/workspace.linkpreview. إذا تم تحديد هذه الدالة، يجب تنفيذ هذه الدالة لقبول كائن حدث يحتوي على EDITOR_NAME.matchedUrl.url كوسيطة وعرض قيمة واحدة. عنصر Card يعرض معاينة رابط في واجهة مستخدم الإضافة.
logoUrl

string

اختياريّ. الرمز الذي يظهر في الشريحة الذكية وبطاقة المعاينة في حال حذف تم حذف الإضافة، تستخدم الإضافة رمز شريط الأدوات، logoUrl.

UriPattern

ضبط كل نمط عنوان URL يؤدي إلى ظهور معاينة الرابط.

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

string

مطلوب لكل نمط عنوان URL للمعاينة.نطاق نمط عنوان URL. تراجع الإضافة الروابط التي تحتوي على هذا النطاق في عنوان URL. لمعاينة الروابط لنطاق فرعي محدّد، مثل subdomain.example.com، يجب تضمين هذا النطاق الفرعي. لمعاينة الروابط للنطاق بالكامل، حدِّد حرف بدل مع علامة النجمة (*) كنطاق فرعي.

على سبيل المثال، تتطابق السمة *.example.com مع subdomain.example.com. وanother.subdomain.example.com.

pathPrefix

string

اختياريّ. المسار الذي يُلحق نطاق hostPattern.

على سبيل المثال، إذا كان نمط مضيف عنوان URL هو support.example.com، لمطابقة عناوين URL للحالات المُستضافة على support.example.com/cases/، استخدِم cases.

لمطابقة جميع عناوين URL في نطاق نمط المضيف، اترك pathPrefix فارغًا.

CreateActionTriggers

ضبط المشغِّل الذي يتم تنشيطه عندما يختار المستخدم جهة خارجية عنصر قائمة الدمج من قائمة @ مستندات Google.

لإعداد هذا المشغِّل لإضافة Google Workspace، الرؤية إنشاء موارد تابعة لجهات خارجية باستخدام الشرائح الذكية

تمثيل JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
الحقول
id

string

يجب ملء هذا الحقل. المعرّف الفريد لتمييز هذه الإضافة نقطة واحدة. يمكن أن يتألّف المعرّف من 64 حرفًا كحدّ أقصى، ويجب أن يكون بالتنسيق التالي: [a-zA-Z0-9-]+..
labelText

string

مطلوبة النص الذي يظهر في علامة @ مثل Create support case.
localizedLabelText

map (key: string, value: string)

اختياريّ. خريطة لـ labelText للترجمة إلى لغات أخرى. تنسيق اللغة وفقًا لمعيار ISO 639 والبلد/المنطقة في ISO 3166، مفصولة بواصلة -. مثلاً: en-US

إذا كانت لغة المستخدم موجودة في مفاتيح الخريطة، فسيشاهد المستخدم نسخة مترجمة من labelText.

runFunction

string

يجب ملء هذا الحقل. اسم الدالة المطلوب تشغيلها عندما يحدد المستخدم نقطة إضافة من القائمة @. يجب أن تعرض الدالة بطاقة نموذج تحتوي على إدخالات لإنشاء المورد التابع لجهة خارجية.
logoUrl

string

اختياريّ. الرمز الذي يظهر في قائمة @ في حال حذف تم حذف الإضافة، تستخدم الإضافة رمز شريط الأدوات، logoUrl.