factories
提供了一个高级接口,用于通过客户端库创建操作和资源。
系统会自动为 Google Ads API 提供的所有资源、枚举、操作和服务类型生成工厂方法。
运维
该库提供了 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 = "Interplanetary Budget #{(Time.new.to_f * 1000).to_i}"
cb.delivery_method = :STANDARD
cb.amount_micros = 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 = "A different interplanetary Cruise #{(Time.new.to_f * 1000).to_i}"
end
campaign_service.mutate_campaigns(customer_id, [update_operation])
这些调用会返回一个格式正确的更新操作,其中预先填充了字段掩码,以便在 Google Ads API 中更新资源。
以下示例展示了如何使用资源路径移除资源:
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 = 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.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.v21.[entity]
client.operation.v21.[operation]
client.service.v21.[service]
client.enum.v21.[enum]