Method: cse.list

ابرداده‌های مربوط به جستجوی انجام‌شده، ابرداده‌های مربوط به موتور مورد استفاده برای جستجو و نتایج جستجو را برمی‌گرداند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

مولفه های
c2coff

string

جستجوی ساده و سنتی چینی را فعال یا غیرفعال می کند.

مقدار پیش فرض این پارامتر 0 (صفر) است، به این معنی که ویژگی فعال است. مقادیر پشتیبانی شده عبارتند از:

  • 1 : غیر فعال

  • 0 : فعال (پیش فرض)

cr

string

نتایج جستجو را به اسنادی که از یک کشور خاص منشأ می گیرند محدود می کند. می توانید از عملگرهای بولی در مقدار پارامتر cr استفاده کنید.

جستجوی گوگل کشور یک سند را با تجزیه و تحلیل زیر مشخص می کند:

  • دامنه سطح بالای (TLD) URL سند

  • موقعیت جغرافیایی آدرس IP سرور وب

برای لیستی از مقادیر معتبر برای این پارامتر، صفحه مقادیر پارامتر کشور را ببینید.

cx

string

شناسه موتور جستجوی قابل برنامه ریزی برای استفاده برای این درخواست.

dateRestrict

string

نتایج را بر اساس تاریخ به URL ها محدود می کند. مقادیر پشتیبانی شده عبارتند از:

  • d[number] : درخواست‌ها از تعداد مشخص شده روزهای گذشته نتیجه می‌شوند.

  • w[number] : درخواست ها از تعداد مشخص شده هفته های گذشته نتیجه می گیرند.

  • m[number] : درخواست‌ها از تعداد مشخص شده ماه‌های گذشته نتیجه می‌شوند.

  • y[number] : درخواست‌ها از تعداد مشخص شده سال‌های گذشته نتیجه می‌شوند.

exactTerms

string

عبارتی را مشخص می کند که تمام اسناد در نتایج جستجو باید حاوی آن باشند.

excludeTerms

string

کلمه یا عبارتی را مشخص می کند که نباید در هیچ سندی در نتایج جستجو ظاهر شود.

fileType

string

نتایج را به فایل های یک پسوند مشخص محدود می کند. فهرستی از انواع فایل‌های قابل فهرست‌بندی توسط Google را می‌توانید در مرکز راهنمای کنسول جستجو پیدا کنید.

filter

string

روشن یا خاموش کردن فیلتر محتوای تکراری را کنترل می کند.

  • برای اطلاعات بیشتر درباره فیلترهای نتایج جستجوی 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" : فیلتر SafeSearch را فعال می کند.

  • "off" : فیلتر جستجوی ایمن را غیرفعال می کند. (پیش فرض)

searchType

enum ( SearchType )

نوع جستجو را مشخص می کند: image . اگر مشخص نباشد، نتایج به صفحات وب محدود می شود.

مقادیر قابل قبول عبارتند از:

  • "image" : جستجوی سفارشی تصویر.
siteSearchFilter

enum ( SiteSearchFilter )

شامل یا حذف نتایج از سایتی که در پارامتر siteSearch نامگذاری شده است را کنترل می کند.

مقادیر قابل قبول عبارتند از:

  • "e" : مستثنی کردن

  • "i" شامل می کنم

sort

string

عبارت مرتب سازی برای اعمال به نتایج. پارامتر مرتب سازی مشخص می کند که نتایج بر اساس عبارت مشخص شده یعنی مرتب سازی بر اساس تاریخ مرتب شوند. مثال: مرتب‌سازی=تاریخ .

start

integer ( uint32 format)

شاخص اولین نتیجه برای بازگشت. تعداد پیش فرض نتایج در هر صفحه 10 است، بنابراین &start=11 از بالای صفحه دوم نتایج شروع می شود. توجه : JSON API هرگز بیش از 100 نتیجه را برنمی‌گرداند، حتی اگر بیش از 100 سند با پرس و جو مطابقت داشته باشند، بنابراین تنظیم مجموع start + num روی عددی بیشتر از 100 باعث ایجاد خطا می‌شود. همچنین توجه داشته باشید که حداکثر مقدار برای num 10 است.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Search است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.