میانای برنامه‌سازی کاربردی Custom Search JSON: مقدمه

این سند به شما کمک می‌کند با «میانای برنامه‌سازی کاربردی Custom Search JSON» و کاربرد آن آشنا شوید.

قبل‌از شروع

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

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

شناسایی برنامه شما برای Google با کلید میانای برنامه‌سازی کاربردی

«میانای برنامه‌سازی کاربردی Custom Search JSON» به استفاده از کلید میانای برنامه‌سازی کاربردی نیاز دارد. کلید میانای برنامه‌سازی کاربردی روشی برای شناسایی کارخواه شما برای Google است.

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

نمای کلی میانای برنامه‌سازی کاربردی

عملیات میانای برنامه‌سازی کاربردی

فقط یک روش برای فراخوانی در «میانای برنامه‌سازی کاربردی Custom Search JSON» وجود دارد:

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

مدل داده میانای برنامه‌سازی کاربردی

نتیجه پُرسمان جستجو در «میانای برنامه‌سازی کاربردی Custom Search JSON» یک شیء JSON است که شامل سه نوع داده است:

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

برای جزئیات بیشتر، بخش «داده‌های پاسخ» در استفاده از REST را ببینید.

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

  • مشخصه‌های سفارشی
    • ‫cx: شناسه Programmable Search Engine.
    • safe: شرحی از سطح جستجوی ایمن برای فیلتر کردن نتایج برگردانده‌شده.
  • نقش‌های پرسمان سفارشی
    • nextPage: نقشی که نشان می‌دهد از پُرسمان می‌توان برای دسترسی به صفحه منطقی بعدی نتایج (درصورت وجود) استفاده کرد.
    • previousPage: نقشی که نشان می‌دهد از پُرسمان می‌توان برای دسترسی به صفحه منطقی قبلی نتایج (درصورت وجود) استفاده کرد.

امتحان کنید

برای امتحان کردن و دیدن کارهایی که API می‌تواند انجام دهد، بدون نوشتن هیچ کدی، به ابزار «امتحان کردن این API» مراجعه کنید.

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

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