Module: Google::Ads::GoogleAds::V23::Services::CampaignGoalConfigService::Paths

Extended by:
Paths
Included in:
Client, Paths
Defined in:
lib/google/ads/google_ads/v23/services/campaign_goal_config_service/paths.rb

Overview

Path helper methods for the CampaignGoalConfigService API.

Instance Method Summary collapse

Instance Method Details

#campaign_goal_config_path(customer_id:, campaign_id:, unified_goal_id:) ⇒ ::String

Create a fully-qualified CampaignGoalConfig resource string.

The resource will be in the following format:

‘customers/customer_id/campaignGoalConfigs/campaign_id~unified_goal_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • unified_goal_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


57
58
59
60
61
62
 
# File 'lib/google/ads/google_ads/v23/services/campaign_goal_config_service/paths.rb', line 57

def campaign_goal_config_path customer_id:, campaign_id:, unified_goal_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"

  "customers/#{customer_id}/campaignGoalConfigs/#{campaign_id}~#{unified_goal_id}"
end

#campaign_path(customer_id:, campaign_id:) ⇒ ::String

Create a fully-qualified Campaign resource string.

The resource will be in the following format:

‘customers/customer_id/campaigns/campaign_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


39
40
41
42
43
 
# File 'lib/google/ads/google_ads/v23/services/campaign_goal_config_service/paths.rb', line 39

def campaign_path customer_id:, campaign_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/campaigns/#{campaign_id}"
end

#goal_path(customer_id:, unified_goal_id:) ⇒ ::String

Create a fully-qualified Goal resource string.

The resource will be in the following format:

‘customers/customer_id/goals/unified_goal_id`

Parameters:

  • customer_id (String)
  • unified_goal_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


75
76
77
78
79
 
# File 'lib/google/ads/google_ads/v23/services/campaign_goal_config_service/paths.rb', line 75

def goal_path customer_id:, unified_goal_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/goals/#{unified_goal_id}"
end