REST Resource: projects.deployments

المورد: Deployment

نشر إضافة 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,

  "openLink": string,
  "runFunction": string
}
الحقول
label

string

الحقل مطلوب. نص يظهر للمستخدم يصف الإجراء الذي تم اتخاذه من خلال تفعيل نقطة الإضافة هذه، على سبيل المثال، "إضافة جهة اتصال جديدة".
الحقل مطلوب. نوع الإجراء المتوافق مع عنصر قائمة إجراءات عامة ويمكن أن يكون رابطًا لفتحه أو نقطة نهاية لتنفيذها. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
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,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
الحقول
onTriggerFunction

string

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

object (UnconditionalTrigger)

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

UnconditionalTrigger

لا يحتوي هذا النوع على أي حقول.

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

UniversalAction

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

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

  "openLink": string,
  "runFunction": string
}
الحقول
text

string

الحقل مطلوب. نص يظهر للمستخدم يصف الإجراء، مثل "إضافة جهة اتصال جديدة"
يحدّد نوع الإجراء سلوك Gmail عندما يستدعي المستخدم الإجراء. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
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)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

اختيارية: يحدّد هذا الحقل منصات مكالمات الفيديو التي توفّرها هذه الإضافة.
createSettingsUrlFunction

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

اختيارية: يتم تفعيل هذا الحدث عند إنشاء حدث أو تعديله في تقويم اشترك فيه المستخدم. لا ينطبق إلا على المشغّلات التي أنشأها HTTP endpoints باستخدام CalendarSubscriptionActionMarkup.

لمنع تكرار إرسال الإشعارات، عندما تعدّل إضافة حدثًا في "تقويم Google" باستخدام Calendar API مع بيانات اعتماد المصادقة من مشروع Google Cloud نفسه الذي يستضيف عملية نشر الإضافة، يوقف النظام الأساسي إشعارات التعديل. لا يمكن تفعيل طلبات بيانات Calendar API لمشروعك ذاتيًا.

لا ينطبق ذلك على Apps Script add-ons وApps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

تحدّد القيم ذات الصلة بالاجتماعات.

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

string

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

string

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

string

الحقل مطلوب. الاسم المعروض لمنصة مكالمات الفيديو
logoUrl

string

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

CalendarExtensionPoint

التنسيق الشائع لتعريف مشغّلات إضافة التقويم

تمثيل 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

نسخة من عنوان URL للشعار في الوضع الداكن
displayFlow
(deprecated)

enum (DisplayFlow)

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

ولاية

قائمة تعداد لتحديد حالة فتح الإضافة الأولية

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

DisplayFlow

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

عمليات التعداد
DISPLAY_FLOW_UNSPECIFIED لم يتم تحديد مسار العرض.
FOCUS يجب تشغيل الإضافة في مسار عرض "التركيز".
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

 لإلغاء تثبيت عملية نشر تجريبية من حساب المستخدم