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 القيمة التلقائية عند عدم ضبط أيّ قيمة لسمة 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

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

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

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

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