Method: cse.list

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

طلب HTTP

GET https://customsearch.googleapis.com/customsearch/v1

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

معلمات طلب البحث

المَعلمات
c2coff

string

لتفعيل ميزة البحث باللغة الصينية المبسّطة والتقليدية أو إيقافها.

القيمة التلقائية لهذه المَعلمة هي 0 (صفر)، ما يعني أنّ هذه الميزة مفعَّلة. القيمتان المسموح بإدراجهما هما:

  • 1: غير مفعّل

  • 0: مفعَّل (تلقائي)
cr

string

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

يحدّد "بحث Google" البلد الوارد في المستند من خلال تحليل ما يلي:

  • نطاق المستوى الأعلى (TLD) لعنوان URL الخاص بالمستند

  • الموقع الجغرافي لعنوان IP لخادم الويب

يُرجى الاطّلاع على صفحة قيم مَعلمة البلد للحصول على قائمة بالقيم الصالحة لهذه المَعلمة.
cx

string

رقم تعريف محرك البحث المبرمَج المطلوب استخدامه لهذا الطلب.
dateRestrict

string

لقصر النتائج على عناوين URL استنادًا إلى التاريخ. وتشمل القيم المسموح بها ما يلي:

  • d[number]: يطلب نتائج من العدد المحدد للأيام الماضية.

  • w[number]: يطلب نتائج من العدد المحدّد من الأسابيع الماضية.

  • m[number]: يطلب نتائج من العدد المحدد من الأشهر الماضية.

  • y[number]: يطلب نتائج من العدد المحدّد من السنوات الماضية.
exactTerms

string

تحدد العبارة التي يجب أن تحتوي عليها جميع المستندات في نتائج البحث.
excludeTerms

string

يحدّد كلمة أو عبارة يجب ألا تظهر في أي مستندات ضمن نتائج البحث.
fileType

string

لقصر النتائج على ملفات بامتداد محدَّد. يمكن العثور على قائمة بأنواع الملفات التي يمكن لمحرّك بحث Google فهرستها في مركز المساعدة في Search Console.
filter

string

تتحكّم هذه السياسة في تفعيل فلتر المحتوى المكرّر أو إيقافه.

  • يمكنك الاطّلاع على الفلترة التلقائية للحصول على مزيد من المعلومات حول فلاتر نتائج بحث Google. تجدر الإشارة إلى أنّ فلترة ازدحام المضيف لا تنطبق إلا على عمليات البحث في المواقع الإلكترونية المتعدّدة.

  • يطبّق محرّك بحث Google تلقائيًا الفلترة على جميع نتائج البحث لتحسين جودة تلك النتائج.

القيم المقبولة هي:

  • 0: يتم إيقاف فلتر المحتوى المكرّر.

  • 1: تفعيل فلتر المحتوى المكرّر.
gl

string

الموقع الجغرافي للمستخدم النهائي.

  • وتتكوّن قيمة المَعلمة gl من رمز بلد مكوّن من حرفَين. تعمل المَعلمة gl على تحسين نتائج البحث التي يتطابق بلد مصدرها مع قيمة المَعلمة. يُرجى الاطّلاع على صفحة رموز البلدان للحصول على قائمة بالقيم الصالحة.

  • من المفترض أن يؤدي تحديد قيمة معلَمة gl إلى نتائج أكثر صلة. وينطبق هذا خصوصًا على العملاء الدوليين، لا سيّما العملاء في البلدان الناطقة بالإنجليزية غير الولايات المتحدة.
googlehost

string

تمت إزالة هذا العمود. ويمكنك استخدام المَعلمة gl للحصول على تأثير مماثل.

نطاق Google المحلي (على سبيل المثال، google.com أو google.de أو google.fr) المطلوب استخدامه لإجراء البحث.
highRange

string

تحدِّد قيمة النهاية لنطاق البحث.

  • استخدِم lowRange وhighRange لإلحاق نطاق بحث شامل بقيمة lowRange...highRange بطلب البحث.
hl

string

يضبط هذا الخيار لغة واجهة المستخدم.
hq

string

لإلحاق عبارات طلب البحث المحدّدة بطلب البحث، كما لو تم دمجها مع عامل تشغيل AND المنطقي.
imgColorType

enum (ImgColorType)

عرض صور بالأبيض والأسود أو تدرّج الرمادي أو الشفاف أو الألوان. القيم المقبولة هي:

  • "color"

  • "gray"

  • "mono": أبيض وأسود

  • "trans": خلفية شفافة
