تعرض البيانات الوصفية حول عملية البحث التي تم إجراؤها وبيانات وصفية حول المحرك المستخدم في عملية البحث، بالإضافة إلى نتائج البحث. تستخدم مجموعة صغيرة من أنماط عناوين URL.
طلب HTTP
GET https://customsearch.googleapis.com/customsearch/v1/siterestrict
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
معلمات طلب البحث
المَعلمات | |
---|---|
c2coff |
لتفعيل ميزة البحث باللغة الصينية المبسّطة والتقليدية أو إيقافها. القيمة التلقائية لهذه المَعلمة هي 0 (صفر)، ما يعني أنّ هذه الميزة مفعَّلة. القيمتان المسموح بإدراجهما هما:
|
cr |
لقصر نتائج البحث على المستندات التي تم إنشاؤها في بلد معيّن. يمكنك استخدام عوامل التشغيل المنطقية في قيمة المَعلمة cr. يحدّد "بحث Google" البلد الوارد في المستند من خلال تحليل ما يلي:
يُرجى الاطّلاع على صفحة قيم مَعلمة البلد للحصول على قائمة بالقيم الصالحة لهذه المَعلمة. |
cx |
رقم تعريف محرك البحث المبرمَج المطلوب استخدامه لهذا الطلب. |
dateRestrict |
لقصر النتائج على عناوين URL استنادًا إلى التاريخ. وتشمل القيم المسموح بها ما يلي:
|
exactTerms |
تحدد العبارة التي يجب أن تحتوي عليها جميع المستندات في نتائج البحث. |
excludeTerms |
يحدّد كلمة أو عبارة يجب ألا تظهر في أي مستندات ضمن نتائج البحث. |
fileType |
لقصر النتائج على ملفات بامتداد محدَّد. يمكن العثور على قائمة بأنواع الملفات التي يمكن لمحرّك بحث Google فهرستها في مركز المساعدة في Search Console. |
filter |
تتحكّم هذه السياسة في تفعيل فلتر المحتوى المكرّر أو إيقافه.
القيم المقبولة هي:
|
gl |
الموقع الجغرافي للمستخدم النهائي.
|
googlehost |
تمت إزالة هذا العمود. ويمكنك استخدام المَعلمة نطاق Google المحلي (على سبيل المثال، google.com أو google.de أو google.fr) المطلوب استخدامه لإجراء البحث. |
highRange |
تحدِّد قيمة النهاية لنطاق البحث.
|
hl |
يضبط هذا الخيار لغة واجهة المستخدم.
|
hq |
لإلحاق عبارات طلب البحث المحدّدة بطلب البحث، كما لو تم دمجها مع عامل تشغيل AND المنطقي. |
imgColorType |
عرض صور بالأبيض والأسود أو تدرّج الرمادي أو الشفاف أو الألوان. القيم المقبولة هي:
|
imgDominantColor |
لعرض صور لون سائد معيّن. القيم المقبولة هي:
|
imgSize |
لعرض صور بحجم محدد. القيم المقبولة هي:
|
imgType |
لعرض صور من نوع معيّن. القيم المقبولة هي:
|
linkSite |
لتحديد أن جميع نتائج البحث يجب أن تتضمن رابطًا إلى عنوان URL معين. |
lowRange |
تحدِّد هذه السياسة قيمة البداية لنطاق بحث. استخدِم |
lr |
يقصر البحث على المستندات المكتوبة بلغة معينة (على سبيل المثال، القيم المقبولة هي:
|
num |
عدد نتائج البحث المراد عرضها.
|
orTerms |
لتقديم عبارات بحث إضافية للتحقق منها في المستند، حيث يجب أن يحتوي كل مستند في نتائج البحث على عبارة واحدة على الأقل من عبارات البحث الإضافية. |
q |
طلب |
relatedSite |
تمّ الإيقاف. |
rights |
الفلاتر المستندة إلى الترخيص وتشمل القيم المسموح بها ما يلي: |
safe |
مستوى أمان البحث القيم المقبولة هي:
|
searchType |
لتحديد نوع البحث: القيم المقبولة هي:
|
siteSearch |
تحدِّد هذه السياسة موقعًا إلكترونيًا معيّنًا يجب دائمًا تضمينه أو استبعاده من النتائج (اطّلِع على المَعلمة |
siteSearchFilter |
تتحكّم هذه السياسة في ما إذا كان سيتم تضمين أو استبعاد النتائج من الموقع الإلكتروني المذكور في المعلَمة القيم المقبولة هي:
|
sort |
تعبير الفرز المراد تطبيقه على النتائج. تحدد المعلمة sort أن النتائج سيتم فرزها وفقًا للتعبير المحدد، أي ترتيبها حسب التاريخ. مثال: sort=date |
start |
فهرس أول نتيجة يتم عرضها. العدد التلقائي للنتائج لكل صفحة هو 10 نتائج، لذا سيبدأ |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Search
.
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/cse
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.