REST Resource: projects.deployments

المَرجع: النشر

عملية نشر لإضافة Google Workspace

تمثيل JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
الحقول
name

string

اسم مورد النشر مثال: projects/123/deployments/my_deployment
oauthScopes[]

string

قائمة بنطاقات Google OAuth التي يجب طلب الموافقة عليها من المستخدم النهائي قبل تنفيذ نقطة نهاية الإضافة
addOns

object (AddOns)

إعدادات إضافة Google Workspace
etag

string

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

AddOns

إعدادات إحدى إضافات Google Workspace

تمثيل JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
الحقول
common

object (CommonAddOnManifest)

الإعدادات الشائعة في جميع إضافات Google Workspace
gmail

object (GmailAddOnManifest)

إعدادات إضافة Gmail
drive

object (DriveAddOnManifest)

إعدادات إضافات Drive
calendar

object (CalendarAddOnManifest)

إعدادات إضافة "تقويم Google"
docs

object (DocsAddOnManifest)

إعدادات إضافة "مستندات Google"
meet

object (MeetAddOnManifest)

إعدادات إضافة Meet
sheets

object (SheetsAddOnManifest)

إعدادات إضافة "جداول بيانات Google"
slides

object (SlidesAddOnManifest)

إعدادات إضافة "العروض التقديمية من Google"
httpOptions

object (HttpOptions)

خيارات لإرسال طلبات إلى نقاط نهاية HTTP الخاصة بالإضافات

CommonAddOnManifest

إعدادات الإضافة التي تتم مشاركتها بين جميع التطبيقات المضيفة للإضافة

تمثيل JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
الحقول
name

string

الحقل مطلوب. الاسم المعروض للإضافة.
logoUrl

string

الحقل مطلوب. عنوان URL لصورة الشعار المعروضة في شريط أدوات الإضافة
layoutProperties

object (LayoutProperties)

خصائص التنسيق الشائعة لبطاقات الإضافة
addOnWidgetSet

object (AddOnWidgetSet)

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

boolean

تحديد ما إذا كان سيتم نقل معلومات اللغة من التطبيق المضيف
homepageTrigger

object (HomepageExtensionPoint)

تحدّد نقطة نهاية سيتم تنفيذها في أي سياق، وفي أي مضيف. ستكون أي بطاقات يتم إنشاؤها بواسطة هذه الدالة متاحة دائمًا للمستخدم، ولكن قد يتم حجبها بواسطة المحتوى السياقي عندما تعلن هذه الإضافة عن مشغّلات أكثر استهدافًا.
universalActions[]

object (UniversalActionExtensionPoint)

تحدّد هذه السمة قائمة بنقاط الإضافة في قائمة الإجراءات العامة التي تعمل كقائمة إعدادات للإضافة. يمكن أن تكون نقطة الإضافة عبارة عن عنوان URL لرابط سيتم فتحه أو نقطة نهاية سيتم تنفيذها كعملية إرسال نموذج.
openLinkUrlPrefixes

array (ListValue format)

لا يمكن أن يستخدم إجراء OpenLink إلا عنوان URL يتضمّن المخطط HTTPS أو MAILTO أو TEL. بالنسبة إلى روابط HTTPS، يجب أن يتطابق عنوان URL أيضًا مع إحدى البادئات المحدّدة في القائمة المسموح بها. إذا لم تتضمّن البادئة المخطط، يتم افتراض القيمة HTTPS. تتم إعادة كتابة روابط HTTP تلقائيًا لتصبح روابط HTTPS.

LayoutProperties

خصائص تصميم البطاقة المشترَكة بين جميع تطبيقات المضيف الخاصة بالإضافات

تمثيل JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
الحقول
primaryColor

string

اللون الأساسي للإضافة يضبط لون شريط الأدوات. إذا لم يتم ضبط لون أساسي، سيتم استخدام القيمة التلقائية التي يوفّرها إطار العمل.
secondaryColor

