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