Мы рекомендуем использовать клиентскую библиотеку с Apache Maven (или Gradle).
Создайте новый проект Maven/Gradle
Создайте новый проект Maven/Gradle в любой IDE по вашему выбору. Наши артефакты будут опубликованы в центральном репозитории Maven .
Зависимость Maven:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>39.0.0</version>
</dependency>
Зависимость Gradle:
implementation 'com.google.api-ads:google-ads:39.0.0'
Вы также можете выполнить сборку из исходного кода . В рамках данного руководства предполагается, что у вас уже есть настроенный проект со всеми необходимыми зависимостями.
Если вы выполняете сборку из исходного кода, убедитесь, что в вашей IDE включена обработка аннотаций.
Получите учетные данные для аутентификации с помощью API
Для доступа к API Google Ads требуются учётные данные OAuth и токен разработчика API Google Ads. В этом разделе объясняется, что это такое, как они используются и как их получить.
Токен разработчика (для доступа к API)
Токен разработчика привязан к учетной записи менеджера и может быть найден в веб-интерфейсе Google Ads .
Хотя токен разработчика привязан к учётной записи менеджера, он не предоставляет доступ к этой учётной записи. Вместо этого токен разработчика предоставляет доступ к API в целом, а доступ на уровне учётной записи настраивается через OAuth.
Учетные данные OAuth (для доступа к аккаунтам Google Ads)
Для авторизации в качестве пользователей аккаунта Google с доступом к аккаунтам Google Ads необходимо предоставить набор учетных данных OAuth.
Обычно используются два варианта OAuth: настольное (установленное) приложение и веб-приложение. Основное различие между ними заключается в том, что настольные приложения должны открывать системный браузер и предоставлять локальный URI перенаправления для обработки ответов сервера авторизации Google, тогда как веб-приложения могут перенаправлять любой сторонний браузер для завершения авторизации и отправки учётных данных обратно на ваш сервер. Библиотека также поддерживает менее распространённый вариант с учётной записью службы.
- Если вы авторизуетесь, используя собственные учетные данные (процесс настольного приложения)
- Ознакомьтесь с описанием процесса авторизации в настольном приложении OAuth . Оно содержит всю необходимую информацию для авторизации с использованием ваших учётных данных.
- Если вы авторизуетесь как сторонний пользователь Google (веб-поток)
- См. раздел «Процесс авторизации веб-приложения OAuth» . Здесь представлен пример настройки авторизации OAuth для произвольных сторонних пользователей.
- Если вы авторизуетесь как пользователь домена Google Apps (процесс учетной записи службы)
- См. раздел «Учетная запись сервиса OAuth» . Здесь представлен пример настройки авторизации OAuth для пользователей домена Google Apps.
Если ваш доступ к учетной записи клиента Google Ads осуществляется через учетную запись менеджера Google Ads, вам также необходимо указать идентификатор клиента для входа, как описано ниже.
Идентификатор клиента (для доступа к аккаунтам Google Ads через аккаунт менеджера)
При желании укажите идентификатор клиента учётной записи менеджера, предоставляющей доступ к обслуживающей учётной записи. Его необходимо указать, если доступ к учётной записи клиента осуществляется через учётную запись менеджера. Не нужно указывать все учётные записи менеджеров в пути к идентификатору клиента, достаточно идентификатора менеджера верхнего уровня, который используется для прав доступа. Подробнее см. в соответствующей документации .
Настройте клиентскую библиотеку, используя ваши учетные данные.
Клиентскую библиотеку можно настроить с помощью файла конфигурации, переменных среды или программно. В этом руководстве мы будем использовать подход с использованием файла конфигурации и сосредоточимся на потоках для рабочего стола и веб-приложений. Использование файла конфигурации, как правило, является хорошим подходом, если у вас только один набор учётных данных (например, вы управляете учётными записями под одним менеджером).
Создайте файл ~/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 Ads без дефисов.
Для запуска с Gradle:
./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Изучите другие примеры
Пакет примеров в google-ads-examples содержит несколько полезных примеров. Для большинства примеров требуются параметры. Вы можете передать параметры как аргументы (рекомендуется) или изменить значения INSERT_XXXXX_HERE в исходном коде. Чтобы увидеть инструкцию по использованию для примера, передайте --help в качестве единственного аргумента.
С Gradle:
./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'