جستجوی سفارشی JSON API: مقدمه

این سند به شما کمک می کند تا با جستجوی سفارشی JSON API و کاربرد آن آشنا شوید.

قبل از اینکه تو شروع کنی

ایجاد موتور جستجوی قابل برنامه ریزی

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

برنامه خود را در Google با کلید API شناسایی کنید

جستجوی سفارشی JSON API به استفاده از کلید API نیاز دارد. کلید API راهی برای شناسایی مشتری شما در گوگل است.

پس از داشتن یک کلید API، برنامه شما می تواند پارامتر query key=yourAPIKey به همه URL های درخواستی اضافه کند. کلید API برای جاسازی در URL ها ایمن است و نیازی به رمزگذاری ندارد.

نمای کلی API

عملیات API

فقط یک روش برای فراخوانی در جستجوی سفارشی JSON API وجود دارد:

عمل شرح REST نقشه برداری HTTP
فهرست نتایج جستجوی درخواستی را از یک موتور جستجوی قابل برنامه ریزی برمی گرداند. GET

مدل داده های API

نتیجه جستجوی جستجوی سفارشی JSON API یک شی JSON است که شامل سه نوع داده است:

  • فراداده ای که جستجوی درخواستی را توصیف می کند (و احتمالاً درخواست های جستجوی مرتبط)
  • ابرداده که موتور جستجوی قابل برنامه ریزی را توصیف می کند
  • نتایج جستجو

برای جزئیات بیشتر به بخش پاسخ داده استفاده از REST مراجعه کنید.

مدل داده بر اساس مشخصات OpenSearch 1.1 است. علاوه بر ویژگی های OpenSearch استاندارد، Custom Search JSON API دو ویژگی سفارشی و دو نقش درخواست سفارشی را تعریف می کند:

  • خواص سفارشی
    • cx : شناسه موتور جستجوی قابل برنامه ریزی.
    • safe : شرحی از سطح جستجوی ایمن برای فیلتر کردن نتایج برگشتی.
  • نقش های پرس و جو سفارشی
    • nextPage : نقشی که پرس و جو را نشان می دهد می تواند برای دسترسی به صفحه منطقی بعدی نتایج، در صورت وجود، استفاده شود.
    • previousPage : نقشی که نشان دهنده پرس و جو است، می تواند برای دسترسی به صفحه منطقی قبلی نتایج، در صورت وجود، استفاده شود.

آن را امتحان کنید

برای بازی کردن و دیدن آنچه که API می تواند انجام دهد، بدون نوشتن هیچ کدی، از ابزار "Try this API" بازدید کنید.

برای توضیح کامل پارامترها به مرجع cse.list مراجعه کنید.

برای یادگیری نحوه استفاده از API از طریق درخواست‌های HTTP، به استفاده از REST ادامه دهید.