Ruby

Google предоставляет клиентскую библиотеку на Ruby для взаимодействия с API Ad Manager. Мы рекомендуем использовать эту библиотеку совместно с RubyGems.

Для начала создайте новый проект в выбранной вами IDE или добавьте зависимость к существующему проекту. Google публикует клиентскую библиотеку в RubyGems под названием google-ads-ad_manager .

Gemfile 

gem 'google-ads-ad_manager', '~> 5.3.0'

Командная строка 

gem install google-ads-ad_manager

Настройка учетных данных

Клиентская библиотека Ruby использует OAuth2 и учетные данные приложения по умолчанию (ADC) для аутентификации.

ADC выполняет поиск учетных данных в следующем порядке:

  1. Переменная среды GOOGLE_APPLICATION_CREDENTIALS .
  2. Учетные данные пользователя настраиваются через интерфейс командной строки Google Cloud (gcloud CLI).
  3. При работе в Google Cloud учетная запись службы, привязанная к ресурсу Google Cloud.

Для создания и настройки учетных данных ADC см. раздел «Аутентификация» .

Сделайте свой первый запрос

Каждый REST-сервис имеет соответствующий класс Ruby с методами для каждого соответствующего REST-метода. В следующем примере считывается Network .

require "google/ads/ad_manager/v1"

def get_network
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Ads::AdManager::V1::NetworkService::Rest::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Ads::AdManager::V1::GetNetworkRequest.new(name: => 'networks/NETWORK_CODE)'

  # Call the get_network method.
  result = client.get_network request

  # The returned object is of type Google::Ads::AdManager::V1::Network.
  p result
end

Примеры других методов и ресурсов можно найти в репозитории GitHub googleapis/google-cloud-ruby .

Регистрируйте HTTP-запросы и ответы.

Клиентская библиотека Ruby использует стандартную библиотеку logger для регистрации HTTP-запросов и ответов. Логирование по умолчанию отключено.

To enable logging, set the environment variable GOOGLE_SDK_RUBY_LOGGING_GEMS to the value google-ads-ad_manager . If you use more than one Google API, you can set the value to a comma-delimited list of client library gem names. The default logging behavior writes logs to the standard error stream.

В качестве альтернативы, вы можете включить логирование в своем коде Ruby, изменив конфигурацию logger при создании объекта клиента.

require "google/ads/ad_manager/v1"
require "logger"

client = ::Google::Ads::AdManager::V1::NetworkService::Rest::Client.new do |config|
  config.logger = Logger.new "my-app.log"
end

Обработка ошибок

Все ошибки API Ad Manager являются подклассами класса ::Google::Cloud::Error в клиентской библиотеке Ruby.

result = client.get_network request
rescue ::Google::Cloud::Error => e
  puts "An error of type #{e.class} occurred with HTTP status #{e.status_code}"

В сообщениях об ошибках API Ad Manager также содержится уникальный request_id который вы можете предоставить в службу поддержки для получения помощи в устранении неполадок. В следующем примере request_id извлекается из details об ошибке.

rescue ::Google::Cloud::Error => e
  request_info = e.details.find { |detail| detail.is_a?(Google::Rpc::RequestInfo)}
  puts request_info.request_id

Формирование имен ресурсов

Клиентская библиотека предоставляет вспомогательные классы для формирования имен ресурсов на основе идентификаторов.

require "google/ads/ad_manager/v1"

#  Constructs a String in the format:
#  "networks/{networkCode}/orders/{orderId}"
order_name = Google::Ads::AdManager::V1::OrderService::Paths::order_path(:network_code => 123, :order => 456)

Настройка параметров прокси-сервера

Клиентская библиотека Ruby учитывает как переменные среды HTTP_PROXY , так и HTTPS_PROXY .