工廠

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.v19.[entity]
client.operation.v19.[operation]
client.service.v19.[service]
client.enum.v19.[enum]