Заводы

factories предоставляют высокоуровневый интерфейс для создания операций и ресурсов с помощью клиентской библиотеки.

Фабричные методы автоматически генерируются для всех ресурсов, перечислений, операций и типов услуг, предоставляемых API Google Рекламы.

Операции

Библиотека предоставляет удобные методы client.operation.create_resource.<resource_type> , client.operation.update_resource.<resource_type> и client.operation.remove_resource.<resource_type> , позволяющие легко создавать операции для работы с Google Ads API.

Вот пример создания ресурса:

campaign_budget_operation = client.operation.create_resource.campaign_budget do |cb|
  cb.name = client.wrapper.string(
    "Interplanetary Budget #{(Time.new.to_f * 1000).to_i}",
  )

  cb.delivery_method = :STANDARD
  cb.amount_micros = client.wrapper.int64(500000)
end

return_budget = client.service.campaign_budget.mutate_campaign_budgets(
  customer_id,
  [campaign_budget_operation]
)

Обратите внимание, что объект, переданный в блок cb представляет собой новый экземпляр CampaignBudget , который затем можно изменить, и возвращается соответствующая операция создания для CampaignBudgetService .

Аналогичным образом мы предоставляем удобные методы обновления:

# if you only have a resource name
update_operation = client.operation.update_resource.campaign(campaign_resource_name) do |camp|
  camp.status = :PAUSED
end

campaign_service.mutate_campaigns(customer_id, [update_operation])

# if you have a full resource proto
update_operation = client.operation.update_resource.campaign(campaign) do
  campaign.name = client.wrapper.string(
    "A different interplanetary Cruise #{(Time.new.to_f * 1000).to_i}",
  )
end

campaign_service.mutate_campaigns(customer_id, [update_operation])

Эти вызовы возвращают правильно сформированную операцию обновления с предварительно заполненной маской поля для обновления ресурса в API Google Рекламы.

Вот пример удаления ресурса с использованием пути к ресурсу:

remove_operation = client.operation.remove_resource.campaign(campaign_resource_name)
campaign_service.mutate_campaigns(customer_id, [remove_operation])

Если вы предпочитаете работать с операцией самостоятельно, вы можете получить необработанную операцию, а затем вручную заполнить поля.

operation = client.operation.campaign

Ресурсы

Библиотека предоставляет client.resource.<resource_type> как удобный способ инициализации объектов ресурсов:

campaign.network_settings = client.resource.network_settings do |ns|
  ns.target_google_search = client.wrapper.bool(true)
  ns.target_search_network = client.wrapper.bool(true)
  ns.target_content_network = client.wrapper.bool(false)
  ns.target_partner_search_network = client.wrapper.bool(false)
end

Новый экземпляр запрошенного типа ресурса передается в переданный блок для настройки полей.

Услуги

Библиотека предоставляет client.service.<service_name> как удобный способ получения объектов службы:

campaign_service = client.service.campaign

Перечисления

Мы рекомендуем использовать синтаксис символов для статической установки полей перечисления (например, campaign.status = :PAUSED ). Однако, если вы хотите перечислить все допустимые значения перечисления, мы также предоставляем для этого методы:

client.enum.ad_type.each { |x| p x }
    :SHOPPING_PRODUCT_AD
    :GMAIL_AD
    :UNKNOWN
    :UNSPECIFIED
    :CALL_ONLY_AD
    :VIDEO_AD
    :IMAGE_AD
    :EXPANDED_DYNAMIC_SEARCH_AD
    :RESPONSIVE_DISPLAY_AD
    :TEXT_AD
    :LEGACY_RESPONSIVE_DISPLAY_AD
    :LEGACY_APP_INSTALL_AD
    :APP_AD
    :SHOPPING_SMART_AD
    :EXPANDED_TEXT_AD
    :HOTEL_AD
    :RESPONSIVE_SEARCH_AD

Явная установка версий Google Ads API

Вы также можете явно установить версию:

client.resource.v16.[entity]
client.operation.v16.[operation]
client.service.v16.[service]
client.enum.v16.[enum]