Предпосылки,Предпосылки,Предпосылки

В этом документе описывается, что вы должны сделать перед написанием своего первого клиентского приложения.

Получите учетную запись Google

Вам нужна учетная запись Google , чтобы использовать этот API. У вашего аккаунта должно быть соответствующее разрешение Search Console для определенного ресурса, чтобы вызывать этот метод для этого ресурса. Например, чтобы запустить searchAnalytics.query, вам нужны права на чтение этого свойства.

Попробуйте Google Search Console

В этой документации по API предполагается, что вы использовали Google Search Console и знакомы с концепциями веб-программирования и форматами веб-данных.

Если вы еще не использовали Google Search Console, попробуйте пользовательский интерфейс, прежде чем приступать к написанию кода. Каждый API представляет собой функциональность отчета в Search Console. Вы должны прочитать документацию для эквивалентного отчета перед использованием API, чтобы понять данные, которые вы получаете.

Создайте проект и учетные данные для вашего клиента

Прежде чем вы сможете отправлять запросы в Google Search Console, вам необходимо сообщить Google о своем клиенте и активировать доступ к API. Вы делаете это, используя Google API Console для создания проекта , который представляет собой именованный набор настроек и информации о доступе к API, и регистрируете свое приложение.

Для всех API Search Console, кроме API инструментов тестирования, требуются учетные данные OAuth2. В кратких руководствах по Python и Java подробно описано, как создать проект и получить учетные данные для вашего клиента.

Понимание основ REST

Существует два способа вызова API:

Если вы решите не использовать клиентские библиотеки, вам необходимо понять основы 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 имеют уникальные доступные по HTTP URI, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной сетевой инфраструктурой.

Вы можете найти полезными определения методов в документации по стандартам HTTP 1.1; они включают спецификации для GET , POST , PUT и DELETE .

REST в API Google Search Console

Операции Google Search Console API напрямую сопоставляются с HTTP-командами REST.

Формат большинства URI API Google Search Console выглядит примерно так:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

Полный набор URI и глаголов, используемых для каждого метода, приведен в обзоре справочника API Google Search Console .

Понимание основ JSON

API Google Search Console возвращает данные в формате JSON.

JSON (нотация объектов JavaScript) — это распространенный независимый от языка формат данных, который обеспечивает простое текстовое представление произвольных структур данных. Для получения дополнительной информации см. json.org .