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]