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

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

الإضافات

إعدادات إضافة على 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

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