توفّر أداة البحث المصغّرة واجهة بحث قابلة للتخصيص لتطبيقات الويب. لا تتطلّب الأداة سوى جزء صغير من رمز HTML وجافا سكريبت لتنفيذها، وتتيح ميزات البحث الشائعة، مثل الفلاتر والتقسيم على صفحات. يمكنك أيضًا تخصيص أجزاء من الواجهة باستخدام CSS وJavaScript.
إذا كنت بحاجة إلى مرونة أكبر من تلك التي توفّرها الأداة، ننصحك باستخدام واجهة برمجة التطبيقات Query API. للحصول على معلومات حول إنشاء واجهة بحث باستخدام Query API، يُرجى الرجوع إلى إنشاء واجهة بحث باستخدام Query API.
إنشاء واجهة بحث
يتطلّب إنشاء واجهة البحث عدة خطوات:
- إعداد تطبيق بحث
- إنشاء معرّف عميل للتطبيق
- إضافة ترميز HTML لمربّع البحث والنتائج
- تحميل الأداة على الصفحة
- إعداد التطبيق المصغّر
إعداد تطبيق بحث
يجب أن تتضمّن كل واجهة بحث تطبيق بحث محدّدًا في وحدة تحكّم المشرف. يوفر تطبيق البحث معلومات إضافية لطلب البحث، مثل مصادر البيانات والواجهات وإعدادات جودة البحث.
لإنشاء تطبيق بحث، يُرجى الرجوع إلى مقالة إنشاء تجربة بحث مخصّصة.
إنشاء معرّف عميل للتطبيق
بالإضافة إلى الخطوات الواردة في ضبط إذن الوصول إلى Google Cloud Search API، عليك أيضًا إنشاء معرّف عميل لتطبيق الويب.
عند إعداد المشروع:
- اختَر نوع العميل متصفّح الويب
- قدِّم معرّف الموارد المنتظم (URI) الخاص بالمصدر لتطبيقك.
- ملاحظة حول معرّف العميل الذي تم إنشاؤه ستحتاج إلى معرّف العميل لإكمال الخطوات التالية. لا يلزم إدخال سر العميل للوحدة.
لمزيد من المعلومات، يُرجى الاطّلاع على بروتوكول OAuth 2.0 لتطبيقات الويب من جهة العميل.
إضافة ترميز HTML
يتطلّب التطبيق المصغّر قدرًا صغيرًا من HTML ليعمل. يجب تقديم ما يلي:
- عنصر
input
لمربّع البحث - تمثّل هذه السمة عنصرًا لتثبيت النافذة المنبثقة الخاصة بالاقتراح.
- عنصر لاحتواء نتائج البحث
- (اختياري) قدِّم عنصرًا يحتوي على عناصر التحكّم في عوامل التصفية المتعدّدة الأوجه.
يوضّح مقتطف HTML التالي رمز HTML الخاص بأداة بحث، حيث يتم تحديد العناصر التي سيتم ربطها من خلال سمة id
:
تحميل التطبيق المصغّر
يتم تحميل التطبيق المصغّر ديناميكيًا من خلال نص برمجي خاص بالتحميل. لتضمين أداة التحميل، استخدِم العلامة <script>
كما هو موضّح:
يجب تقديم onload
ردّ الاتصال في علامة البرنامج النصي. يتم استدعاء الدالة
عندما يكون برنامج التحميل جاهزًا. عندما يكون برنامج التحميل جاهزًا، واصِل تحميل الأداة عن طريق استدعاء gapi.load()
لتحميل عميل واجهة برمجة التطبيقات ووحدات "تسجيل الدخول باستخدام Google" وCloud Search.
يتم استدعاء الدالة initializeApp()
بعد تحميل جميع الوحدات.
إعداد التطبيق المصغّر
أولاً، عليك تهيئة مكتبة العميل من خلال استدعاء gapi.client.init()
أو gapi.auth2.init()
باستخدام معرّف العميل الذي تم إنشاؤه ونطاق https://www.googleapis.com/auth/cloud_search.query
. بعد ذلك، استخدِم الفئتين gapi.cloudsearch.widget.resultscontainer.Builder
وgapi.cloudsearch.widget.searchbox.Builder
لضبط الأداة وربطها بعناصر HTML.
يوضّح المثال التالي كيفية تهيئة الأداة:
يشير المثال أعلاه إلى متغيّرَين للإعدادات تم تعريفهما على النحو التالي:
تخصيص تجربة تسجيل الدخول
تطلب الأداة تلقائيًا من المستخدمين تسجيل الدخول والسماح للتطبيق عندما يبدأون بكتابة طلب بحث. يمكنك استخدام تسجيل الدخول باستخدام Google للمواقع الإلكترونية لتوفير تجربة تسجيل دخول أكثر تخصيصًا للمستخدمين.
منح الإذن للمستخدمين مباشرةً
استخدِم ميزة تسجيل الدخول باستخدام حساب Google لتتبُّع حالة تسجيل الدخول للمستخدمين وتسجيل دخولهم أو خروجهم حسب الحاجة. على سبيل المثال، يراقب المثال التالي حالة isSignedIn
لتتبُّع التغييرات في تسجيل الدخول، ويستخدم الطريقة GoogleAuth.signIn()
لبدء عملية تسجيل الدخول من خلال النقر على زر:
لمزيد من التفاصيل، يُرجى الاطّلاع على تسجيل الدخول باستخدام حساب Google.
تسجيل دخول المستخدمين تلقائيًا
يمكنك تبسيط تجربة تسجيل الدخول بشكل أكبر من خلال منح الإذن مسبقًا للتطبيق نيابةً عن المستخدمين في مؤسستك. تكون هذه الطريقة مفيدة أيضًا عند استخدام Cloud Identity Aware Proxy لحماية التطبيق.
لمزيد من المعلومات، يُرجى الاطّلاع على استخدام ميزة "تسجيل الدخول باستخدام Google" مع تطبيقات تكنولوجيا المعلومات.
تخصيص الواجهة
يمكنك تغيير مظهر واجهة البحث من خلال مجموعة من الأساليب:
- تجاوز الأنماط باستخدام CSS
- تزيين العناصر باستخدام محوّل
- إنشاء عناصر مخصّصة باستخدام أداة ربط
تجاوز الأنماط باستخدام CSS
تتضمّن أداة البحث CSS خاصًا بها لتصميم عناصر الاقتراحات والنتائج، بالإضافة إلى عناصر التحكّم في تقسيم الصفحات. يمكنك إعادة تصميم هذه العناصر حسب الحاجة.
أثناء التحميل، تحمّل أداة البحث تلقائيًا ورقة الأنماط التلقائية. يحدث ذلك بعد تحميل أوراق الأنماط الخاصة بالتطبيق، ما يؤدي إلى زيادة أولوية القواعد. لضمان أن تحظى أنماطك بالأولوية على الأنماط التلقائية، استخدِم محدّدات العناصر الأصلية لزيادة خصوصية القواعد التلقائية.
على سبيل المثال، لن يكون للقاعدة التالية أي تأثير إذا تم تحميلها في علامة link
أو style
ثابتة في المستند.
.cloudsearch_suggestion_container {
font-size: 14px;
}
بدلاً من ذلك، يجب تحديد القاعدة باستخدام المعرّف أو الفئة الخاصة بالحاوية الرئيسية المحدّدة في الصفحة.
#suggestions_anchor .cloudsearch_suggestion_container {
font-size: 14px;
}
للاطّلاع على قائمة بفئات الدعم وأمثلة على رمز HTML الذي تنتجه الأداة، يُرجى الرجوع إلى فئات CSS المتوافقة.
تزيين العناصر باستخدام محوّل
لتزيين عنصر قبل عرضه، أنشئ مسجّلاً
يستخدم إحدى طرق التزيين، مثل
decorateSuggestionElement
أو decorateSearchResultElement.
.
على سبيل المثال، تضيف المحوّلات التالية فئة مخصّصة إلى عناصر الاقتراحات والنتائج.
لتسجيل المحوّل عند تهيئة التطبيق المصغّر، استخدِم طريقة setAdapter()
الفئة Builder
المعنية:
قد تعدّل أدوات التزيين سمات العنصر الحاوي بالإضافة إلى أي عناصر فرعية. يمكن إضافة عناصر فرعية أو إزالتها أثناء عملية التزيين. ومع ذلك، إذا كنت ستجري تغييرات هيكلية على العناصر، ننصحك بإنشاء العناصر مباشرةً بدلاً من تزيينها.
إنشاء عناصر مخصّصة باستخدام أداة ربط
لإنشاء عنصر مخصّص لاقتراح أو حاوية لفئات البحث أو نتيجة بحث، أنشئ مسهّلاً وسجِّله، على أن ينفّذ
createSuggestionElement
أو
createFacetResultElement
أو
createSearchResultElement
على التوالي.
توضّح المحوّلات التالية كيفية إنشاء عناصر مخصّصة للاقتراحات ونتائج البحث باستخدام علامات <template>
في HTML.
لتسجيل المحوّل عند تهيئة الأداة، استخدِم طريقة setAdapter()
لفئة Builder
المعنية:
يخضع إنشاء عناصر مخصّصة للأوجه باستخدام createFacetResultElement
لعدة قيود:
- يجب إرفاق فئة CSS
cloudsearch_facet_bucket_clickable
بالعنصر الذي ينقر عليه المستخدمون لتفعيل أو إيقاف مجموعة. - يجب تضمين كل مجموعة في عنصر حاوٍ باستخدام فئة CSS
cloudsearch_facet_bucket_container
. - لا يمكنك عرض الحِزم بترتيب مختلف عن الترتيب الذي تظهر به في الردّ.
على سبيل المثال، تعرض المقتطفة التالية أوجهًا باستخدام الروابط بدلاً من مربّعات الاختيار.
تخصيص سلوك البحث
تمثّل إعدادات تطبيق البحث الإعداد التلقائي لواجهة البحث وهي ثابتة. لتنفيذ فلاتر أو واجهات ديناميكية، مثل السماح للمستخدمين بتبديل مصادر البيانات، يمكنك تجاهل إعدادات تطبيق البحث من خلال اعتراض طلب البحث باستخدام محوّل.
نفِّذ أداة ربط باستخدام الطريقة
interceptSearchRequest
لتعديل الطلبات المُرسَلة إلى
واجهة برمجة التطبيقات الخاصة بالبحث
قبل تنفيذها.
على سبيل المثال، يعترض المحوّل البرمجي التالي الطلبات لحصر الاستعلامات على مصدر يختاره المستخدم:
لتسجيل المحوّل عند تهيئة الأداة، استخدِم طريقة
setAdapter()
عند إنشاء ResultsContainer
.
يتم استخدام رمز HTML التالي لعرض مربّع اختيار للفلترة حسب المصادر:
تستمع التعليمة البرمجية التالية إلى التغيير، وتضبط التحديد، وتعيد تنفيذ طلب البحث إذا لزم الأمر.
يمكنك أيضًا اعتراض ردّ البحث من خلال تنفيذ
interceptSearchResponse
في المحوّل.
تثبيت إصدار واجهة برمجة التطبيقات
يستخدم التطبيق المصغّر تلقائيًا أحدث إصدار ثابت من واجهة برمجة التطبيقات. لإصدار
محدّد، اضبط مَعلمة الإعداد cloudsearch.config/apiVersion
على الإصدار المفضّل قبل بدء التطبيق المصغّر.
سيتم ضبط إصدار واجهة برمجة التطبيقات تلقائيًا على 1.0 في حال عدم ضبطه أو ضبطه على قيمة غير صالحة.
تثبيت إصدار التطبيق المصغّر
لتجنُّب حدوث تغييرات غير متوقّعة في واجهات البحث، اضبط مَعلمة الإعداد cloudsearch.config/clientVersion
على النحو التالي:
gapi.config.update('cloudsearch.config/clientVersion', 1.1);
سيتم ضبط إصدار الأداة على 1.0 تلقائيًا في حال عدم ضبطه أو ضبطه على قيمة غير صالحة.
تأمين واجهة البحث
تحتوي نتائج البحث على معلومات حساسة للغاية. اتّبِع أفضل الممارسات لتأمين تطبيقات الويب، لا سيما ضد هجمات النقر الخادع.
لمزيد من المعلومات، يمكنك الاطّلاع على مشروع دليل OWASP.
تفعيل تصحيح الأخطاء
استخدِم interceptSearchRequest
لتفعيل تصحيح الأخطاء في أداة البحث المصغّرة. على سبيل المثال:
if (!request.requestOptions) {
// Make sure requestOptions is populated
request.requestOptions = {};
}
// Enable debugging
request.requestOptions.debugOptions = {enableDebugging: true}
return request;