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

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

Overview

Path helper methods for the AdGroupAdService API.

Instance Method Summary collapse

Instance Method Details

#ad_group_ad_label_path(customer_id:, ad_group_id:, ad_id:, label_id:) ⇒ ::String

Create a fully-qualified AdGroupAdLabel resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupAdLabels/ad_group_id~ad_id~label_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • ad_id (String)
  • label_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


94
95
96
97
98
99
100
 
# File 'lib/google/ads/google_ads/v14/services/ad_group_ad_service/paths.rb', line 94

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

  "customers/#{customer_id}/adGroupAdLabels/#{ad_group_id}~#{ad_id}~#{label_id}"
end

#ad_group_ad_path(customer_id:, ad_group_id:, ad_id:) ⇒ ::String

Create a fully-qualified AdGroupAd resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupAds/ad_group_id~ad_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • ad_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

  "customers/#{customer_id}/adGroupAds/#{ad_group_id}~#{ad_id}"
end

#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/v14/services/ad_group_ad_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/v14/services/ad_group_ad_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