string

اللون الثانوي للإضافة تضبط هذه السمة لون الأزرار. إذا تم ضبط اللون الأساسي ولكن لم يتم ضبط أي لون ثانوي، سيكون اللون الثانوي هو نفسه اللون الأساسي. إذا لم يتم ضبط اللون الأساسي أو اللون الثانوي، سيتم استخدام القيمة التلقائية التي يوفّرها إطار العمل.
useNewMaterialDesign
(deprecated)

boolean

تفعيل تصميمات متعددة الأبعاد للبطاقات

AddOnWidgetSet

مجموعة التطبيقات المصغّرة التي تستخدمها إحدى الإضافات

تمثيل JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
الحقول
usedWidgets[]

enum (WidgetType)

قائمة الأدوات المستخدَمة في إضافة

WidgetType

تمثّل هذه السمة نوع التطبيق المصغَّر. WIDGET_TYPE_UNSPECIFIED هي مجموعة التطبيقات المصغّرة الأساسية.

عمليات التعداد
WIDGET_TYPE_UNSPECIFIED مجموعة الأدوات التلقائية
DATE_PICKER أداة اختيار التاريخ
STYLED_BUTTONS تتضمّن الأزرار ذات الأنماط أزرارًا معبّأة وأزرارًا غير مفعّلة.
PERSISTENT_FORMS تسمح النماذج الثابتة بالاحتفاظ بقيم النموذج أثناء تنفيذ الإجراءات.
UPDATE_SUBJECT_AND_RECIPIENTS تعديل موضوع مسودة الرسالة ومستلميها
GRID_WIDGET التطبيق المصغّر للشبكة
ADDON_COMPOSE_UI_ACTION إجراء إضافة في Gmail ينطبق على واجهة مستخدم الإنشاء الخاصة بالإضافة

HomepageExtensionPoint

تنسيق شائع لتحديد طريقة عرض الصفحة الرئيسية للإضافة

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

string

الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة هذه.
enabled

boolean

اختيارية: إذا تم ضبطها على false، سيتم إيقاف عرض الصفحة الرئيسية في هذا السياق.

يتم ضبط القيمة تلقائيًا على true في حال عدم ضبطها.

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

UniversalActionExtensionPoint

تنسيق لتحديد نقطة إضافة عنصر قائمة إجراءات عامة

تمثيل JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
الحقول
label

string

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

string

نقطة النهاية التي سيتم تشغيلها بواسطة UniversalAction

GmailAddOnManifest

السمات التي تخصّص مظهر إضافة Gmail وطريقة تنفيذها

تمثيل JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

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

في حال توفّر هذه القيمة، يتم تجاوز الإعداد من addons.common.homepageTrigger.
contextualTriggers[]

object (ContextualTrigger)

تحدّد هذه السمة مجموعة الشروط التي تؤدي إلى تشغيل الإضافة.
universalActions[]

object (UniversalAction)

تحدّد هذه السمة مجموعة من الإجراءات العامة للإضافة. ينفّذ المستخدم الإجراءات الشاملة من قائمة شريط أدوات الإضافة.
composeTrigger

object (ComposeTrigger)

تحدّد هذه السمة عامل تشغيل وقت الإنشاء لإضافة وقت الإنشاء. هذا هو المشغّل الذي يؤدي إلى اتّخاذ إضافة إجراء عندما يكتب المستخدم رسالة إلكترونية. يجب أن تتضمّن جميع إضافات وقت الإنشاء النطاق gmail.addons.current.action.compose حتى إذا كانت لا تعدّل المسودة.
authorizationCheckFunction

string

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

ContextualTrigger

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

تمثيل JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
الحقول
onTriggerFunction

string

