工厂

factories 提供了一个用于创建操作和资源的高级接口 使用客户端库

工厂方法会自动为所有资源、枚举和 操作和服务类型。

操作

该库提供了 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 然后您可以对其执行 mutate 操作,并为 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.v17.[entity]
client.operation.v17.[operation]
client.service.v17.[service]
client.enum.v17.[enum]