تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
سيساعدك هذا المستند في الإلمام بواجهة Custom Search JSON API واستخدامها.
قبل البدء
إنشاء محرك بحث مبرمج
من خلال استدعاء واجهة برمجة التطبيقات التي يصدر عنها طلبات بشأن مثيل حالي من "محرك البحث المبرمَج".
لذلك، قبل استخدام واجهة برمجة التطبيقات، عليك إنشاء واجهة في لوحة التحكم
. اتّبِع البرنامج التعليمي
لمعرفة المزيد من المعلومات حول خيارات الضبط المختلفة.
وبعد إنشائه، يمكنك العثور على رقم تعريف محرك البحث في القسم أساسي من صفحة نظرة عامة. هذه هي المَعلمة cx التي تستخدمها واجهة برمجة التطبيقات.
تحديد تطبيقك لدى Google باستخدام مفتاح واجهة برمجة التطبيقات
تتطلب واجهة برمجة التطبيقات Custom Search JSON API استخدام مفتاح واجهة برمجة التطبيقات. يمثّل مفتاح واجهة برمجة التطبيقات طريقة تعرّف Google على عميلك.
بعد الحصول على مفتاح واجهة برمجة التطبيقات، يمكن لتطبيقك إلحاق معلَمة طلب البحث
key=yourAPIKey بجميع عناوين URL للطلبات. ويمكن تضمين مفتاح واجهة برمجة التطبيقات بأمان في عناوين URL،
ولا يحتاج إلى أي ترميز.
نظرة عامة على واجهة برمجة التطبيقات
عمليات واجهة برمجة التطبيقات
هناك طريقة واحدة فقط للاستدعاء في واجهة برمجة التطبيقات Custom Search JSON API:
تعرض نتائج البحث المطلوبة من "محرك البحث المبرمَج".
GET
نموذج بيانات واجهة برمجة التطبيقات
نتيجة طلب البحث لواجهة Custom Search JSON API هي كائن JSON يتضمن ثلاثة أنواع من البيانات:
البيانات الوصفية التي تصف البحث المطلوب (وربما طلبات البحث ذات الصلة)
البيانات الوصفية التي تصف "محرك البحث المبرمَج"
نتائج البحث
للحصول على مزيد من التفاصيل، راجِع قسم بيانات الاستجابة حول استخدام REST.
يستند نموذج البيانات إلى مواصفات OpenSearch 1.1. بالإضافة إلى خصائص OpenSearch العادية، تحدّد واجهة برمجة التطبيقات Custom Search JSON API خاصيتَين مخصّصتَين ودورَين مخصّصَين لطلب البحث:
الخصائص المخصّصة
cx: معرّف "محرك البحث المبرمَج"
safe: وصف لمستوى البحث الآمن لفلترة النتائج المعروضة.
الأدوار المخصّصة لطلبات البحث
nextPage: دور يشير إلى إمكانية استخدام طلب البحث للوصول إلى الصفحة المنطقية التالية من النتائج، إن توفّرت.
previousPage: دور يشير إلى إمكانية استخدام طلب البحث
للوصول إلى صفحة النتائج المنطقية السابقة، إن توفّرت.
تاريخ التعديل الأخير: 2025-08-31 (حسب التوقيت العالمي المتفَّق عليه)
[[["يسهُل فهم المحتوى.","easyToUnderstand","thumb-up"],["ساعَدني المحتوى في حلّ مشكلتي.","solvedMyProblem","thumb-up"],["غير ذلك","otherUp","thumb-up"]],[["لا يحتوي على المعلومات التي أحتاج إليها.","missingTheInformationINeed","thumb-down"],["الخطوات معقدة للغاية / كثيرة جدًا.","tooComplicatedTooManySteps","thumb-down"],["المحتوى قديم.","outOfDate","thumb-down"],["ثمة مشكلة في الترجمة.","translationIssue","thumb-down"],["مشكلة في العيّنات / التعليمات البرمجية","samplesCodeIssue","thumb-down"],["غير ذلك","otherDown","thumb-down"]],["تاريخ التعديل الأخير: 2025-08-31 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eThis guide introduces the Custom Search JSON API and provides instructions for its use.\u003c/p\u003e\n"],["\u003cp\u003eBefore using the API, you need to create a Programmable Search Engine and obtain an API key.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows you to retrieve search results from your Programmable Search Engine using a single \u003ccode\u003elist\u003c/code\u003e operation.\u003c/p\u003e\n"],["\u003cp\u003eThe API returns results in JSON format containing search metadata, engine details, and the search results themselves.\u003c/p\u003e\n"],["\u003cp\u003eYou can experiment with the API using the provided "Try this API" tool or learn more through detailed documentation and examples.\u003c/p\u003e\n"]]],[],null,["# Custom Search JSON API: Introduction\n\nThis document will help you to get familiar with Custom Search JSON API and its usage.\n\nBefore you start\n----------------\n\n### Create Programmable Search Engine\n\nBy calling the API user issues requests against an existing instance of\nProgrammable Search Engine.\nTherefore, before using the API, you need to create one in the\n[Control Panel](https://programmablesearchengine.google.com/controlpanel/create)\n. Follow the [tutorial](/custom-search/docs/tutorial/creatingcse)\nto learn more about different configuration options.\nOnce it is created, you can find the **Search Engine ID** in the **Overview**\npage's **Basic** section. This is the `cx` parameter used by the API.\n\n### Identify your application to Google with API key\n\nCustom Search JSON API requires the use of an API key. An API key is a way to identify your client to Google.\n\n- [Programmable Search Engine](https://cse.google.com/) (free edition) users: Get a Key\n\nAfter you have an API key, your application can append the query parameter\n`key=yourAPIKey` to all request URLs. The API key is safe for embedding in URLs,\nit doesn't need any encoding.\n\nAPI overview\n------------\n\n### API operations\n\nThere is only one method to invoke in the Custom Search JSON API:\n\n| Operation | Description | REST HTTP mapping |\n|------------------------------------------------------|-------------------------------------------------------------------------|-------------------|\n| [list](/custom-search/v1/reference/rest/v1/cse/list) | Returns the requested search results from a Programmable Search Engine. | `GET` |\n\n### API data model\n\nThe result of a search query to the Custom Search JSON API is a JSON object that includes three types of data:\n\n- Metadata describing the requested search (and, possibly, related search requests)\n- Metadata describing the Programmable Search Engine\n- Search results\n\nSee the Response data section of [Using REST](/custom-search/v1/using_rest#response_data) for more details.\n\nThe data model is based on the OpenSearch 1.1 Specification. In addition to the standard OpenSearch properties, the Custom Search JSON API defines two custom properties and two custom query roles:\n\n- Custom properties\n - `cx`: The identifier of the Programmable Search Engine.\n - `safe`: A description of the safe search level for filtering the returned results.\n- Custom query roles\n - `nextPage`: A role that indicates the query can be used to access the next logical page of results, if any.\n - `previousPage`: A role that indicates the query can be used to access the previous logical page of results, if any.\n\nTry it\n------\n\nTo play around and see what the API can do, without writing any code, visit the\n[\"Try this API\" tool](/custom-search/v1/reference/rest/v1/cse/list?apix=true).\n\nFor a full description of parameters visit the\n[cse.list reference](/custom-search/v1/reference/rest/v1/cse/list).\n\nTo learn how to use the API via HTTP requests, continue to\n[Using REST](/custom-search/v1/using_rest)."]]
