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

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

Overview

Path helper methods for the CampaignLabelService API.

Instance Method Summary collapse

Instance Method Details

#campaign_label_path(customer_id:, campaign_id:, label_id:) ⇒ ::String

Create a fully-qualified CampaignLabel resource string.

The resource will be in the following format:

customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • label_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def campaign_label_path customer_id:, campaign_id:, label_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}/campaignLabels/#{campaign_id}~#{label_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_label_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

#label_path(customer_id:, label_id:) ⇒ ::String

Create a fully-qualified Label resource string.

The resource will be in the following format:

customers/{customer_id}/labels/{label_id}

Parameters:

  • customer_id (String)
  • label_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

def label_path customer_id:, label_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/labels/#{label_id}"
end