JSON API пользовательского поиска: введение

Этот документ поможет вам ознакомиться с API пользовательского поиска в формате JSON и принципами его использования.

Прежде чем начать

Создать программируемую поисковую систему

Вызывая API, пользователь отправляет запросы к существующему экземпляру программируемой поисковой системы. Поэтому, прежде чем использовать API, необходимо создать его в панели управления . Следуйте инструкциям , чтобы узнать больше о различных параметрах конфигурации. После создания вы можете найти идентификатор поисковой системы в разделе «Основные параметры» на странице «Обзор» . Это параметр cx , используемый API.

Идентифицируйте свое приложение для Google с помощью ключа API.

Для использования API пользовательского поиска в формате JSON требуется ключ API. Ключ API — это способ идентификации вашего клиента для Google.

Получив ключ API, ваше приложение может добавлять параметр запроса key=yourAPIKey ко всем URL-адресам запросов. Ключ API безопасен для встраивания в URL-адреса, он не требует кодирования.

Обзор API

операции API

В API пользовательского поиска в формате JSON можно вызвать только один метод:

Операция	Описание	сопоставление REST HTTP
список	Возвращает запрошенные результаты поиска из программируемой поисковой системы.	GET

модель данных API

Результатом поискового запроса к API пользовательского поиска в формате JSON является объект JSON, содержащий три типа данных:

• Метаданные, описывающие запрошенный поиск (и, возможно, связанные поисковые запросы).
• Метаданные, описывающие программируемую поисковую систему
• Результаты поиска

Более подробную информацию см. в разделе «Данные ответа» руководства «Использование REST» .

Модель данных основана на спецификации OpenSearch 1.1. В дополнение к стандартным свойствам OpenSearch, API Custom Search JSON определяет два пользовательских свойства и две пользовательские роли запроса:

• Пользовательские свойства
  • cx : Идентификатор программируемой поисковой системы.
  • safe : Описание уровня безопасного поиска для фильтрации возвращаемых результатов.
• Роли пользовательских запросов
  • nextPage : Роль, указывающая, что запрос может быть использован для доступа к следующей логической странице результатов, если таковая имеется.
  • previousPage : Роль, указывающая, что запрос может быть использован для доступа к предыдущей логической странице результатов, если таковая имеется.

Попробуйте!

Чтобы поэкспериментировать и посмотреть, на что способен API, не написав ни строчки кода, воспользуйтесь инструментом "Попробовать этот API" .

Полное описание параметров см. в справочнике cse.list .

Чтобы узнать, как использовать API с помощью HTTP-запросов, перейдите к разделу «Использование REST» .