Module: Google::Ads::GoogleAds::V17::Services::RecommendationService::Paths

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

Overview

Path helper methods for the RecommendationService API.

Instance Method Summary collapse

Instance Method Details

#ad_group_path(customer_id:, ad_group_id:) ⇒ ::String

Create a fully-qualified AdGroup resource string.

The resource will be in the following format:

‘customers/customer_id/adGroups/ad_group_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


56
57
58
59
60
 
# File 'lib/google/ads/google_ads/v17/services/recommendation_service/paths.rb', line 56

def ad_group_path customer_id:, ad_group_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/adGroups/#{ad_group_id}"
end

#ad_path(customer_id:, ad_id:) ⇒ ::String

Create a fully-qualified Ad resource string.

The resource will be in the following format:

‘customers/customer_id/ads/ad_id`

Parameters:

  • customer_id (String)
  • ad_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def ad_path customer_id:, ad_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/ads/#{ad_id}"
end

#asset_path(customer_id:, asset_id:) ⇒ ::String

Create a fully-qualified Asset resource string.

The resource will be in the following format:

‘customers/customer_id/assets/asset_id`

Parameters:

  • customer_id (String)
  • asset_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


73
74
75
76
77
 
# File 'lib/google/ads/google_ads/v17/services/recommendation_service/paths.rb', line 73

def asset_path customer_id:, asset_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/assets/#{asset_id}"
end

#campaign_budget_path(customer_id:, campaign_budget_id:) ⇒ ::String

Create a fully-qualified CampaignBudget resource string.

The resource will be in the following format:

‘customers/customer_id/campaignBudgets/campaign_budget_id`

Parameters:

  • customer_id (String)
  • campaign_budget_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


107
108
109
110
111
 
# File 'lib/google/ads/google_ads/v17/services/recommendation_service/paths.rb', line 107

def campaign_budget_path customer_id:, campaign_budget_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/campaignBudgets/#{campaign_budget_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) 


90
91
92
93
94
 
# File 'lib/google/ads/google_ads/v17/services/recommendation_service/paths.rb', line 90

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

#conversion_action_path(customer_id:, conversion_action_id:) ⇒ ::String

Create a fully-qualified ConversionAction resource string.

The resource will be in the following format:

‘customers/customer_id/conversionActions/conversion_action_id`

Parameters:

  • customer_id (String)
  • conversion_action_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


124
125
126
127
128
 
# File 'lib/google/ads/google_ads/v17/services/recommendation_service/paths.rb', line 124

def conversion_action_path customer_id:, conversion_action_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/conversionActions/#{conversion_action_id}"
end

#recommendation_path(customer_id:, recommendation_id:) ⇒ ::String

Create a fully-qualified Recommendation resource string.

The resource will be in the following format:

‘customers/customer_id/recommendations/recommendation_id`

Parameters:

  • customer_id (String)
  • recommendation_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


141
142
143
144
145
 
# File 'lib/google/ads/google_ads/v17/services/recommendation_service/paths.rb', line 141

def recommendation_path customer_id:, recommendation_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/recommendations/#{recommendation_id}"
end