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

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

قبل از شروع

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

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

اپلیکیشن خود را با کلید API به گوگل معرفی کنید

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

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

مرور کلی API

عملیات API

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

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

مدل داده API

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

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

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

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

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

امتحانش کن

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

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

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

،

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

قبل از شروع

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

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

اپلیکیشن خود را با کلید API به گوگل معرفی کنید

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

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

مرور کلی API

عملیات API

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

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

مدل داده API

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

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

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

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

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

امتحانش کن

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

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

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

،

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

قبل از شروع

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

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

اپلیکیشن خود را با کلید API به گوگل معرفی کنید

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

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

مرور کلی API

عملیات API

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

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

مدل داده API

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

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

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

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

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

امتحانش کن

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

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

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

،

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

قبل از شروع

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

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

اپلیکیشن خود را با کلید API به گوگل معرفی کنید

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

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

مرور کلی API

عملیات API

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

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

مدل داده API

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

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

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

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

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

امتحانش کن

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

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

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