工場

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 に yield されたオブジェクトは、変更可能な 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]