Начало работы

Мы рекомендуем использовать клиентскую библиотеку с Apache Maven (или Gradle).

Создайте новый проект Maven/Gradle.

Создайте новый проект Maven/Gradle в выбранной вами IDE. Наши артефакты публикуются в центральном репозитории Maven .

Зависимость Maven:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>33.0.0</version>
</dependency>

Зависимость Gradle:

implementation 'com.google.api-ads:google-ads:33.0.0'

Вы также можете собрать из исходного кода . Для целей данного руководства предполагается, что у вас есть настройка проекта с доступными необходимыми зависимостями.

Получите учетные данные для аутентификации с помощью API

Для доступа к Google Ads API требуются учетные данные OAuth и токен разработчика Google Ads API. В этом разделе объясняется, что это такое, как они используются и как их получить.

Токен разработчика (для доступа к API)

Токен разработчика связан с управляющим аккаунтом, и его можно найти в веб-интерфейсе Google Рекламы .

Хотя токен разработчика связан с управляющим аккаунтом, он не обеспечивает доступ к этому аккаунту. Вместо этого токен разработчика предоставляет доступ к API в целом, а доступ на уровне учетной записи настраивается через OAuth.

Учетные данные OAuth (для доступа к аккаунтам Google Рекламы)

Чтобы авторизовать пользователей учетной записи Google с доступом к учетным записям Google Рекламы, вам необходимо предоставить набор учетных данных OAuth.

Обычно используются два потока OAuth: настольное (установленное) приложение или веб-приложение. Основное различие между ними заключается в том, что настольные приложения должны открывать системный браузер и предоставлять локальный URI перенаправления для обработки ответов от сервера авторизации Google, тогда как веб-приложения могут перенаправлять произвольный сторонний браузер для завершения авторизации и отправки учетных данных обратно на ваш компьютер. сервер. Библиотека также поддерживает менее часто используемый поток учетных записей служб.

Если вы авторизуетесь, используя свои собственные учетные данные (поток приложения для настольного компьютера)
См . порядок действий в настольном приложении OAuth . Сюда входят все данные, необходимые для авторизации с использованием ваших учетных данных.
Если вы авторизуетесь как сторонний пользователь Google (веб-поток)
См . порядок действий веб-приложения OAuth . Это пример настройки авторизации OAuth для произвольных сторонних пользователей.
Если вы авторизуетесь как пользователь домена Google Apps (поток учетной записи службы)
См. порядок действий с учетной записью службы OAuth . Здесь приведен пример настройки авторизации OAuth для пользователей домена Google Apps.

Если вы получаете доступ к учетной записи клиента Google Рекламы через управляющий аккаунт Google Рекламы, вам также необходимо указать идентификатор клиента для входа, как описано ниже.

Идентификатор клиента для входа (для доступа к аккаунтам Google Рекламы через управляющий аккаунт)

При необходимости укажите идентификатор клиента управляющего аккаунта, который предоставляет доступ к обслуживающему аккаунту. Это необходимо указать, если ваш доступ к учетной записи клиента осуществляется через управляющую учетную запись. Нет необходимости указывать все управляющие аккаунты на пути к идентификатору клиента, достаточно указать самый верхний идентификатор менеджера, который вы используете для разрешений доступа. Более подробную информацию смотрите в соответствующей документации .

Настройте клиентскую библиотеку, используя свои учетные данные

Клиентскую библиотеку можно настроить с помощью файла конфигурации, переменных среды или программно. В этом руководстве мы будем использовать подход с использованием файла конфигурации и сосредоточимся на процессах рабочего стола и веб-интерфейса. Использование файла конфигурации, как правило, является хорошим подходом, если у вас есть только один набор учетных данных (например, вы управляете учетными записями под одним менеджером).

Создайте файл ~/ads.properties со следующим содержимым:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE

Замените заполнители своими учетными данными, полученными на предыдущем шаге.

Кроме того, если ваш токен обновления предназначен для управляющего аккаунта, вам следует указать идентификатор клиента этого аккаунта в качестве клиента для входа в систему:

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Подтвердите учетные данные

Чтобы убедиться, что всё настроено правильно, запустим пример GetCampaigns .

Сначала перейдите в каталог google-ads-examples .

$ cd google-ads-examples

В этом примере требуется параметр --customerId , где значением является идентификатор клиента вашего аккаунта Google Рекламы без дефисов.

Чтобы работать с Gradle:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"

Изучите другие примеры

Пакет примеров в google-ads-examples содержит несколько полезных примеров. Для большинства примеров требуются параметры. Вы можете либо передать параметры в качестве аргументов (рекомендуется), либо отредактировать значения INSERT_XXXXX_HERE в исходном коде. Чтобы просмотреть инструкцию использования для примера, передайте --help в качестве единственного аргумента.

С Градлом:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

Вы также можете использовать задачу listExamples в Gradle, чтобы вывести список всех примеров, примеров в подкаталоге или примеров, описание которых включает поисковый запрос.

# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'