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

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

Overview

Path helper methods for the CampaignCriterionService API.

Instance Method Summary collapse

Instance Method Details

#campaign_criterion_path(customer_id:, campaign_id:, criterion_id:) ⇒ ::String

Create a fully-qualified CampaignCriterion resource string.

The resource will be in the following format:

‘customers/customer_id/campaignCriteria/campaign_id~criterion_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • criterion_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def campaign_criterion_path customer_id:, campaign_id:, criterion_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}/campaignCriteria/#{campaign_id}~#{criterion_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/v17/services/campaign_criterion_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

#carrier_constant_path(criterion_id:) ⇒ ::String

Create a fully-qualified CarrierConstant resource string.

The resource will be in the following format:

‘carrierConstants/criterion_id`

Parameters:

  • criterion_id (String)

Returns:

  • (::String) 


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

def carrier_constant_path criterion_id:
  "carrierConstants/#{criterion_id}"
end

#combined_audience_path(customer_id:, combined_audience_id:) ⇒ ::String

Create a fully-qualified CombinedAudience resource string.

The resource will be in the following format:

‘customers/customer_id/combinedAudiences/combined_audience_id`

Parameters:

  • customer_id (String)
  • combined_audience_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def combined_audience_path customer_id:, combined_audience_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/combinedAudiences/#{combined_audience_id}"
end

#keyword_theme_constant_path(express_category_id:, express_sub_category_id:) ⇒ ::String

Create a fully-qualified KeywordThemeConstant resource string.

The resource will be in the following format:

‘keywordThemeConstants/express_category_id~express_sub_category_id`

Parameters:

  • express_category_id (String)
  • express_sub_category_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def keyword_theme_constant_path express_category_id:, express_sub_category_id:
  raise ::ArgumentError, "express_category_id cannot contain /" if express_category_id.to_s.include? "/"

  "keywordThemeConstants/#{express_category_id}~#{express_sub_category_id}"
end

#mobile_app_category_constant_path(mobile_app_category_id:) ⇒ ::String

Create a fully-qualified MobileAppCategoryConstant resource string.

The resource will be in the following format:

‘mobileAppCategoryConstants/mobile_app_category_id`

Parameters:

  • mobile_app_category_id (String)

Returns:

  • (::String) 


122
123
124
 
# File 'lib/google/ads/google_ads/v17/services/campaign_criterion_service/paths.rb', line 122

def mobile_app_category_constant_path mobile_app_category_id:
  "mobileAppCategoryConstants/#{mobile_app_category_id}"
end

#mobile_device_constant_path(criterion_id:) ⇒ ::String

Create a fully-qualified MobileDeviceConstant resource string.

The resource will be in the following format:

‘mobileDeviceConstants/criterion_id`

Parameters:

  • criterion_id (String)

Returns:

  • (::String) 


136
137
138
 
# File 'lib/google/ads/google_ads/v17/services/campaign_criterion_service/paths.rb', line 136

def mobile_device_constant_path criterion_id:
  "mobileDeviceConstants/#{criterion_id}"
end

#operating_system_version_constant_path(criterion_id:) ⇒ ::String

Create a fully-qualified OperatingSystemVersionConstant resource string.

The resource will be in the following format:

‘operatingSystemVersionConstants/criterion_id`

Parameters:

  • criterion_id (String)

Returns:

  • (::String) 


150
151
152
 
# File 'lib/google/ads/google_ads/v17/services/campaign_criterion_service/paths.rb', line 150

def operating_system_version_constant_path criterion_id:
  "operatingSystemVersionConstants/#{criterion_id}"
end

#topic_constant_path(topic_id:) ⇒ ::String

Create a fully-qualified TopicConstant resource string.

The resource will be in the following format:

‘topicConstants/topic_id`

Parameters:

  • topic_id (String)

Returns:

  • (::String) 


164
165
166
 
# File 'lib/google/ads/google_ads/v17/services/campaign_criterion_service/paths.rb', line 164

def topic_constant_path topic_id:
  "topicConstants/#{topic_id}"
end