الحقل مطلوب. اسم نقطة النهاية التي سيتم استدعاؤها عندما تتطابق رسالة مع المشغّل.
حقل الدمج trigger يحدّد نوع المشغّل الشروط التي يستخدمها Gmail لعرض الإضافة. يمكن أن تكون trigger إحدى القيم التالية فقط:
unconditional

object (UnconditionalTrigger)

يتم تنفيذ المشغّلات غير المشروطة عند فتح أي رسالة بريد.

UnconditionalTrigger

لا يتضمّن هذا النوع أي حقول.

مُشغِّل يتم تنشيطه عند فتح أي رسالة إلكترونية.

UniversalAction

إجراء متاح دائمًا في قائمة شريط أدوات الإضافة بغض النظر عن سياق الرسالة

تمثيل JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
الحقول
text

string

الحقل مطلوب. نص مرئي للمستخدم يصف الإجراء، مثل "إضافة جهة اتصال جديدة"
حقل الدمج action_type يحدّد نوع الإجراء سلوك Gmail عندما ينفّذ المستخدم الإجراء. يمكن أن تكون action_type إحدى القيم التالية فقط:
runFunction

string

نقطة نهاية يتم استدعاؤها عندما يبدأ المستخدم الإجراء. راجِع دليل الإجراءات العامة للاطّلاع على التفاصيل.

ComposeTrigger

مشغّل يتم تنشيطه عندما يكتب المستخدم رسالة إلكترونية.

تمثيل JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
الحقول
actions[]

object (MenuItemExtensionPoint)

تحدّد هذه السمة مجموعة الإجراءات الخاصة بإضافة وقت الإنشاء. هذه هي الإجراءات التي يمكن للمستخدمين اتّخاذها على إضافة وقت الإنشاء.
draftAccess

enum (DraftAccess)

تحدّد هذه السمة مستوى الوصول إلى البيانات عند تشغيل إضافة وقت الإنشاء.

DraftAccess

تعداد يحدّد مستوى الوصول إلى البيانات الذي يتطلّبه مشغّل الإنشاء.

عمليات التعداد
UNSPECIFIED القيمة التلقائية عندما لا يتم ضبط أي قيمة لـ draftaccess
NONE لا يمكن لمشغّل الإنشاء الوصول إلى أي بيانات من المسودة عند تشغيل إضافة الإنشاء.
METADATA يمنح أمر التشغيل "إنشاء" الإذن بالوصول إلى البيانات الوصفية للمسودة عند تشغيل إضافة "إنشاء". ويشمل ذلك قائمة المستلمين، مثل قائمة "إلى" و"نسخة طبق الأصل" في مسودة رسالة.

DriveAddOnManifest

خصائص تخصّص مظهر إحدى إضافات Drive وطريقة تنفيذها

تمثيل JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

في حال توفّر هذه القيمة، يتم تجاوز الإعداد من addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

يتوافق مع السلوك الذي يتم تنفيذه عند اختيار عناصر في طريقة عرض Drive ذات الصلة، مثل قائمة مستندات "ملفاتي".

DriveExtensionPoint

تنسيق شائع لتحديد مشغّلات إضافات Drive

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

string

الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة

CalendarAddOnManifest

السمات التي تخصّص مظهر إحدى إضافات "تقويم Google" وطريقة تنفيذها

تمثيل JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

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

في حال توفّر هذه القيمة، يتم تجاوز الإعداد من addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

تحدّد هذه السمة حلول مكالمات الفيديو التي توفّرها هذه الإضافة. لا يمكن إنشاء إضافات لمكالمات الفيديو تابعة لجهات خارجية إلا في Apps Script.
createSettingsUrlFunction

string

نقطة نهاية لتنفيذ عملية إنشاء عنوان URL لصفحة إعدادات الإضافة.
eventOpenTrigger

object (CalendarExtensionPoint)

نقطة نهاية يتم تشغيلها عند فتح حدث لعرضه أو تعديله.
eventUpdateTrigger

object (CalendarExtensionPoint)