imgDominantColor

enum (ImgDominantColor)

لعرض صور لون سائد معيّن. القيم المقبولة هي:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"
imgSize

enum (ImgSize)

لعرض صور بحجم محدد. القيم المقبولة هي:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"
imgType

enum (ImgType)

لعرض صور من نوع معيّن. القيم المقبولة هي:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"
lowRange

string

تحدِّد هذه السياسة قيمة البداية لنطاق بحث. استخدِم lowRange وhighRange لإلحاق نطاق بحث شامل بقيمة lowRange...highRange بطلب البحث.
lr

string

يقصر البحث على المستندات المكتوبة بلغة معينة (على سبيل المثال، lr=lang_ja).

القيم المقبولة هي:

  • "lang_ar": العربية

  • "lang_bg": البلغارية

  • "lang_ca": الكتالانية

  • "lang_cs": التشيكية

  • "lang_da": الدانمركية

  • "lang_de": الألمانية

  • "lang_el": اليونانية

  • "lang_en": الإنجليزية

  • "lang_es": الإسبانية

  • "lang_et": الإستونية

  • "lang_fi": الفنلندية

  • "lang_fr": الفرنسية

  • "lang_hr": الكرواتية

  • "lang_hu": الهنغارية

  • "lang_id": الإندونيسية

  • "lang_is": الأيسلندية

  • "lang_it": الإيطالية

  • "lang_iw": العبرية

  • "lang_ja": اليابانية

  • "lang_ko": الكورية

  • "lang_lt": الليتوانية

  • "lang_lv": اللاتفية

  • "lang_nl": الهولندية

  • "lang_no": النرويجية

  • "lang_pl": البولندية

  • "lang_pt": البرتغالية

  • "lang_ro": الرومانية

  • "lang_ru": الروسية

  • "lang_sk": السلوفاكية

  • "lang_sl": السلوفينية

  • "lang_sr": الصربية

  • "lang_sv": السويدية

  • "lang_tr": التركية

  • "lang_zh-CN": الصينية (المبسّطة)

  • "lang_zh-TW": الصينية (التقليدية)
num

integer

عدد نتائج البحث المراد عرضها.

  • القيم الصالحة هي أعداد صحيحة بين 1 و10، بشكلٍ شامل.
orTerms

string

لتقديم عبارات بحث إضافية للتحقق منها في المستند، حيث يجب أن يحتوي كل مستند في نتائج البحث على عبارة واحدة على الأقل من عبارات البحث الإضافية.
q

string

طلب
relatedSite
(deprecated)

string

تمّ الإيقاف.
rights

string

الفلاتر المستندة إلى الترخيص وتشمل القيم المسموح بها ما يلي: cc_publicdomain وcc_attribute وcc_sharealike وcc_noncommercial وcc_nonderived ومجموعة من هذه القيم. اطّلِع على التركيبات النموذجية.
safe

enum (Safe)

مستوى أمان البحث القيم المقبولة هي:

  • "active": تفعيل فلترة "البحث الآمن".

  • "off": لإيقاف الفلترة في ميزة "البحث الآمن". (التلقائية)
searchType

enum (SearchType)

لتحديد نوع البحث: image. وفي حال عدم تحديد ذلك، ستقتصر النتائج على صفحات الويب.

القيم المقبولة هي:

  • "image": بحث صور مخصّص
siteSearchFilter

enum (SiteSearchFilter)

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

القيم المقبولة هي:

  • "e": استبعاد

  • "i": تضمين
sort

string

تعبير الفرز المراد تطبيقه على النتائج. تحدد المعلمة sort أن النتائج سيتم فرزها وفقًا للتعبير المحدد، أي ترتيبها حسب التاريخ. مثال: sort=date
start

integer (uint32 format)

فهرس أول نتيجة يتم عرضها. العدد التلقائي للنتائج لكل صفحة هو 10 نتائج، لذا سيبدأ &start=11 في أعلى الصفحة الثانية من النتائج. ملاحظة: لن تعرض واجهة برمجة تطبيقات JSON أكثر من 100 نتيجة مطلقًا، حتى إذا تطابق أكثر من 100 مستند مع طلب البحث، وبالتالي سيؤدي ضبط مجموع start + num على رقم أكبر من 100 إلى حدوث خطأ. تجدر الإشارة أيضًا إلى أنّ الحدّ الأقصى لقيمة num هو 10.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Search.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cse

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.