Module: Google::Ads::GoogleAds::V8::Services::ChangeStatusService::Paths

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

Overview

Path helper methods for the ChangeStatusService API.

Instance Method Summary collapse

Instance Method Details

#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)


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

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_bid_modifier_path(customer_id:, ad_group_id:, criterion_id:) ⇒ ::String

Create a fully-qualified AdGroupBidModifier resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupBidModifiers/ad_group_id~criterion_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • criterion_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


76
77
78
79
80
81
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 76

def ad_group_bid_modifier_path customer_id:, ad_group_id:, criterion_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}/adGroupBidModifiers/#{ad_group_id}~#{criterion_id}"
end

#ad_group_criterion_path(customer_id:, ad_group_id:, criterion_id:) ⇒ ::String

Create a fully-qualified AdGroupCriterion resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupCriteria/ad_group_id~criterion_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • criterion_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


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

def ad_group_criterion_path customer_id:, ad_group_id:, criterion_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}/adGroupCriteria/#{ad_group_id}~#{criterion_id}"
end

#ad_group_feed_path(customer_id:, ad_group_id:, feed_id:) ⇒ ::String

Create a fully-qualified AdGroupFeed resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupFeeds/ad_group_id~feed_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • feed_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


114
115
116
117
118
119
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 114

def ad_group_feed_path customer_id:, ad_group_id:, feed_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}/adGroupFeeds/#{ad_group_id}~#{feed_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)


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

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

#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)


150
151
152
153
154
155
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 150

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_feed_path(customer_id:, campaign_id:, feed_id:) ⇒ ::String

Create a fully-qualified CampaignFeed resource string.

The resource will be in the following format:

‘customers/customer_id/campaignFeeds/campaign_id~feed_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • feed_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


169
170
171
172
173
174
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 169

def campaign_feed_path customer_id:, campaign_id:, feed_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}/campaignFeeds/#{campaign_id}~#{feed_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)


132
133
134
135
136
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 132

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

#change_status_path(customer_id:, change_status_id:) ⇒ ::String

Create a fully-qualified ChangeStatus resource string.

The resource will be in the following format:

‘customers/customer_id/changeStatus/change_status_id`

Parameters:

  • customer_id (String)
  • change_status_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


187
188
189
190
191
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 187

def change_status_path customer_id:, change_status_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/changeStatus/#{change_status_id}"
end

#feed_item_path(customer_id:, feed_id:, feed_item_id:) ⇒ ::String

Create a fully-qualified FeedItem resource string.

The resource will be in the following format:

‘customers/customer_id/feedItems/feed_id~feed_item_id`

Parameters:

  • customer_id (String)
  • feed_id (String)
  • feed_item_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


222
223
224
225
226
227
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 222

def feed_item_path customer_id:, feed_id:, feed_item_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "feed_id cannot contain /" if feed_id.to_s.include? "/"

  "customers/#{customer_id}/feedItems/#{feed_id}~#{feed_item_id}"
end

#feed_path(customer_id:, feed_id:) ⇒ ::String

Create a fully-qualified Feed resource string.

The resource will be in the following format:

‘customers/customer_id/feeds/feed_id`

Parameters:

  • customer_id (String)
  • feed_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


204
205
206
207
208
# File 'lib/google/ads/google_ads/v8/services/change_status_service/paths.rb', line 204

def feed_path customer_id:, feed_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/feeds/#{feed_id}"
end