Фабрики

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

Фабричные методы автоматически создаются для всех ресурсов, перечислений, операций и типов сервисов, предоставляемых Google Ads API. В примерах на этой странице предполагается, что вы инициализировали экземпляр GoogleAdsClient и целевой объект customer_id:

require 'google/ads/google_ads'

client = Google::Ads::GoogleAds::GoogleAdsClient.new
customer_id = '1234567890'

Операции

Библиотека предоставляет удобные методы 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 |budget|
    budget.name = "Interplanetary Budget #{(Time.new.to_f * 1000).to_i}"
    budget.delivery_method = :STANDARD
    budget.amount_micros = 500_000
  end

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

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

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

campaign_service = client.service.campaign

# 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: customer_id,
  operations: [update_operation]
)

# If you have a full resource proto:
update_operation = client.operation.update_resource.campaign(campaign) do |camp|
  camp.name = "A different Cruise #{(Time.new.to_f * 1000).to_i}"
end

campaign_service.mutate_campaigns(
  customer_id: customer_id,
  operations: [update_operation]
)

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

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

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

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

operation = client.operation.campaign

Ресурсы

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

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

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

Сервисы

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

campaign_service = client.service.campaign

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

Используйте синтаксис символов для статической настройки полей перечисления (например, campaign.status = :PAUSED). Чтобы перечислить все допустимые значения для перечисления, используйте фабрику client.enum:

client.enum.ad_type.each { |ad_type| p ad_type }
# Output:
# :UNSPECIFIED
# :UNKNOWN
# :TEXT_AD
# :EXPANDED_TEXT_AD
# :EXPANDED_DYNAMIC_SEARCH_AD
# :HOTEL_AD
# :SHOPPING_SMART_AD
# :SHOPPING_PRODUCT_AD
# :VIDEO_AD
# :IMAGE_AD
# :RESPONSIVE_SEARCH_AD
# :LEGACY_RESPONSIVE_DISPLAY_AD
# :APP_AD
# :LEGACY_APP_INSTALL_AD
# :RESPONSIVE_DISPLAY_AD
# :LOCAL_AD
# :HTML5_UPLOAD_AD
# :DYNAMIC_HTML5_AD
# :APP_ENGAGEMENT_AD
# :SHOPPING_COMPARISON_LISTING_AD
# :VIDEO_BUMPER_AD
# :VIDEO_NON_SKIPPABLE_IN_STREAM_AD
# :VIDEO_TRUEVIEW_IN_STREAM_AD
# :VIDEO_RESPONSIVE_AD
# :SMART_CAMPAIGN_AD
# :CALL_AD
# :APP_PRE_REGISTRATION_AD
# :IN_FEED_VIDEO_AD
# :DEMAND_GEN_MULTI_ASSET_AD
# :DEMAND_GEN_CAROUSEL_AD
# :TRAVEL_AD
# :DEMAND_GEN_VIDEO_RESPONSIVE_AD
# :DEMAND_GEN_PRODUCT_AD
# :YOUTUBE_AUDIO_AD

Как задать версии Google Ads API

Вы также можете явно задать основную версию API в любом вызове фабрики (например, v25; в дополнительных версиях API, таких как v25.1, используется метод основной версии v25):

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