Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Этот документ поможет вам ознакомиться с JSON API пользовательского поиска и его использованием.
Прежде чем ты начнешь
Создать программируемую поисковую систему
Вызывая API, пользователь отправляет запросы к существующему экземпляру программируемой поисковой системы. Поэтому, прежде чем использовать API, вам необходимо создать его в Панели управления . Следуйте инструкциям , чтобы узнать больше о различных вариантах конфигурации. После создания идентификатор поисковой системы можно найти в разделе «Основные» на странице «Обзор» . Это параметр cx , используемый API.
Идентифицируйте свое приложение в Google с помощью ключа API
API JSON пользовательского поиска требует использования ключа API. Ключ API – это способ идентифицировать вашего клиента в Google.
После того как у вас есть ключ API, ваше приложение может добавить параметр запроса key=yourAPIKey ко всем URL-адресам запроса. Ключ API безопасен для встраивания в URL-адреса, он не требует кодирования.
Обзор API
Операции API
В JSON API пользовательского поиска можно вызвать только один метод:
Возвращает запрошенные результаты поиска из программируемой поисковой системы.
GET
Модель данных API
Результатом поискового запроса к JSON API пользовательского поиска является объект JSON, который включает в себя три типа данных:
Метаданные, описывающие запрошенный поиск (и, возможно, связанные поисковые запросы)
Метаданные, описывающие программируемую поисковую систему
Результаты поиска
Дополнительные сведения см. в разделе «Данные ответа» статьи «Использование REST» .
Модель данных основана на спецификации OpenSearch 1.1. В дополнение к стандартным свойствам OpenSearch API JSON пользовательского поиска определяет два настраиваемых свойства и две роли настраиваемых запросов:
Пользовательские свойства
cx : идентификатор программируемой поисковой системы.
safe : описание безопасного уровня поиска для фильтрации возвращаемых результатов.
Пользовательские роли запросов
nextPage : роль, указывающая, что запрос может использоваться для доступа к следующей логической странице результатов, если таковая имеется.
previousPage : роль, указывающая, что запрос может использоваться для доступа к предыдущей логической странице результатов, если таковая имеется.
[[["Прост для понимания","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-29 UTC."],[[["\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)."]]
