REST Resource: projects.deployments

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

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

string

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

object (AddOns)

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

string

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

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object (CommonAddOnManifest)

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

object (GmailAddOnManifest)

إعداد إضافة Gmail

object (DriveAddOnManifest)

إعداد إضافة Drive.

object (CalendarAddOnManifest)

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

object (DocsAddOnManifest)

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

object (SheetsAddOnManifest)

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

object (SlidesAddOnManifest)

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

object (HttpOptions)

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

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

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

string

مطلوب. تمثّل هذه السمة عنوان URL لصورة الشعار التي تظهر في شريط أدوات الإضافة.

object (LayoutProperties)

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

object (AddOnWidgetSet)

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

boolean

يمكنك اختيار ما إذا كان سيتم تمرير معلومات اللغة من التطبيق المضيف.

object (HomepageExtensionPoint)

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

object (UniversalActionExtensionPoint)

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

array (ListValue format)

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

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

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

string

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

boolean

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

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

قائمة التطبيقات المصغّرة المُستخدَمة في إحدى الإضافات

{
  "runFunction": string,
  "enabled": boolean
}

string

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

boolean

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

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

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

{
  "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.
}

string

مطلوب. نص مرئي للمستخدم يصف الإجراء الذي تم اتخاذه من خلال تفعيل نقطة الإضافة هذه، على سبيل المثال، "إضافة جهة اتصال جديدة".

string

عنوان URL الذي سيتم فتحه بواسطة UniversalAction.

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object (HomepageExtensionPoint)

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

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

object (ContextualTrigger)

يتم تحديد مجموعة الشروط التي تؤدي إلى تشغيل الإضافة.

object (UniversalAction)

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

object (ComposeTrigger)

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

string

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

{
  "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.
}

string

مطلوب. اسم نقطة النهاية المطلوب طلبها عندما تتطابق رسالة مع عامل التفعيل.

object (UnconditionalTrigger)

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

{
  "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.
}

string

مطلوب. نص مرئي للمستخدم يصف الإجراء، على سبيل المثال، "إضافة جهة اتصال جديدة".

string

هو رابط يفتحه Gmail عندما يشغّل المستخدم الإجراء.

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

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

string

مطلوب. نص مرئي للمستخدم يصف الإجراء الذي تم اتخاذه من خلال تفعيل نقطة الإضافة هذه. على سبيل المثال، "Insert invoice" (إدراج فاتورة).

string

تمثّل هذه السمة عنوان URL لصورة الشعار التي تظهر في شريط أدوات الإضافة.

إذا لم يتم ضبط السياسة، سيتم ضبطها تلقائيًا على عنوان URL الأساسي للشعار الإضافي.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (DriveExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

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

string

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

object (CalendarExtensionPoint)

يشير ذلك المصطلح إلى نقطة نهاية يتم تشغيلها عند فتح حدث بغرض عرضه أو تعديله.

object (CalendarExtensionPoint)

يشير ذلك المصطلح إلى نقطة نهاية يتم تشغيلها عند تعديل الحدث المفتوح.

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

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

string

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

string

مطلوب. الاسم المعروض لحلّ مكالمة الفيديو.

string

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

نقطة النهاية التي يتم تنفيذها عندما يتم منح تفويض نطاق الملف لهذا المستند/زوج المستخدم.

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

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

map (key: string, value: string)

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

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

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

object (UriPattern)

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

string

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

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

string

مطلوب لمعاينة كل نمط عنوان URL. نطاق نمط عنوان URL. تراجع الإضافة الروابط التي تحتوي على هذا النطاق في عنوان URL. لمعاينة الروابط لنطاق فرعي محدّد، مثل subdomain.example.com، يجب تضمين هذا النطاق الفرعي. لمعاينة الروابط للنطاق بالكامل، حدِّد حرف بدل مع علامة النجمة (*) كنطاق فرعي.

على سبيل المثال، تتطابق السمة *.example.com مع subdomain.example.com وanother.subdomain.example.com.

string

اختياريّ. المسار الذي يُلحق نطاق hostpattern.

على سبيل المثال، إذا كان نمط مضيف عنوان URL هو support.example.com، لمطابقة عناوين URL للحالات المُستضافة على support.example.com/cases/، أدخِل cases.

لمطابقة جميع عناوين URL في نطاق نمط المضيف، اترك pathprefix فارغًا.

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

مطلوب. المعرّف الفريد لتمييز نقطة الإضافة هذه. ويمكن أن يصل المعرّف إلى 64 حرفًا ويجب أن يكون بتنسيق [a-zA-Z0-9-]+.

string

مطلوب. النص الذي يتم عرضه بجانب رمز نقطة إدخال إنشاء المورد، مثل Create support case هذا النص ثابت ويتم عرضه قبل أن ينفِّذ المستخدمون الإضافة.

map (key: string, value: string)

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

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

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

string

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

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

نقطة النهاية التي يتم تنفيذها عندما يتم منح تفويض نطاق الملف لهذا المستند/زوج المستخدم.

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

نقطة النهاية التي يتم تنفيذها عندما يتم منح تفويض نطاق الملف لهذا المستند/زوج المستخدم.

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

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