نقطة نهاية يتم تشغيلها عند تعديل حدث الفتح.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

إعدادات مشغّل سياقي يتم تشغيله عندما ينقر المستخدم على مقدّم مرفقات الإضافة في القائمة المنسدلة "تقويم Google".
currentEventAccess

enum (EventAccess)

تحدّد هذه السمة مستوى الوصول إلى البيانات عند تفعيل إضافة حدث.

ConferenceSolution

تحدّد هذه السمة القيم ذات الصلة بالمؤتمرات. لا يمكن إنشاء إضافات لمكالمات الفيديو تابعة لجهات خارجية إلا في Apps Script.

تمثيل JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
الحقول
onCreateFunction

string

الحقل مطلوب. نقطة النهاية التي يجب الاتصال بها عند إنشاء بيانات الاجتماع.
id

string

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

string

الحقل مطلوب. الاسم المعروض لحلّ المؤتمرات
logoUrl

string

الحقل مطلوب. تمثّل هذه السمة عنوان URL لصورة شعار حلّ المؤتمرات.

CalendarExtensionPoint

تنسيق شائع لتحديد مشغّلات إضافة "تقويم Google".

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

string

الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة هذه.

EventAccess

تعداد يحدّد مستوى الوصول إلى البيانات الذي تتطلّبه مشغّلات أحداث الوصول إلى البيانات.

عمليات التعداد
UNSPECIFIED القيمة التلقائية عندما لا يتم ضبط أي قيمة لـ eventAccess
METADATA يمنح مشغّلات الأحداث الإذن بالوصول إلى البيانات الوصفية للأحداث، مثل معرّف الحدث ومعرّف التقويم.
READ يمنح مشغّلات الأحداث إذن الوصول إلى جميع حقول الأحداث المقدَّمة، بما في ذلك البيانات الوصفية والضيوف وبيانات المؤتمر.
WRITE يمنح مشغّلات الأحداث إذن الوصول إلى البيانات الوصفية للأحداث وإمكانية تنفيذ جميع الإجراءات، بما في ذلك إضافة الضيوف وتحديد بيانات مكالمة الفيديو.
READ_WRITE يمنح مشغّلات الأحداث إذن الوصول إلى جميع حقول الأحداث المقدَّمة، بما في ذلك البيانات الوصفية والضيوف وبيانات مكالمة الفيديو، وإمكانية تنفيذ جميع الإجراءات.

DocsAddOnManifest

السمات التي تخصّص مظهر إحدى إضافات "مستندات Google" وطريقة تنفيذها

تمثيل JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

في حال توفّر هذه القيمة، يتم تجاوز الإعداد من addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

نقطة النهاية التي سيتم تنفيذها عند منح إذن الوصول إلى نطاق الملف لهذا المستند/المستخدم.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

قائمة بنقاط الإضافة لمعاينة الروابط في مستند "مستندات Google" لمزيد من التفاصيل، يُرجى الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية.
createActionTriggers[]

object (CreateActionExtensionPoint)

قائمة بنقاط الإضافة لإنشاء مراجع تابعة لجهات خارجية من داخل تطبيقات Google Workspace لمزيد من المعلومات، يُرجى الاطّلاع على إنشاء مراجع خارجية من قائمة @.

DocsExtensionPoint

التنسيق الشائع لتحديد مشغّلات إضافة "مستندات Google"

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

string

الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة هذه.

LinkPreviewExtensionPoint

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

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

string

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

map (key: string, value: string)

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

إذا كانت لغة المستخدم متوفرة في مفاتيح الخريطة، سيظهر للمستخدم الإصدار المترجَم من labeltext.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }
patterns[]

object (UriPattern)

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

string

الحقل مطلوب. نقطة نهاية يتم تنفيذها عند تشغيل معاينة رابط.
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 فارغًا.

CreateActionExtensionPoint

