Прежде чем вы сможете приступить к написанию своего первого клиентского приложения, вам необходимо сделать несколько вещей, если вы еще этого не сделали.
Создайте аккаунт Google и получите разрешения Search Ads 360.
Чтобы использовать API Search Ads 360, вам потребуется учетная запись Google и соответствующие разрешения, предоставленные этой учетной записи в Search Ads 360:
Если у вас еще нет учетной записи Google, создайте ее .
Попросите менеджера агентства Search Ads 360 создать пользователя Search Ads 360 для вашего аккаунта Google.
Чтобы скачать отчеты, вам потребуется разрешение на просмотр для рекламодателей, с которыми вы будете работать.
Чтобы добавлять или редактировать конверсии, вам потребуется разрешение на редактирование для рекламодателей, с которыми вы будете работать. В общей конфигурации Floodlight вам необходимо разрешение на редактирование для каждого дочернего рекламодателя, которому вы хотите загрузить конверсии. Вам не нужен доступ ни к родительскому рекламодателю, ни к дочерним рекламодателям, в которые вы не загружаете конверсии. Если вы используете идентификаторы кликов для соотнесения конверсий с посещениями , убедитесь, что у вас есть права на редактирование рекламодателя, создавшего идентификатор клика. Если вы укажете идентификатор клика от рекламодателя, к которому у вас нет прав на редактирование, запрос не будет выполнен.
Менеджер агентства может настроить вашу учетную запись как пользователя рекламодателя с доступом к определенным рекламодателям или настроить вашу учетную запись с более высоким уровнем доступа, например, как пользователя агентства с доступом ко всем рекламодателям в агентстве.
Активируйте службу преобразования API
Если вы хотите загрузить данные о конверсиях, пользователю Search Ads 360 с правами менеджера агентства необходимо войти в пользовательский интерфейс Search Ads 360 и активировать службу конвертации API . Инструкции можно найти в Справочном центре Search Ads 360 .
Создайте проект консоли Google API и учетные данные OAuth для вашего клиента.
- Запустите инструмент настройки консоли Google API.
Инструмент настройки поможет вам создать проект (или использовать существующий проект), включить API Search Ads 360 и создать учетные данные OAuth 2.0. - На странице Зарегистрируйте свое приложение выберите существующий проект или выберите Создать проект . Затем нажмите Продолжить .
- После того как консоль Google API включит API Search Ads 360, нажмите кнопку « Перейти к учетным данным» .
- На странице «Создать учетные данные» введите следующую информацию:
- Какой API вы используете? : API Поисковой рекламы 360.
- К каким данным вы будете иметь доступ? : Данные пользователя
- Нажмите кнопку Далее .
Инструмент настройки теперь предлагает помощь в создании идентификатора клиента OAuth 2.0 .
- Выполните остальные шаги в инструменте настройки.
Установите sa360Api.py.
Search Ads 360 предоставляет служебный скрипт, упрощающий процесс настройки авторизации. Вы также можете использовать этот сценарий для отправки и получения данных в формате JSON, если хотите попробовать отправлять и получать данные перед разработкой и написанием полноценного приложения. Вы можете скопировать многие примеры JSON с этого сайта документации и ввести их непосредственно в скрипт.
Чтобы установить скрипт:
- Установите Питон 2.7.
Скрипт не работает с Python 3.x. - Установите Curl .
- Загрузите sa360Api.zip .
- Извлеките
sa360Api.pyизsa360Api.zip. - Сделайте
sa360Api.pyисполняемым.
Изучите основы REST
Есть два способа вызвать API:
- Использование клиентских библиотек .
- Отправка HTTP-запросов и анализ ответов.
Если вы решите не использовать клиентские библиотеки, вам необходимо понять основы REST.
REST — это стиль архитектуры программного обеспечения, обеспечивающий удобный и последовательный подход к запросу и изменению данных.
Термин REST является сокращением от « Передача представительского состояния ». В контексте API Google это относится к использованию команд HTTP для получения и изменения представлений данных, хранящихся в Google.
В системе RESTful ресурсы хранятся в хранилище данных; клиент отправляет запрос на то, чтобы сервер выполнил определенное действие (например, создание, получение, обновление или удаление ресурса), а сервер выполняет действие и отправляет ответ, часто в форме представления указанного ресурса.
В API-интерфейсах RESTful 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 Search Ads 360
Операции Search Ads 360 API напрямую связаны с HTTP-глаголами REST.
Конкретный формат URI Search Ads 360 API:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
Полный набор URI, используемых для каждой поддерживаемой операции в API, обобщен в Справочнике по API .
Изучите основы JSON
Если вы используете REST, вам нужно будет использовать формат JSON для тела запроса. Вы можете указать, что ответы должны быть в формате JSON или CSV.
JSON (нотация объектов JavaScript) — это распространенный, независимый от языка формат данных, который обеспечивает простое текстовое представление произвольных структур данных. Для получения дополнительной информации посетите json.org .