工厂

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 = 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])

这些调用会返回格式正确的更新操作，并预填充字段掩码以更新 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 = 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]