Module: Google::Ads::GoogleAds::V14::Services::CampaignCustomizerService::Paths

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

Overview

Path helper methods for the CampaignCustomizerService API.

Instance Method Summary collapse

Instance Method Details

#campaign_customizer_path(customer_id:, campaign_id:, customizer_attribute_id:) ⇒ ::String

Create a fully-qualified CampaignCustomizer resource string.

The resource will be in the following format:

‘customers/customer_id/campaignCustomizers/campaign_id~customizer_attribute_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • customizer_attribute_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def campaign_customizer_path customer_id:, campaign_id:, customizer_attribute_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}/campaignCustomizers/#{campaign_id}~#{customizer_attribute_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/v14/services/campaign_customizer_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

#customizer_attribute_path(customer_id:, customizer_attribute_id:) ⇒ ::String

Create a fully-qualified CustomizerAttribute resource string.

The resource will be in the following format:

‘customers/customer_id/customizerAttributes/customizer_attribute_id`

Parameters:

  • customer_id (String)
  • customizer_attribute_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def customizer_attribute_path customer_id:, customizer_attribute_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customizerAttributes/#{customizer_attribute_id}"
end