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)
  },
  "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"

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

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 القيمة التلقائية عند عدم ضبط أي إعدادات للوصول في وضع المسودة.
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)
  },
  "currentEventAccess": enum (EventAccess)
}
الحقول
homepageTrigger

object (HomepageExtensionPoint)

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

وفي حال توفّر هذه الإعدادات، سيتم إلغاء الإعدادات من addons.common.homepageTrigger.

conferenceSolution[]

object (ConferenceSolution)

تُحدِّد حلول مكالمات الفيديو التي توفّرها هذه الإضافة.

createSettingsUrlFunction

string

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

eventOpenTrigger

object (CalendarExtensionPoint)

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

eventUpdateTrigger

object (CalendarExtensionPoint)

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

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، أدخِل cases لمطابقة عناوين URL للحالات التي يستضيفها support.example.com/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.

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)
}
الحقول
authorizationHeader

enum (HttpAuthorizationHeader)

إعدادات الرمز المميّز الذي تم إرساله في عنوان تفويض HTTP

HttpAuthorizationHeader

تم إرسال رأس التفويض في طلبات الإضافة "HTTP".

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

الطُرق

create

ينشئ عملية نشر بالاسم والضبط المحدّدين.

delete

يؤدي هذا الإجراء إلى حذف عملية النشر بالاسم الذي تم إدخاله.

get

الحصول على عملية النشر بالاسم المحدَّد.

getInstallStatus

الحصول على حالة التثبيت للنشر التجريبي

install

تثبيت عملية نشر في حسابك للاختبار.

list

يسرد جميع عمليات النشر في مشروع معيّن.

replaceDeployment

لإنشاء عملية نشر أو استبدالها بالاسم المحدّد.

uninstall

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