توضّح هذه الصفحة كيفية إنشاء إضافة Google Workspace تتيح لمستخدمي "مستندات Google" و"جداول بيانات Google" و"العروض التقديمية من Google" معاينة الروابط من خدمة تابعة لجهة خارجية.
يمكن لإضافة Google Workspace رصد روابط الخدمة ومطالبة المستخدمين بمعاينتها. يمكنك تهيئة إضافة لمعاينة أنماط عناوين URL متعددة، مثل الروابط المؤدية إلى طلبات الحصول على الدعم، وعملاء المبيعات المحتملين، والملفات الشخصية للموظفين.
كيف يعاين المستخدمون الروابط
لمعاينة الروابط، يتفاعل المستخدمون مع الشرائح الذكية والبطاقات.
عندما يكتب المستخدمون عنوان URL أو يلصقونه في مستند، يطلب "مستندات Google" منهم استبدال الرابط بشريحة ذكية. تعرض الشريحة الذكية رمزًا وعنوانًا قصيرًا أو وصفًا لمحتوى الرابط. عندما يمرر المستخدم مؤشر الماوس فوق الشريحة، تظهر له واجهة بطاقة تعرض مزيدًا من المعلومات حول الملف أو الرابط.
يعرض الفيديو التالي كيف يحوّل المستخدم رابطًا إلى شريحة ذكية ويعاين بطاقة:
كيفية معاينة المستخدمين للروابط في "جداول بيانات Google" و"العروض التقديمية من Google"
لا يمكن استخدام الشرائح الذكية التابعة لجهات خارجية لمعاينات الروابط في "جداول بيانات Google" و"العروض التقديمية من Google". عندما يكتب المستخدمون عنوان URL أو يلصقونه في جدول بيانات أو عرض تقديمي، تطلب منهم "جداول بيانات Google" أو "العروض التقديمية من Google" استبدال الرابط بعنوانه كنص مرتبط بدلاً من شريحة. عندما يمرر المستخدم فوق عنوان الرابط، يرى واجهة بطاقة تعرض معلومات حول الرابط.
توضح الصورة التالية كيفية عرض معاينة الرابط في "جداول البيانات" و"العروض التقديمية":
المتطلبات الأساسية
برمجة تطبيقات
- حساب على Google Workspace:
- إضافة Google Workspace: لإنشاء إضافة، اتبع quickstart هذا.
Node.js
- حساب على Google Workspace:
- إضافة Google Workspace: لإنشاء إضافة، اتبع quickstart هذا.
Python
- حساب على Google Workspace:
- إضافة Google Workspace: لإنشاء إضافة، اتبع quickstart هذا.
Java
- حساب على Google Workspace:
- إضافة Google Workspace: لإنشاء إضافة، اتبع quickstart هذا.
اختياري: إعداد المصادقة لخدمة تابعة لجهة خارجية
إذا كانت الإضافة متصلة بخدمة تتطلب إذنًا، على المستخدمين المصادقة على الخدمة لمعاينة الروابط. وهذا يعني أنّه عندما يلصق المستخدمون رابطًا من خدمتك في ملف في "مستندات Google" أو "جداول بيانات Google" أو "العروض التقديمية من Google" للمرة الأولى، يجب أن تستدعي الإضافة خطوات التفويض.
لإعداد خدمة OAuth أو طلب تفويض مخصص، يمكنك الاطّلاع على أحد الأدلة التالية:
إذا أنشأت الإضافة باستخدام "برمجة تطبيقات Google"، يُرجى الاطّلاع على الربط بخدمات غير تابعة لشركة Google من إضافة Google Workspace.
إذا أنشأت الإضافة باستخدام وقت تشغيل مختلف، راجِع ربط الإضافة بخدمة تابعة لجهة خارجية.
إعداد معاينات الروابط لإضافتك
يوضّح هذا القسم كيفية إعداد معاينات الروابط لإضافتك، والتي تتضمّن الخطوات التالية:
- تهيئة معاينات الروابط في ملف بيان أو مورد نشر الإضافة.
- أنشِئ الشريحة الذكية وواجهة البطاقة للروابط.
إعداد معاينات الروابط
لإعداد معاينات الروابط، حدِّد الأقسام والحقول التالية في مورد نشر الإضافة أو ملف بيانها:
- ضمن القسم
addOns
، أضِف الحقلdocs
لتوسيع "مستندات Google"، والحقلsheets
لتوسيع "جداول البيانات"، والحقلslides
لتوسيع "العروض التقديمية من Google". في كل حقل، نفِّذ المشغِّل
linkPreviewTriggers
الذي يشملrunFunction
(يمكنك تحديد هذه الدالة في القسم التالي، إنشاء الشريحة الذكية والبطاقة).للاطّلاع على الحقول التي يمكنك تحديدها في عامل التشغيل
linkPreviewTriggers
، راجِع المستندات المرجعية حول ملفات بيان برمجة التطبيقات أو موارد النشر لأوقات التشغيل الأخرى.في الحقل
oauthScopes
، أضِف النطاقhttps://www.googleapis.com/auth/workspace.linkpreview
حتى يتمكن المستخدمون من تفويض الإضافة لمعاينة الروابط نيابةً عنهم.
مثلاً، راجِع القسم oauthScopes
وaddons
لمورد النشر التالي الذي يضبط معاينات الروابط لخدمة حالة دعم.
{
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://www.example.com/images/company-logo.png",
"layoutProperties": {
"primaryColor": "#dd4b39"
}
},
"docs": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"logoUrl": "https://www.example.com/images/support-icon.png",
"localizedLabelText": {
"es": "Caso de soporte"
}
}
]
},
"sheets": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"logoUrl": "https://www.example.com/images/support-icon.png",
"localizedLabelText": {
"es": "Caso de soporte"
}
}
]
},
"slides": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"logoUrl": "https://www.example.com/images/support-icon.png",
"localizedLabelText": {
"es": "Caso de soporte"
}
}
]
}
}
}
في المثال، روابط معاينة إضافة Google Workspace لخدمة طلب الحصول على الدعم للشركة. تحدد الإضافة ثلاثة أنماط
لعنوان URL لمعاينة الروابط. وعندما يتطابق رابط مع أحد أنماط عناوين URL، تنشئ دالة معاودة الاتصال caseLinkPreview
بطاقة وشريحة ذكية وتعرضها، أو في "جداول بيانات Google"
و"العروض التقديمية من Google"، تستبدل عنوان URL بعنوان الرابط.
إنشاء الشريحة الذكية والبطاقة
لإرجاع شريحة ذكية وبطاقة لرابط ما، يجب تنفيذ أي وظائف حدّدتها في العنصر linkPreviewTriggers
.
عندما يتفاعل مستخدِم مع رابط يتطابق مع نمط عنوان URL محدّد، يتم تنشيط
مشغّل linkPreviewTriggers
وتمرّر وظيفة الاستدعاء المرتبطة به كائن الحدث
EDITOR_NAME.matchedUrl.url
كوسيطة. يمكنك استخدام
حمولة كائن الحدث هذا لإنشاء الشريحة الذكية والبطاقة
لمعاينة الرابط.
على سبيل المثال، إذا عاين مستخدم الرابط https://www.example.com/cases/123456
في "مستندات Google"،
يتم عرض حمولة الحدث التالية:
JSON
{ "docs": { "matchedUrl": { "url": "https://www.example.com/support/cases/123456" } } }
لإنشاء واجهة البطاقات، يمكنك استخدام التطبيقات المصغّرة لعرض معلومات حول الرابط. يمكنك أيضًا إنشاء إجراءات تسمح للمستخدمين بفتح الرابط أو تعديل محتواه. للحصول على قائمة بالأدوات والإجراءات المتاحة، راجع المكونات المتوافقة مع بطاقات المعاينة.
لإنشاء الشريحة الذكية والبطاقة لمعاينة رابط:
- نفِّذ الوظيفة التي حدّدتها في القسم
linkPreviewTriggers
من مورد نشر الإضافة أو ملف البيان:- يجب أن تقبل الدالة كائن حدث يحتوي على
EDITOR_NAME.matchedUrl.url
كوسيطة وتعرض كائنCard
واحدًا. - إذا كانت الخدمة تتطلب تفويضًا، يجب أن تتضمن الوظيفة أيضًا تدفق التفويض.
- يجب أن تقبل الدالة كائن حدث يحتوي على
- بالنسبة إلى كل بطاقة معاينة، نفِّذ أي وظائف لمعاودة الاتصال توفر تفاعلات أدوات للواجهة. على سبيل المثال، إذا قمت بتضمين زر مكتوب عليه "View link" (عرض الرابط)، يمكنك إنشاء إجراء يحدد وظيفة معاودة الاتصال لفتح الرابط في نافذة جديدة. لمزيد من المعلومات حول تفاعلات الأدوات، راجع إجراءات الإضافات.
يُنشئ الرمز التالي دالة رد الاتصال caseLinkPreview
لـ "مستندات Google":
برمجة تطبيقات
Node.js
Python
Java
المكوّنات المتوافقة لبطاقات المعاينة
تتيح إضافات Google Workspace استخدام التطبيقات المصغّرة والإجراءات التالية لبطاقات معاينة الروابط:
برمجة تطبيقات
حقل "خدمة البطاقات" | النوع |
---|---|
TextParagraph |
تطبيق مصغّر |
DecoratedText |
تطبيق مصغّر |
Image |
تطبيق مصغّر |
IconImage |
تطبيق مصغّر |
ButtonSet |
تطبيق مصغّر |
TextButton |
تطبيق مصغّر |
ImageButton |
تطبيق مصغّر |
Grid |
تطبيق مصغّر |
Divider |
تطبيق مصغّر |
OpenLink |
الإجراء |
Navigation |
الإجراء لا يتوفر سوى طريقة updateCard . |
JSON
حقل البطاقة (google.apps.card.v1 ) |
النوع |
---|---|
TextParagraph |
تطبيق مصغّر |
DecoratedText |
تطبيق مصغّر |
Image |
تطبيق مصغّر |
Icon |
تطبيق مصغّر |
ButtonList |
تطبيق مصغّر |
Button |
تطبيق مصغّر |
Grid |
تطبيق مصغّر |
Divider |
تطبيق مصغّر |
OpenLink |
الإجراء |
Navigation |
الإجراء الإجراء updateCard متاح فقط. |
مثال كامل: إضافة طلب الحصول على الدعم
يعرض المثال التالي "إضافة في Google Workspace" لمعاينة الروابط المؤدية إلى طلبات الحصول على الدعم لإحدى الشركات في "مستندات Google".
يؤدي المثال إلى ما يلي:
- معاينة روابط طلبات الحصول على الدعم، مثل
https://www.example.com/support/cases/1234
تعرض الشريحة الذكية رمز دعم، وتتضمّن بطاقة المعاينة رقم تعريف الطلب ووصفًا. - في حال ضبط لغة المستخدم على الإسبانية، ستترجم الشريحة الذكية
labelText
إلى اللغة الإسبانية.
مورد النشر
برمجة تطبيقات
JSON
{
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png",
"layoutProperties": {
"primaryColor": "#dd4b39"
}
},
"docs": {
"linkPreviewTriggers": [
{
"runFunction": "URL",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"localizedLabelText": {
"es": "Caso de soporte"
},
"logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png"
}
]
}
}
}
الرمز
برمجة تطبيقات
Node.js
Python
Java
مراجع ذات صلة
- معاينة الروابط من "كتب Google" باستخدام الشرائح الذكية
- اختبار الإضافة
- مرجع نشر "مستندات Google"
- واجهات البطاقات لمعاينات الروابط