إعدادات مشغّل يتم تنشيطه عندما يستدعي مستخدم سير عمل إنشاء الموارد في أحد تطبيقات 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.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }
runFunction

string

الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند بدء سير عمل إنشاء الموارد لإنشاء رابط
logoUrl

string

اختيارية: رمز نقطة دخول إنشاء المرجع في حال عدم تضمينها، تستخدم القائمة رمز شريط أدوات الإضافة، logourl.

MeetAddOnManifest

ملف بيان إضافة Meet

تمثيل JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

في حال توفّر هذه القيمة، يتم تجاوز الإعداد من addons.common.homepageTrigger.
web

object (Web)

تفاصيل حول الإضافات التي تحسّن أداء تطبيق Meet على الويب
supportsCollaboration

boolean

تُستخدَم لتحديد ما إذا كانت الإضافة تتيح التعاون أو دعوة مستخدمين آخرين إلى تجربة الإضافة.
termsUri

string

يجب عرض رابط يؤدي إلى بنود الخدمة الخاصة بالإضافة، إذا كانت متوفرة.

الويب

تفاصيل حول الإضافات التي تحسّن أداء تطبيق Meet على الويب

تمثيل JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
الحقول
sidePanelUri
(deprecated)

string

معرّف الموارد المنتظم (URI) لإطار iframe الخاص باللوحة الجانبية.
sidePanelUrl

string

عنوان URL لإطار iframe في اللوحة الجانبية
mainStageUri
(deprecated)

string

معرّف الموارد المنتظم (URI) لإطار iframe الخاص بـ "المسرح الرئيسي".
supportsScreenSharing

boolean

تُستخدَم لتحديد ما إذا كانت الإضافة تتيح مشاركة الشاشة في المسرح الرئيسي.
supportsCollaboration
(deprecated)

boolean

تُستخدَم لتحديد ما إذا كانت الإضافة تتيح التعاون أو دعوة مستخدمين آخرين إلى تجربة الإضافة. تم إيقاف هذا الحقل نهائيًا، يُرجى استخدام الحقل ذي المستوى الأعلى في MeetAddOnManifest.
supportsPopOut

boolean

تُستخدَم لتحديد ما إذا كانت الإضافة تتيح عرض المحتوى في نافذة عائمة في المتصفّح.
hostOrigins[]
(deprecated)

string

اسم قديم تم إيقافه نهائيًا. المصادر التي يجب إضافتها إلى السمة frame-src الخاصة بإطار iframe الذي يتضمّن الموقع الإلكتروني التابع لجهة خارجية استخدِم addonorigins بدلاً من ذلك.
addOnOrigins[]

string

المصادر التي يجب إضافتها إلى السمة frame-src الخاصة بإطار iframe الذي يتضمّن الموقع الإلكتروني التابع لجهة خارجية
openState

enum (State)

الحالة الأولية عند فتح الإضافة
supportsCollaborationHostControls

boolean

ما إذا كانت إضافة التعاون تتيح عناصر تحكّم المضيف
logoUrl

string

تمثّل هذه السمة عنوان URL للشعار الذي سيتم عرضه للإضافة. في حال عدم تحديد شعار، سيتم تلقائيًا استخدام الشعار في القسم المشترك من ملف البيان.
darkModeLogoUrl

string

تمثّل هذه السمة نسخة من logourl متوافقة مع الوضع الداكن.
displayFlow
(deprecated)

enum (DisplayFlow)

مسار العرض الذي ستتّبعه الإضافة عند تشغيلها

الحالة

تعداد لتحديد حالة فتح الإضافة الأولية.

عمليات التعداد
STATE_UNSPECIFIED لم يتم تحديد الحالة الأولية باستخدام الإضافة.
SIDE_PANEL_ONLY تفتح الإضافة مع تفعيل اللوحة الجانبية فقط.
MAIN_STAGE_ONLY يتم فتح الإضافة مع تفعيل المرحلة الرئيسية فقط.
SIDE_PANEL_AND_MAIN_STAGE يتم فتح الإضافة مع تفعيل كلّ من اللوحة الجانبية والمنطقة الرئيسية.

