工場

factories は、クライアント ライブラリでオペレーションとリソースを作成するための高レベルのインターフェースを提供します。

ファクトリ メソッドは、Google Ads API によって提供されるすべてのリソース、列挙型、オペレーション、サービスタイプに対して自動的に生成されます。このページの例では、GoogleAdsClient インスタンスとターゲット customer_id を初期化したことを前提としています。

require 'google/ads/google_ads'

client = Google::Ads::GoogleAds::GoogleAdsClient.new
customer_id = '1234567890'

運用

このライブラリには、Google Ads API を操作するためのオペレーションを構築するための client.operation.create_resource.<resource_type>、client.operation.update_resource.<resource_type>、client.operation.remove_resource.<resource_type> の便利なメソッドが用意されています。

次の例では、キャンペーンの予算リソースを作成します。

campaign_budget_operation =
  client.operation.create_resource.campaign_budget do |budget|
    budget.name = "Interplanetary Budget #{(Time.new.to_f * 1000).to_i}"
    budget.delivery_method = :STANDARD
    budget.amount_micros = 500_000
  end

return_budget = client.service.campaign_budget.mutate_campaign_budgets(
  customer_id: customer_id,
  operations: [campaign_budget_operation]
)

ブロック（budget）に渡されるオブジェクトは、変更可能な CampaignBudget の新しいインスタンスであり、CampaignBudgetService の適切な作成オペレーションが返されます。

同様に、ライブラリにはリソースを更新するための便利なメソッドが用意されています。

campaign_service = client.service.campaign

# 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: customer_id,
  operations: [update_operation]
)

# If you have a full resource proto:
update_operation = client.operation.update_resource.campaign(campaign) do |camp|
  camp.name = "A different Cruise #{(Time.new.to_f * 1000).to_i}"
end

campaign_service.mutate_campaigns(
  customer_id: customer_id,
  operations: [update_operation]
)

これらの呼び出しは、Google Ads API でリソースを更新するために、事前入力されたフィールド マスクを含む整形式の更新オペレーションを返します。

次の例では、リソースパスを使用してリソースを削除します。

campaign_service = client.service.campaign
remove_operation =
  client.operation.remove_resource.campaign(campaign_resource_name)
campaign_service.mutate_campaigns(
  customer_id: customer_id,
  operations: [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 ファクトリを使用します。

client.enum.ad_type.each { |ad_type| p ad_type }
# Output:
# :UNSPECIFIED
# :UNKNOWN
# :TEXT_AD
# :EXPANDED_TEXT_AD
# :EXPANDED_DYNAMIC_SEARCH_AD
# :HOTEL_AD
# :SHOPPING_SMART_AD
# :SHOPPING_PRODUCT_AD
# :VIDEO_AD
# :IMAGE_AD
# :RESPONSIVE_SEARCH_AD
# :LEGACY_RESPONSIVE_DISPLAY_AD
# :APP_AD
# :LEGACY_APP_INSTALL_AD
# :RESPONSIVE_DISPLAY_AD
# :LOCAL_AD
# :HTML5_UPLOAD_AD
# :DYNAMIC_HTML5_AD
# :APP_ENGAGEMENT_AD
# :SHOPPING_COMPARISON_LISTING_AD
# :VIDEO_BUMPER_AD
# :VIDEO_NON_SKIPPABLE_IN_STREAM_AD
# :VIDEO_TRUEVIEW_IN_STREAM_AD
# :VIDEO_RESPONSIVE_AD
# :SMART_CAMPAIGN_AD
# :CALL_AD
# :APP_PRE_REGISTRATION_AD
# :IN_FEED_VIDEO_AD
# :DEMAND_GEN_MULTI_ASSET_AD
# :DEMAND_GEN_CAROUSEL_AD
# :TRAVEL_AD
# :DEMAND_GEN_VIDEO_RESPONSIVE_AD
# :DEMAND_GEN_PRODUCT_AD
# :YOUTUBE_AUDIO_AD

Google Ads API バージョンを明示的に設定する

ファクトリ呼び出しでメジャー API バージョンを明示的に設定することもできます（例: v25。v25.1 などのマイナー API リリースでは、メジャー バージョン メソッド v25 を使用します）。

client.resource.v25.[entity]
client.operation.v25.[operation]
client.service.v25.[service]
client.enum.v25.[enum]