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