В этом документе описывается, что вам следует сделать перед написанием своего первого клиентского приложения.
Получить аккаунт Google
Для использования этого API вам понадобится учетная запись Google . Ваша учетная запись должна иметь соответствующее разрешение Search Console для определенного ресурса, чтобы вызывать этот метод для этого ресурса. Например, чтобы запустить searchAnalytics.query, вам необходимы права на чтение этого свойства.
Попробуйте консоль поиска Google
В этой документации по API предполагается, что вы использовали консоль поиска Google и знакомы с концепциями веб-программирования и форматами веб-данных.
Если вы еще не использовали консоль поиска Google, опробуйте пользовательский интерфейс , прежде чем начинать писать код. Каждый API представляет собой функциональность отчета в Search Console. Прежде чем использовать API, вам следует прочитать документацию по эквивалентному отчету, чтобы понять получаемые вами данные.
Создайте проект и учетные данные для вашего клиента
Прежде чем вы сможете отправлять запросы в Google Search Console, вам необходимо сообщить Google о своем клиенте и активировать доступ к API. Вы делаете это с помощью консоли Google API, чтобы создать проект , который представляет собой именованную коллекцию настроек и информации о доступе к API, и зарегистрировать свое приложение.
Для всех API консоли поиска, кроме API инструментов тестирования, требуются учетные данные OAuth2. Краткое руководство по Python и Java содержит подробную информацию о том, как создать проект и получить учетные данные для вашего клиента.
Понимание основ REST
Есть два способа вызвать API:
- Отправка HTTP-запросов и анализ ответов.
- Использование клиентских библиотек .
Если вы решите не использовать клиентские библиотеки, вам необходимо понять основы REST.
Основы REST
REST — это стиль архитектуры программного обеспечения, обеспечивающий удобный и последовательный подход к запросу и изменению данных.
Термин REST является сокращением от « Передача представительского состояния ». В контексте API Google это относится к использованию команд HTTP для получения и изменения представлений данных, хранящихся в Google.
В системе RESTful ресурсы хранятся в хранилище данных; клиент отправляет запрос на то, чтобы сервер выполнил определенное действие (например, создание, получение, обновление или удаление ресурса), а сервер выполняет действие и отправляет ответ, часто в форме представления указанного ресурса.
В RESTful API Google клиент указывает действие, используя HTTP-команду, например POST , GET , PUT или DELETE . Он определяет ресурс с помощью глобально уникального URI следующей формы:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Поскольку все ресурсы API имеют уникальные URI, доступные по HTTP, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной инфраструктурой Интернета.
Определения методов в документации по стандартам HTTP 1.1 могут оказаться полезными; они включают спецификации для GET , POST , PUT и DELETE .
REST в API консоли поиска Google
Операции API консоли поиска Google напрямую связаны с HTTP-глаголами REST.
Формат большинства URI API консоли поиска Google примерно такой:
VERB https://www.googleapis.com/webmasters/v3/resourcePath ?parameters
Полный набор URI и команд, используемых для каждого метода, приведен в справочном обзоре API консоли поиска Google .
Понимание основ JSON
API консоли поиска Google возвращает данные в формате JSON.
JSON (нотация объектов JavaScript) — это распространенный, независимый от языка формат данных, который обеспечивает простое текстовое представление произвольных структур данных. Для получения дополнительной информации посетите json.org .