Ниже описан базовый процесс использования клиентской библиотеки.
Установка
Рекомендуемый способ установки библиотеки – с помощью Bundler. Добавьте строку в файл Gemfile (замените x.y.z на номер нужной версии):
gem 'google-ads-googleads', '~> x.y.z'
Затем выполните следующую команду:
bundle install
Эта команда использует Bundler для обновления Gemfile.lock, привязывая его к точной версии gem и всех зависимостей gem, которые были установлены. Оператор пессимистичной версии "~> x.y.z" гарантирует, что bundle install или bundle update устанавливает только новые версии исправлений в серии x.y.*, поэтому вам необходимо вручную выбрать новые минорные или основные версии, обновив Gemfile.
Другие варианты установки
Если вы не используете Bundler, выберите один из следующих вариантов:
Установите эту библиотеку с помощью RubyGems:
gem install google-ads-googleadsСкачайте gem-файл со страницы выпусков и установите его из локального файла:
gem install google-ads-googleads-[version].gem
Как настроить аутентификацию
Чтобы аутентифицировать вызовы API, настройте файл google_ads_config.rb и следуйте инструкциям на странице Аутентификация и авторизация.
Использование
Начиная с версии google-ads-googleads 41.1.0, gem поддерживает автозапрос Bundler (Bundler.require). В версиях до 41.1.0 (или если вы не используете Bundler.require) необходимо явно запрашивать gem в коде:
require 'google/ads/google_ads'
Инициализируйте клиент (который по умолчанию загружает конфигурацию из ~/google_ads_config.rb) и получите определенный сервис, например CampaignService:
# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Fetch the CampaignService client.
campaign_service = client.service.campaign
Более подробные примеры использования библиотеки можно найти на GitHub.
Ознакомившись с примерами, изучите фабрики, которые предоставляют набор удобных методов высокого уровня для работы с Google Ads API.
Обработка ошибок
Не все вызовы API выполняются успешно. Если вызовы API не выполняются, сервер выдает исключения. Важно отслеживать ошибки API и правильно их обрабатывать.
Экземпляр Google::Ads::GoogleAds::Errors::GoogleAdsError создается при возникновении ошибки API. Она содержит сведения, которые помогут вам определить, что пошло не так. Вы можете настроить вспомогательную функцию для обработки ошибок. Пример обработчика ошибок можно найти на GitHub.