DisplayFlow

تعداد لتحديد مسار العرض الذي ستتّبعه الإضافة عند تشغيلها

عمليات التعداد
DISPLAY_FLOW_UNSPECIFIED لم يتم تحديد مسار العرض.
FOCUS يجب أن يتم تشغيل الإضافة في مسار العرض "في المقدّمة".
AUGMENT يجب أن يتم تشغيل الإضافة في مسار العرض "augment".

SheetsAddOnManifest

السمات التي تخصّص مظهر إضافة "جداول بيانات Google" وطريقة تنفيذها

تمثيل JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

في حال توفّر هذه القيمة، يتم تجاوز الإعداد من addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

نقطة النهاية التي سيتم تنفيذها عند منح إذن الوصول إلى نطاق الملف لهذا المستند/المستخدم.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

التنسيق الشائع لتحديد مشغّلات إحدى إضافات "جداول بيانات Google"

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

string

الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة هذه.

SlidesAddOnManifest

السمات التي تخصّص مظهر إحدى إضافات "العروض التقديمية من Google" وطريقة تنفيذها

تمثيل JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

في حال توفّر هذه القيمة، يتم تجاوز الإعداد من addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

نقطة النهاية التي سيتم تنفيذها عند منح إذن الوصول إلى نطاق الملف لهذا المستند/المستخدم.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SlidesExtensionPoint

تنسيق شائع لتحديد مشغّلات إضافات "العروض التقديمية من Google".

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

string

الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة هذه.

HttpOptions

خيارات لإرسال طلبات إلى نقاط نهاية إضافة HTTP

تمثيل JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
الحقول
authorizationHeader

enum (HttpAuthorizationHeader)

إعدادات الرمز المميز المُرسَل في عنوان التفويض HTTP
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

تُستخدَم لتحديد ما إذا كانت الإضافة قد فعّلت ميزة "الموافقة الدقيقة على OAuth".

HttpAuthorizationHeader

عنوان التفويض الذي تم إرساله في طلبات الإضافة HTTP

عمليات التعداد
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED القيمة التلقائية، وهي تعادل SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN إرسال رمز مميّز للمعرّف لحساب خدمة النظام الخاص بإضافة Google Workspace الخاصة بالمشروع (الإعداد التلقائي)
USER_ID_TOKEN أرسِل رمزًا مميّزًا للمعرّف خاصًا بالمستخدم النهائي.
NONE لا ترسِل عنوان مصادقة.

GranularOauthPermissionSupport

تُستخدَم لتحديد ما إذا كانت الإضافة قد فعّلت ميزة "الموافقة الدقيقة على OAuth".

عمليات التعداد
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED القيمة التلقائية، ويجب عدم استخدامها.
OPT_IN تم تفعيل ميزة "الموافقة الدقيقة على OAuth" للإضافة.
OPT_OUT تم إيقاف ميزة "الموافقة الدقيقة على OAuth" في الإضافة.

الطُرق

create

 تنشئ هذه الطريقة عملية نشر بالاسم والإعداد المحدّدَين.

delete

 يحذف عملية النشر بالاسم المحدّد.

get

 تعرض هذه الطريقة عملية النشر بالاسم المحدّد.

getInstallStatus

 تعرض هذه الطريقة حالة تثبيت عملية نشر تجريبية.

install

 تثبِّت هذه الطريقة عملية نشر في حسابك بغرض الاختبار.

list

 تعرض هذه الطريقة جميع عمليات النشر في مشروع معيّن.

replaceDeployment

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

uninstall

 تؤدي هذه الطريقة إلى إلغاء تثبيت عملية نشر اختبارية من حساب المستخدم.