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

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

Overview

Path helper methods for the GoogleAdsService API.

Instance Method Summary collapse

Instance Method Details

#accessible_bidding_strategy_path(customer_id:, bidding_strategy_id:) ⇒ ::String

Create a fully-qualified AccessibleBiddingStrategy resource string.

The resource will be in the following format:

‘customers/customer_id/accessibleBiddingStrategies/bidding_strategy_id`

Parameters:

  • customer_id (String)
  • bidding_strategy_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


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

def accessible_bidding_strategy_path customer_id:, bidding_strategy_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/accessibleBiddingStrategies/#{bidding_strategy_id}"
end

#account_budget_path(customer_id:, account_budget_id:) ⇒ ::String

Create a fully-qualified AccountBudget resource string.

The resource will be in the following format:

‘customers/customer_id/accountBudgets/account_budget_id`

Parameters:

  • customer_id (String)
  • account_budget_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


56
57
58
59
60
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 56

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

  "customers/#{customer_id}/accountBudgets/#{}"
end

#account_budget_proposal_path(customer_id:, account_budget_proposal_id:) ⇒ ::String

Create a fully-qualified AccountBudgetProposal resource string.

The resource will be in the following format:

‘customers/customer_id/accountBudgetProposals/account_budget_proposal_id`

Parameters:

  • customer_id (String)
  • account_budget_proposal_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


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

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

  "customers/#{customer_id}/accountBudgetProposals/#{}"
end

Create a fully-qualified AccountLink resource string.

The resource will be in the following format:

‘customers/customer_id/accountLinks/account_link_id`

Parameters:

  • customer_id (String)
  • account_link_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


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

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

  "customers/#{customer_id}/accountLinks/#{}"
end

#ad_group_ad_asset_combination_view_path(customer_id:, ad_group_id:, ad_id:, asset_combination_id_low:, asset_combination_id_high:) ⇒ ::String

Create a fully-qualified AdGroupAdAssetCombinationView resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupAdAssetCombinationViews/ad_group_id~ad_id~asset_combination_id_low~asset_combination_id_high`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • ad_id (String)
  • asset_combination_id_low (String)
  • asset_combination_id_high (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 163

def ad_group_ad_asset_combination_view_path customer_id:, ad_group_id:, ad_id:,
                                            asset_combination_id_low:, asset_combination_id_high:
  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? "/"
  if asset_combination_id_low.to_s.include? "/"
    raise ::ArgumentError,
          "asset_combination_id_low cannot contain /"
  end

  "customers/#{customer_id}/adGroupAdAssetCombinationViews/#{ad_group_id}~#{ad_id}~#{asset_combination_id_low}~#{asset_combination_id_high}"
end

#ad_group_ad_asset_view_path(customer_id:, ad_group_id:, ad_id:, asset_id:, field_type:) ⇒ ::String

Create a fully-qualified AdGroupAdAssetView resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupAdAssetViews/ad_group_id~ad_id~asset_id~field_type`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • ad_id (String)
  • asset_id (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


190
191
192
193
194
195
196
197
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 190

def ad_group_ad_asset_view_path customer_id:, ad_group_id:, ad_id:, asset_id:, field_type:
  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? "/"
  raise ::ArgumentError, "asset_id cannot contain /" if asset_id.to_s.include? "/"

  "customers/#{customer_id}/adGroupAdAssetViews/#{ad_group_id}~#{ad_id}~#{asset_id}~#{field_type}"
end

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


212
213
214
215
216
217
218
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 212

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)


142
143
144
145
146
147
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 142

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_asset_path(customer_id:, ad_group_id:, asset_id:, field_type:) ⇒ ::String

Create a fully-qualified AdGroupAsset resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupAssets/ad_group_id~asset_id~field_type`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • asset_id (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


233
234
235
236
237
238
239
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 233

def ad_group_asset_path customer_id:, ad_group_id:, asset_id:, field_type:
  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, "asset_id cannot contain /" if asset_id.to_s.include? "/"

  "customers/#{customer_id}/adGroupAssets/#{ad_group_id}~#{asset_id}~#{field_type}"
end

#ad_group_asset_set_path(customer_id:, ad_group_id:, asset_set_id:) ⇒ ::String

Create a fully-qualified AdGroupAssetSet resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupAssetSets/ad_group_id~asset_set_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • asset_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


253
254
255
256
257
258
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 253

def ad_group_asset_set_path customer_id:, ad_group_id:, asset_set_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}/adGroupAssetSets/#{ad_group_id}~#{asset_set_id}"
end

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

Create a fully-qualified AdGroupAudienceView resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupAudienceViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


272
273
274
275
276
277
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 272

def ad_group_audience_view_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}/adGroupAudienceViews/#{ad_group_id}~#{criterion_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)


291
292
293
294
295
296
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 291

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

Create a fully-qualified AdGroupCriterionCustomizer resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupCriterionCustomizers/ad_group_id~criterion_id~customizer_attribute_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


330
331
332
333
334
335
336
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 330

def ad_group_criterion_customizer_path customer_id:, ad_group_id:, criterion_id:, customizer_attribute_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, "criterion_id cannot contain /" if criterion_id.to_s.include? "/"

  "customers/#{customer_id}/adGroupCriterionCustomizers/#{ad_group_id}~#{criterion_id}~#{customizer_attribute_id}"
end

#ad_group_criterion_label_path(customer_id:, ad_group_id:, criterion_id:, label_id:) ⇒ ::String

Create a fully-qualified AdGroupCriterionLabel resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupCriterionLabels/ad_group_id~criterion_id~label_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


351
352
353
354
355
356
357
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 351

def ad_group_criterion_label_path customer_id:, ad_group_id:, criterion_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, "criterion_id cannot contain /" if criterion_id.to_s.include? "/"

  "customers/#{customer_id}/adGroupCriterionLabels/#{ad_group_id}~#{criterion_id}~#{label_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)


310
311
312
313
314
315
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 310

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_criterion_simulation_path(customer_id:, ad_group_id:, criterion_id:, type:, modification_method:, start_date:, end_date:) ⇒ ::String

Create a fully-qualified AdGroupCriterionSimulation resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupCriterionSimulations/ad_group_id~criterion_id~type~modification_method~start_date~end_date`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • criterion_id (String)
  • type (String)
  • modification_method (String)
  • start_date (String)
  • end_date (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


375
376
377
378
379
380
381
382
383
384
385
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 375

def ad_group_criterion_simulation_path customer_id:, ad_group_id:, criterion_id:, type:,
                                       modification_method:, start_date:, end_date:
  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, "criterion_id cannot contain /" if criterion_id.to_s.include? "/"
  raise ::ArgumentError, "type cannot contain /" if type.to_s.include? "/"
  raise ::ArgumentError, "modification_method cannot contain /" if modification_method.to_s.include? "/"
  raise ::ArgumentError, "start_date cannot contain /" if start_date.to_s.include? "/"

  "customers/#{customer_id}/adGroupCriterionSimulations/#{ad_group_id}~#{criterion_id}~#{type}~#{modification_method}~#{start_date}~#{end_date}"
end

#ad_group_customizer_path(customer_id:, ad_group_id:, customizer_attribute_id:) ⇒ ::String

Create a fully-qualified AdGroupCustomizer resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupCustomizers/ad_group_id~customizer_attribute_id`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • customizer_attribute_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


399
400
401
402
403
404
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 399

def ad_group_customizer_path customer_id:, ad_group_id:, customizer_attribute_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}/adGroupCustomizers/#{ad_group_id}~#{customizer_attribute_id}"
end

#ad_group_extension_setting_path(customer_id:, ad_group_id:, extension_type:) ⇒ ::String

Create a fully-qualified AdGroupExtensionSetting resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupExtensionSettings/ad_group_id~extension_type`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • extension_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


418
419
420
421
422
423
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 418

def ad_group_extension_setting_path customer_id:, ad_group_id:, extension_type:
  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}/adGroupExtensionSettings/#{ad_group_id}~#{extension_type}"
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)


437
438
439
440
441
442
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 437

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

Create a fully-qualified AdGroupLabel resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupLabels/ad_group_id~label_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


456
457
458
459
460
461
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 456

def ad_group_label_path customer_id:, ad_group_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? "/"

  "customers/#{customer_id}/adGroupLabels/#{ad_group_id}~#{label_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)


124
125
126
127
128
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 124

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_group_simulation_path(customer_id:, ad_group_id:, type:, modification_method:, start_date:, end_date:) ⇒ ::String

Create a fully-qualified AdGroupSimulation resource string.

The resource will be in the following format:

‘customers/customer_id/adGroupSimulations/ad_group_id~type~modification_method~start_date~end_date`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • type (String)
  • modification_method (String)
  • start_date (String)
  • end_date (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


478
479
480
481
482
483
484
485
486
487
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 478

def ad_group_simulation_path customer_id:, ad_group_id:, type:, modification_method:, start_date:,
                             end_date:
  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, "type cannot contain /" if type.to_s.include? "/"
  raise ::ArgumentError, "modification_method cannot contain /" if modification_method.to_s.include? "/"
  raise ::ArgumentError, "start_date cannot contain /" if start_date.to_s.include? "/"

  "customers/#{customer_id}/adGroupSimulations/#{ad_group_id}~#{type}~#{modification_method}~#{start_date}~#{end_date}"
end

#ad_parameter_path(customer_id:, ad_group_id:, criterion_id:, parameter_index:) ⇒ ::String

Create a fully-qualified AdParameter resource string.

The resource will be in the following format:

‘customers/customer_id/adParameters/ad_group_id~criterion_id~parameter_index`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


502
503
504
505
506
507
508
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 502

def ad_parameter_path customer_id:, ad_group_id:, criterion_id:, parameter_index:
  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, "criterion_id cannot contain /" if criterion_id.to_s.include? "/"

  "customers/#{customer_id}/adParameters/#{ad_group_id}~#{criterion_id}~#{parameter_index}"
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)


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

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

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

Create a fully-qualified AdScheduleView resource string.

The resource will be in the following format:

‘customers/customer_id/adScheduleViews/campaign_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


522
523
524
525
526
527
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 522

def ad_schedule_view_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}/adScheduleViews/#{campaign_id}~#{criterion_id}"
end

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

Create a fully-qualified AgeRangeView resource string.

The resource will be in the following format:

‘customers/customer_id/ageRangeViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


541
542
543
544
545
546
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 541

def age_range_view_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}/ageRangeViews/#{ad_group_id}~#{criterion_id}"
end

#android_privacy_shared_key_google_ad_group_path(customer_id:, campaign_id:, ad_group_id:, android_privacy_interaction_type:, android_privacy_network_type:, android_privacy_interaction_date:) ⇒ ::String

Create a fully-qualified AndroidPrivacySharedKeyGoogleAdGroup resource string.

The resource will be in the following format:

‘customers/customer_id/androidPrivacySharedKeyGoogleAdGroups/campaign_id~ad_group_id~android_privacy_interaction_type~android_privacy_network_type~android_privacy_interaction_date`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • ad_group_id (String)
  • android_privacy_interaction_type (String)
  • android_privacy_network_type (String)
  • android_privacy_interaction_date (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 563

def android_privacy_shared_key_google_ad_group_path customer_id:, campaign_id:, ad_group_id:,
                                                    android_privacy_interaction_type:, android_privacy_network_type:, android_privacy_interaction_date:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "ad_group_id cannot contain /" if ad_group_id.to_s.include? "/"
  if android_privacy_interaction_type.to_s.include? "/"
    raise ::ArgumentError,
          "android_privacy_interaction_type cannot contain /"
  end
  if android_privacy_network_type.to_s.include? "/"
    raise ::ArgumentError,
          "android_privacy_network_type cannot contain /"
  end

  "customers/#{customer_id}/androidPrivacySharedKeyGoogleAdGroups/#{campaign_id}~#{ad_group_id}~#{android_privacy_interaction_type}~#{android_privacy_network_type}~#{android_privacy_interaction_date}"
end

#android_privacy_shared_key_google_campaign_path(customer_id:, campaign_id:, android_privacy_interaction_type:, android_privacy_interaction_date:) ⇒ ::String

Create a fully-qualified AndroidPrivacySharedKeyGoogleCampaign resource string.

The resource will be in the following format:

‘customers/customer_id/androidPrivacySharedKeyGoogleCampaigns/campaign_id~android_privacy_interaction_type~android_privacy_interaction_date`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • android_privacy_interaction_type (String)
  • android_privacy_interaction_date (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


593
594
595
596
597
598
599
600
601
602
603
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 593

def android_privacy_shared_key_google_campaign_path customer_id:, campaign_id:,
                                                    android_privacy_interaction_type:, android_privacy_interaction_date:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  if android_privacy_interaction_type.to_s.include? "/"
    raise ::ArgumentError,
          "android_privacy_interaction_type cannot contain /"
  end

  "customers/#{customer_id}/androidPrivacySharedKeyGoogleCampaigns/#{campaign_id}~#{android_privacy_interaction_type}~#{android_privacy_interaction_date}"
end

#android_privacy_shared_key_google_network_type_path(customer_id:, campaign_id:, android_privacy_interaction_type:, android_privacy_network_type:, android_privacy_interaction_date:) ⇒ ::String

Create a fully-qualified AndroidPrivacySharedKeyGoogleNetworkType resource string.

The resource will be in the following format:

‘customers/customer_id/androidPrivacySharedKeyGoogleNetworkTypes/campaign_id~android_privacy_interaction_type~android_privacy_network_type~android_privacy_interaction_date`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • android_privacy_interaction_type (String)
  • android_privacy_network_type (String)
  • android_privacy_interaction_date (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 619

def android_privacy_shared_key_google_network_type_path customer_id:, campaign_id:,
                                                        android_privacy_interaction_type:, android_privacy_network_type:, android_privacy_interaction_date:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  if android_privacy_interaction_type.to_s.include? "/"
    raise ::ArgumentError,
          "android_privacy_interaction_type cannot contain /"
  end
  if android_privacy_network_type.to_s.include? "/"
    raise ::ArgumentError,
          "android_privacy_network_type cannot contain /"
  end

  "customers/#{customer_id}/androidPrivacySharedKeyGoogleNetworkTypes/#{campaign_id}~#{android_privacy_interaction_type}~#{android_privacy_network_type}~#{android_privacy_interaction_date}"
end

#asset_field_type_view_path(customer_id:, field_type:) ⇒ ::String

Create a fully-qualified AssetFieldTypeView resource string.

The resource will be in the following format:

‘customers/customer_id/assetFieldTypeViews/field_type`

Parameters:

  • customer_id (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


663
664
665
666
667
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 663

def asset_field_type_view_path customer_id:, field_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/assetFieldTypeViews/#{field_type}"
end

#asset_group_asset_path(customer_id:, asset_group_id:, asset_id:, field_type:) ⇒ ::String

Create a fully-qualified AssetGroupAsset resource string.

The resource will be in the following format:

‘customers/customer_id/assetGroupAssets/asset_group_id~asset_id~field_type`

Parameters:

  • customer_id (String)
  • asset_group_id (String)
  • asset_id (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


699
700
701
702
703
704
705
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 699

def asset_group_asset_path customer_id:, asset_group_id:, asset_id:, field_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "asset_group_id cannot contain /" if asset_group_id.to_s.include? "/"
  raise ::ArgumentError, "asset_id cannot contain /" if asset_id.to_s.include? "/"

  "customers/#{customer_id}/assetGroupAssets/#{asset_group_id}~#{asset_id}~#{field_type}"
end

#asset_group_listing_group_filter_path(customer_id:, asset_group_id:, listing_group_filter_id:) ⇒ ::String

Create a fully-qualified AssetGroupListingGroupFilter resource string.

The resource will be in the following format:

‘customers/customer_id/assetGroupListingGroupFilters/asset_group_id~listing_group_filter_id`

Parameters:

  • customer_id (String)
  • asset_group_id (String)
  • listing_group_filter_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


719
720
721
722
723
724
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 719

def asset_group_listing_group_filter_path customer_id:, asset_group_id:, listing_group_filter_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "asset_group_id cannot contain /" if asset_group_id.to_s.include? "/"

  "customers/#{customer_id}/assetGroupListingGroupFilters/#{asset_group_id}~#{listing_group_filter_id}"
end

#asset_group_path(customer_id:, asset_group_id:) ⇒ ::String

Create a fully-qualified AssetGroup resource string.

The resource will be in the following format:

‘customers/customer_id/assetGroups/asset_group_id`

Parameters:

  • customer_id (String)
  • asset_group_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


680
681
682
683
684
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 680

def asset_group_path customer_id:, asset_group_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/assetGroups/#{asset_group_id}"
end

#asset_group_product_group_view_path(customer_id:, asset_group_id:, listing_group_filter_id:) ⇒ ::String

Create a fully-qualified AssetGroupProductGroupView resource string.

The resource will be in the following format:

‘customers/customer_id/assetGroupProductGroupViews/asset_group_id~listing_group_filter_id`

Parameters:

  • customer_id (String)
  • asset_group_id (String)
  • listing_group_filter_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


738
739
740
741
742
743
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 738

def asset_group_product_group_view_path customer_id:, asset_group_id:, listing_group_filter_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "asset_group_id cannot contain /" if asset_group_id.to_s.include? "/"

  "customers/#{customer_id}/assetGroupProductGroupViews/#{asset_group_id}~#{listing_group_filter_id}"
end

#asset_group_signal_path(customer_id:, asset_group_id:, criterion_id:) ⇒ ::String

Create a fully-qualified AssetGroupSignal resource string.

The resource will be in the following format:

‘customers/customer_id/assetGroupSignals/asset_group_id~criterion_id`

Parameters:

  • customer_id (String)
  • asset_group_id (String)
  • criterion_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


757
758
759
760
761
762
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 757

def asset_group_signal_path customer_id:, asset_group_id:, criterion_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "asset_group_id cannot contain /" if asset_group_id.to_s.include? "/"

  "customers/#{customer_id}/assetGroupSignals/#{asset_group_id}~#{criterion_id}"
end

#asset_group_top_combination_view_path(customer_id:, asset_group_id:, asset_combination_category:) ⇒ ::String

Create a fully-qualified AssetGroupTopCombinationView resource string.

The resource will be in the following format:

‘customers/customer_id/assetGroupTopCombinationViews/asset_group_id~asset_combination_category`

Parameters:

  • customer_id (String)
  • asset_group_id (String)
  • asset_combination_category (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


776
777
778
779
780
781
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 776

def asset_group_top_combination_view_path customer_id:, asset_group_id:, asset_combination_category:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "asset_group_id cannot contain /" if asset_group_id.to_s.include? "/"

  "customers/#{customer_id}/assetGroupTopCombinationViews/#{asset_group_id}~#{asset_combination_category}"
end

#asset_path(customer_id:, asset_id:) ⇒ ::String

Create a fully-qualified Asset resource string.

The resource will be in the following format:

‘customers/customer_id/assets/asset_id`

Parameters:

  • customer_id (String)
  • asset_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


646
647
648
649
650
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 646

def asset_path customer_id:, asset_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/assets/#{asset_id}"
end

#asset_set_asset_path(customer_id:, asset_set_id:, asset_id:) ⇒ ::String

Create a fully-qualified AssetSetAsset resource string.

The resource will be in the following format:

‘customers/customer_id/assetSetAssets/asset_set_id~asset_id`

Parameters:

  • customer_id (String)
  • asset_set_id (String)
  • asset_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


812
813
814
815
816
817
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 812

def asset_set_asset_path customer_id:, asset_set_id:, asset_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "asset_set_id cannot contain /" if asset_set_id.to_s.include? "/"

  "customers/#{customer_id}/assetSetAssets/#{asset_set_id}~#{asset_id}"
end

#asset_set_path(customer_id:, asset_set_id:) ⇒ ::String

Create a fully-qualified AssetSet resource string.

The resource will be in the following format:

‘customers/customer_id/assetSets/asset_set_id`

Parameters:

  • customer_id (String)
  • asset_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


794
795
796
797
798
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 794

def asset_set_path customer_id:, asset_set_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/assetSets/#{asset_set_id}"
end

#asset_set_type_view_path(customer_id:, asset_set_type:) ⇒ ::String

Create a fully-qualified AssetSetTypeView resource string.

The resource will be in the following format:

‘customers/customer_id/assetSetTypeViews/asset_set_type`

Parameters:

  • customer_id (String)
  • asset_set_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


830
831
832
833
834
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 830

def asset_set_type_view_path customer_id:, asset_set_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/assetSetTypeViews/#{asset_set_type}"
end

#audience_path(customer_id:, audience_id:) ⇒ ::String

Create a fully-qualified Audience resource string.

The resource will be in the following format:

‘customers/customer_id/audiences/audience_id`

Parameters:

  • customer_id (String)
  • audience_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


847
848
849
850
851
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 847

def audience_path customer_id:, audience_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/audiences/#{audience_id}"
end

#batch_job_path(customer_id:, batch_job_id:) ⇒ ::String

Create a fully-qualified BatchJob resource string.

The resource will be in the following format:

‘customers/customer_id/batchJobs/batch_job_id`

Parameters:

  • customer_id (String)
  • batch_job_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


864
865
866
867
868
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 864

def batch_job_path customer_id:, batch_job_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/batchJobs/#{batch_job_id}"
end

#bidding_data_exclusion_path(customer_id:, seasonality_event_id:) ⇒ ::String

Create a fully-qualified BiddingDataExclusion resource string.

The resource will be in the following format:

‘customers/customer_id/biddingDataExclusions/seasonality_event_id`

Parameters:

  • customer_id (String)
  • seasonality_event_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


881
882
883
884
885
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 881

def bidding_data_exclusion_path customer_id:, seasonality_event_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/biddingDataExclusions/#{seasonality_event_id}"
end

#bidding_seasonality_adjustment_path(customer_id:, seasonality_event_id:) ⇒ ::String

Create a fully-qualified BiddingSeasonalityAdjustment resource string.

The resource will be in the following format:

‘customers/customer_id/biddingSeasonalityAdjustments/seasonality_event_id`

Parameters:

  • customer_id (String)
  • seasonality_event_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


898
899
900
901
902
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 898

def bidding_seasonality_adjustment_path customer_id:, seasonality_event_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/biddingSeasonalityAdjustments/#{seasonality_event_id}"
end

#bidding_strategy_path(customer_id:, bidding_strategy_id:) ⇒ ::String

Create a fully-qualified BiddingStrategy resource string.

The resource will be in the following format:

‘customers/customer_id/biddingStrategies/bidding_strategy_id`

Parameters:

  • customer_id (String)
  • bidding_strategy_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


915
916
917
918
919
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 915

def bidding_strategy_path customer_id:, bidding_strategy_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/biddingStrategies/#{bidding_strategy_id}"
end

#bidding_strategy_simulation_path(customer_id:, bidding_strategy_id:, type:, modification_method:, start_date:, end_date:) ⇒ ::String

Create a fully-qualified BiddingStrategySimulation resource string.

The resource will be in the following format:

‘customers/customer_id/biddingStrategySimulations/bidding_strategy_id~type~modification_method~start_date~end_date`

Parameters:

  • customer_id (String)
  • bidding_strategy_id (String)
  • type (String)
  • modification_method (String)
  • start_date (String)
  • end_date (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


936
937
938
939
940
941
942
943
944
945
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 936

def bidding_strategy_simulation_path customer_id:, bidding_strategy_id:, type:, modification_method:,
                                     start_date:, end_date:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "bidding_strategy_id cannot contain /" if bidding_strategy_id.to_s.include? "/"
  raise ::ArgumentError, "type cannot contain /" if type.to_s.include? "/"
  raise ::ArgumentError, "modification_method cannot contain /" if modification_method.to_s.include? "/"
  raise ::ArgumentError, "start_date cannot contain /" if start_date.to_s.include? "/"

  "customers/#{customer_id}/biddingStrategySimulations/#{bidding_strategy_id}~#{type}~#{modification_method}~#{start_date}~#{end_date}"
end

#billing_setup_path(customer_id:, billing_setup_id:) ⇒ ::String

Create a fully-qualified BillingSetup resource string.

The resource will be in the following format:

‘customers/customer_id/billingSetups/billing_setup_id`

Parameters:

  • customer_id (String)
  • billing_setup_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


958
959
960
961
962
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 958

def billing_setup_path customer_id:, billing_setup_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/billingSetups/#{billing_setup_id}"
end

#call_view_path(customer_id:, call_detail_id:) ⇒ ::String

Create a fully-qualified CallView resource string.

The resource will be in the following format:

‘customers/customer_id/callViews/call_detail_id`

Parameters:

  • customer_id (String)
  • call_detail_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


975
976
977
978
979
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 975

def call_view_path customer_id:, call_detail_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/callViews/#{call_detail_id}"
end

#campaign_aggregate_asset_view_path(customer_id:, campaign_id:, asset_id:, asset_link_source:, field_type:) ⇒ ::String

Create a fully-qualified CampaignAggregateAssetView resource string.

The resource will be in the following format:

‘customers/customer_id/campaignAggregateAssetViews/campaign_id~asset_id~asset_link_source~field_type`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • asset_id (String)
  • asset_link_source (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1012

def campaign_aggregate_asset_view_path customer_id:, campaign_id:, asset_id:, asset_link_source:,
                                       field_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "asset_id cannot contain /" if asset_id.to_s.include? "/"
  raise ::ArgumentError, "asset_link_source cannot contain /" if asset_link_source.to_s.include? "/"

  "customers/#{customer_id}/campaignAggregateAssetViews/#{campaign_id}~#{asset_id}~#{asset_link_source}~#{field_type}"
end

#campaign_asset_path(customer_id:, campaign_id:, asset_id:, field_type:) ⇒ ::String

Create a fully-qualified CampaignAsset resource string.

The resource will be in the following format:

‘customers/customer_id/campaignAssets/campaign_id~asset_id~field_type`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • asset_id (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1035
1036
1037
1038
1039
1040
1041
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1035

def campaign_asset_path customer_id:, campaign_id:, asset_id:, field_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "asset_id cannot contain /" if asset_id.to_s.include? "/"

  "customers/#{customer_id}/campaignAssets/#{campaign_id}~#{asset_id}~#{field_type}"
end

#campaign_asset_set_path(customer_id:, campaign_id:, asset_set_id:) ⇒ ::String

Create a fully-qualified CampaignAssetSet resource string.

The resource will be in the following format:

‘customers/customer_id/campaignAssetSets/campaign_id~asset_set_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • asset_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1055
1056
1057
1058
1059
1060
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1055

def campaign_asset_set_path customer_id:, campaign_id:, asset_set_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}/campaignAssetSets/#{campaign_id}~#{asset_set_id}"
end

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

Create a fully-qualified CampaignAudienceView resource string.

The resource will be in the following format:

‘customers/customer_id/campaignAudienceViews/campaign_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1074
1075
1076
1077
1078
1079
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1074

def campaign_audience_view_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}/campaignAudienceViews/#{campaign_id}~#{criterion_id}"
end

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

Create a fully-qualified CampaignBidModifier resource string.

The resource will be in the following format:

‘customers/customer_id/campaignBidModifiers/campaign_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1093
1094
1095
1096
1097
1098
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1093

def campaign_bid_modifier_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}/campaignBidModifiers/#{campaign_id}~#{criterion_id}"
end

#campaign_budget_path(customer_id:, campaign_budget_id:) ⇒ ::String

Create a fully-qualified CampaignBudget resource string.

The resource will be in the following format:

‘customers/customer_id/campaignBudgets/campaign_budget_id`

Parameters:

  • customer_id (String)
  • campaign_budget_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1111
1112
1113
1114
1115
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1111

def campaign_budget_path customer_id:, campaign_budget_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/campaignBudgets/#{campaign_budget_id}"
end

#campaign_conversion_goal_path(customer_id:, campaign_id:, category:, source:) ⇒ ::String

Create a fully-qualified CampaignConversionGoal resource string.

The resource will be in the following format:

‘customers/customer_id/campaignConversionGoals/campaign_id~category~source`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • category (String)
  • source (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1130
1131
1132
1133
1134
1135
1136
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1130

def campaign_conversion_goal_path customer_id:, campaign_id:, category:, source:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "category cannot contain /" if category.to_s.include? "/"

  "customers/#{customer_id}/campaignConversionGoals/#{campaign_id}~#{category}~#{source}"
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)


1150
1151
1152
1153
1154
1155
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1150

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


1169
1170
1171
1172
1173
1174
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1169

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_draft_path(customer_id:, base_campaign_id:, draft_id:) ⇒ ::String

Create a fully-qualified CampaignDraft resource string.

The resource will be in the following format:

‘customers/customer_id/campaignDrafts/base_campaign_id~draft_id`

Parameters:

  • customer_id (String)
  • base_campaign_id (String)
  • draft_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1188
1189
1190
1191
1192
1193
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1188

def campaign_draft_path customer_id:, base_campaign_id:, draft_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "base_campaign_id cannot contain /" if base_campaign_id.to_s.include? "/"

  "customers/#{customer_id}/campaignDrafts/#{base_campaign_id}~#{draft_id}"
end

#campaign_extension_setting_path(customer_id:, campaign_id:, extension_type:) ⇒ ::String

Create a fully-qualified CampaignExtensionSetting resource string.

The resource will be in the following format:

‘customers/customer_id/campaignExtensionSettings/campaign_id~extension_type`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • extension_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1207
1208
1209
1210
1211
1212
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1207

def campaign_extension_setting_path customer_id:, campaign_id:, extension_type:
  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}/campaignExtensionSettings/#{campaign_id}~#{extension_type}"
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)


1226
1227
1228
1229
1230
1231
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1226

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_group_path(customer_id:, campaign_group_id:) ⇒ ::String

Create a fully-qualified CampaignGroup resource string.

The resource will be in the following format:

‘customers/customer_id/campaignGroups/campaign_group_id`

Parameters:

  • customer_id (String)
  • campaign_group_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1244
1245
1246
1247
1248
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1244

def campaign_group_path customer_id:, campaign_group_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/campaignGroups/#{campaign_group_id}"
end

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


1262
1263
1264
1265
1266
1267
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1262

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

Create a fully-qualified CampaignLifecycleGoal resource string.

The resource will be in the following format:

‘customers/customer_id/campaignLifecycleGoals/campaign_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1280
1281
1282
1283
1284
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1280

def campaign_lifecycle_goal_path customer_id:, campaign_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/campaignLifecycleGoals/#{campaign_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)


992
993
994
995
996
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 992

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

#campaign_search_term_insight_path(customer_id:, campaign_id:, cluster_id:) ⇒ ::String

Create a fully-qualified CampaignSearchTermInsight resource string.

The resource will be in the following format:

‘customers/customer_id/campaignSearchTermInsights/campaign_id~cluster_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • cluster_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1298
1299
1300
1301
1302
1303
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1298

def campaign_search_term_insight_path customer_id:, campaign_id:, cluster_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}/campaignSearchTermInsights/#{campaign_id}~#{cluster_id}"
end

#campaign_shared_set_path(customer_id:, campaign_id:, shared_set_id:) ⇒ ::String

Create a fully-qualified CampaignSharedSet resource string.

The resource will be in the following format:

‘customers/customer_id/campaignSharedSets/campaign_id~shared_set_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • shared_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1317
1318
1319
1320
1321
1322
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1317

def campaign_shared_set_path customer_id:, campaign_id:, shared_set_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}/campaignSharedSets/#{campaign_id}~#{shared_set_id}"
end

#campaign_simulation_path(customer_id:, campaign_id:, type:, modification_method:, start_date:, end_date:) ⇒ ::String

Create a fully-qualified CampaignSimulation resource string.

The resource will be in the following format:

‘customers/customer_id/campaignSimulations/campaign_id~type~modification_method~start_date~end_date`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • type (String)
  • modification_method (String)
  • start_date (String)
  • end_date (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1339

def campaign_simulation_path customer_id:, campaign_id:, type:, modification_method:, start_date:,
                             end_date:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "type cannot contain /" if type.to_s.include? "/"
  raise ::ArgumentError, "modification_method cannot contain /" if modification_method.to_s.include? "/"
  raise ::ArgumentError, "start_date cannot contain /" if start_date.to_s.include? "/"

  "customers/#{customer_id}/campaignSimulations/#{campaign_id}~#{type}~#{modification_method}~#{start_date}~#{end_date}"
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)


1360
1361
1362
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1360

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

#change_event_path(customer_id:, timestamp_micros:, command_index:, mutate_index:) ⇒ ::String

Create a fully-qualified ChangeEvent resource string.

The resource will be in the following format:

‘customers/customer_id/changeEvents/timestamp_micros~command_index~mutate_index`

Parameters:

  • customer_id (String)
  • timestamp_micros (String)
  • command_index (String)
  • mutate_index (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1377
1378
1379
1380
1381
1382
1383
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1377

def change_event_path customer_id:, timestamp_micros:, command_index:, mutate_index:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "timestamp_micros cannot contain /" if timestamp_micros.to_s.include? "/"
  raise ::ArgumentError, "command_index cannot contain /" if command_index.to_s.include? "/"

  "customers/#{customer_id}/changeEvents/#{timestamp_micros}~#{command_index}~#{mutate_index}"
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)


1396
1397
1398
1399
1400
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1396

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

#channel_aggregate_asset_view_path(customer_id:, advertising_channel_type:, asset_id:, asset_source:, field_type:) ⇒ ::String

Create a fully-qualified ChannelAggregateAssetView resource string.

The resource will be in the following format:

‘customers/customer_id/channelAggregateAssetViews/advertising_channel_type~asset_id~asset_source~field_type`

Parameters:

  • customer_id (String)
  • advertising_channel_type (String)
  • asset_id (String)
  • asset_source (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1416

def channel_aggregate_asset_view_path customer_id:, advertising_channel_type:, asset_id:, asset_source:,
                                      field_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  if advertising_channel_type.to_s.include? "/"
    raise ::ArgumentError,
          "advertising_channel_type cannot contain /"
  end
  raise ::ArgumentError, "asset_id cannot contain /" if asset_id.to_s.include? "/"
  raise ::ArgumentError, "asset_source cannot contain /" if asset_source.to_s.include? "/"

  "customers/#{customer_id}/channelAggregateAssetViews/#{advertising_channel_type}~#{asset_id}~#{asset_source}~#{field_type}"
end

#click_view_path(customer_id:, date:, gclid:) ⇒ ::String

Create a fully-qualified ClickView resource string.

The resource will be in the following format:

‘customers/customer_id/clickViews/date~gclid`

Parameters:

  • customer_id (String)
  • date (String)
  • gclid (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1441
1442
1443
1444
1445
1446
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1441

def click_view_path customer_id:, date:, gclid:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "date cannot contain /" if date.to_s.include? "/"

  "customers/#{customer_id}/clickViews/#{date}~#{gclid}"
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)


1459
1460
1461
1462
1463
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1459

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

#conversion_action_path(customer_id:, conversion_action_id:) ⇒ ::String

Create a fully-qualified ConversionAction resource string.

The resource will be in the following format:

‘customers/customer_id/conversionActions/conversion_action_id`

Parameters:

  • customer_id (String)
  • conversion_action_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1476
1477
1478
1479
1480
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1476

def conversion_action_path customer_id:, conversion_action_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/conversionActions/#{conversion_action_id}"
end

#conversion_custom_variable_path(customer_id:, conversion_custom_variable_id:) ⇒ ::String

Create a fully-qualified ConversionCustomVariable resource string.

The resource will be in the following format:

‘customers/customer_id/conversionCustomVariables/conversion_custom_variable_id`

Parameters:

  • customer_id (String)
  • conversion_custom_variable_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1493
1494
1495
1496
1497
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1493

def conversion_custom_variable_path customer_id:, conversion_custom_variable_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/conversionCustomVariables/#{conversion_custom_variable_id}"
end

#conversion_goal_campaign_config_path(customer_id:, campaign_id:) ⇒ ::String

Create a fully-qualified ConversionGoalCampaignConfig resource string.

The resource will be in the following format:

‘customers/customer_id/conversionGoalCampaignConfigs/campaign_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1510
1511
1512
1513
1514
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1510

def conversion_goal_campaign_config_path customer_id:, campaign_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/conversionGoalCampaignConfigs/#{campaign_id}"
end

#conversion_value_rule_path(customer_id:, conversion_value_rule_id:) ⇒ ::String

Create a fully-qualified ConversionValueRule resource string.

The resource will be in the following format:

‘customers/customer_id/conversionValueRules/conversion_value_rule_id`

Parameters:

  • customer_id (String)
  • conversion_value_rule_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1527
1528
1529
1530
1531
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1527

def conversion_value_rule_path customer_id:, conversion_value_rule_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/conversionValueRules/#{conversion_value_rule_id}"
end

#conversion_value_rule_set_path(customer_id:, conversion_value_rule_set_id:) ⇒ ::String

Create a fully-qualified ConversionValueRuleSet resource string.

The resource will be in the following format:

‘customers/customer_id/conversionValueRuleSets/conversion_value_rule_set_id`

Parameters:

  • customer_id (String)
  • conversion_value_rule_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1544
1545
1546
1547
1548
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1544

def conversion_value_rule_set_path customer_id:, conversion_value_rule_set_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/conversionValueRuleSets/#{conversion_value_rule_set_id}"
end

#currency_constant_path(code:) ⇒ ::String

Create a fully-qualified CurrencyConstant resource string.

The resource will be in the following format:

‘currencyConstants/code`

Parameters:

  • code (String)

Returns:

  • (::String)


1560
1561
1562
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1560

def currency_constant_path code:
  "currencyConstants/#{code}"
end

#custom_audience_path(customer_id:, custom_audience_id:) ⇒ ::String

Create a fully-qualified CustomAudience resource string.

The resource will be in the following format:

‘customers/customer_id/customAudiences/custom_audience_id`

Parameters:

  • customer_id (String)
  • custom_audience_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1575
1576
1577
1578
1579
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1575

def custom_audience_path customer_id:, custom_audience_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customAudiences/#{custom_audience_id}"
end

#custom_conversion_goal_path(customer_id:, goal_id:) ⇒ ::String

Create a fully-qualified CustomConversionGoal resource string.

The resource will be in the following format:

‘customers/customer_id/customConversionGoals/goal_id`

Parameters:

  • customer_id (String)
  • goal_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1592
1593
1594
1595
1596
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1592

def custom_conversion_goal_path customer_id:, goal_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customConversionGoals/#{goal_id}"
end

#custom_interest_path(customer_id:, custom_interest_id:) ⇒ ::String

Create a fully-qualified CustomInterest resource string.

The resource will be in the following format:

‘customers/customer_id/customInterests/custom_interest_id`

Parameters:

  • customer_id (String)
  • custom_interest_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1609
1610
1611
1612
1613
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1609

def custom_interest_path customer_id:, custom_interest_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customInterests/#{custom_interest_id}"
end

#customer_asset_path(customer_id:, asset_id:, field_type:) ⇒ ::String

Create a fully-qualified CustomerAsset resource string.

The resource will be in the following format:

‘customers/customer_id/customerAssets/asset_id~field_type`

Parameters:

  • customer_id (String)
  • asset_id (String)
  • field_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1641
1642
1643
1644
1645
1646
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1641

def customer_asset_path customer_id:, asset_id:, field_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "asset_id cannot contain /" if asset_id.to_s.include? "/"

  "customers/#{customer_id}/customerAssets/#{asset_id}~#{field_type}"
end

#customer_asset_set_path(customer_id:, asset_set_id:) ⇒ ::String

Create a fully-qualified CustomerAssetSet resource string.

The resource will be in the following format:

‘customers/customer_id/customerAssetSets/asset_set_id`

Parameters:

  • customer_id (String)
  • asset_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1659
1660
1661
1662
1663
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1659

def customer_asset_set_path customer_id:, asset_set_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerAssetSets/#{asset_set_id}"
end

Create a fully-qualified CustomerClientLink resource string.

The resource will be in the following format:

‘customers/customer_id/customerClientLinks/client_customer_id~manager_link_id`

Parameters:

  • customer_id (String)
  • client_customer_id (String)
  • manager_link_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1694
1695
1696
1697
1698
1699
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1694

def customer_client_link_path customer_id:, client_customer_id:, manager_link_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "client_customer_id cannot contain /" if client_customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerClientLinks/#{client_customer_id}~#{manager_link_id}"
end

#customer_client_path(customer_id:, client_customer_id:) ⇒ ::String

Create a fully-qualified CustomerClient resource string.

The resource will be in the following format:

‘customers/customer_id/customerClients/client_customer_id`

Parameters:

  • customer_id (String)
  • client_customer_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1676
1677
1678
1679
1680
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1676

def customer_client_path customer_id:, client_customer_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerClients/#{client_customer_id}"
end

#customer_conversion_goal_path(customer_id:, category:, source:) ⇒ ::String

Create a fully-qualified CustomerConversionGoal resource string.

The resource will be in the following format:

‘customers/customer_id/customerConversionGoals/category~source`

Parameters:

  • customer_id (String)
  • category (String)
  • source (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1713
1714
1715
1716
1717
1718
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1713

def customer_conversion_goal_path customer_id:, category:, source:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "category cannot contain /" if category.to_s.include? "/"

  "customers/#{customer_id}/customerConversionGoals/#{category}~#{source}"
end

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

Create a fully-qualified CustomerCustomizer resource string.

The resource will be in the following format:

‘customers/customer_id/customerCustomizers/customizer_attribute_id`

Parameters:

  • customer_id (String)
  • customizer_attribute_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1731
1732
1733
1734
1735
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1731

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

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

#customer_extension_setting_path(customer_id:, extension_type:) ⇒ ::String

Create a fully-qualified CustomerExtensionSetting resource string.

The resource will be in the following format:

‘customers/customer_id/customerExtensionSettings/extension_type`

Parameters:

  • customer_id (String)
  • extension_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1748
1749
1750
1751
1752
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1748

def customer_extension_setting_path customer_id:, extension_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerExtensionSettings/#{extension_type}"
end

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

Create a fully-qualified CustomerFeed resource string.

The resource will be in the following format:

‘customers/customer_id/customerFeeds/feed_id`

Parameters:

  • customer_id (String)
  • feed_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1765
1766
1767
1768
1769
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1765

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

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

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

Create a fully-qualified CustomerLabel resource string.

The resource will be in the following format:

‘customers/customer_id/customerLabels/label_id`

Parameters:

  • customer_id (String)
  • label_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1782
1783
1784
1785
1786
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1782

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

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

#customer_lifecycle_goal_path(customer_id:) ⇒ ::String

Create a fully-qualified CustomerLifecycleGoal resource string.

The resource will be in the following format:

‘customers/customer_id/customerLifecycleGoals`

Parameters:

  • customer_id (String)

Returns:

  • (::String)


1798
1799
1800
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1798

def customer_lifecycle_goal_path customer_id:
  "customers/#{customer_id}/customerLifecycleGoals"
end

Create a fully-qualified CustomerManagerLink resource string.

The resource will be in the following format:

‘customers/customer_id/customerManagerLinks/manager_customer_id~manager_link_id`

Parameters:

  • customer_id (String)
  • manager_customer_id (String)
  • manager_link_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1814
1815
1816
1817
1818
1819
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1814

def customer_manager_link_path customer_id:, manager_customer_id:, manager_link_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "manager_customer_id cannot contain /" if manager_customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerManagerLinks/#{manager_customer_id}~#{manager_link_id}"
end

#customer_negative_criterion_path(customer_id:, criterion_id:) ⇒ ::String

Create a fully-qualified CustomerNegativeCriterion resource string.

The resource will be in the following format:

‘customers/customer_id/customerNegativeCriteria/criterion_id`

Parameters:

  • customer_id (String)
  • criterion_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1832
1833
1834
1835
1836
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1832

def customer_negative_criterion_path customer_id:, criterion_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerNegativeCriteria/#{criterion_id}"
end

#customer_path(customer_id:) ⇒ ::String

Create a fully-qualified Customer resource string.

The resource will be in the following format:

‘customers/customer_id`

Parameters:

  • customer_id (String)

Returns:

  • (::String)


1625
1626
1627
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1625

def customer_path customer_id:
  "customers/#{customer_id}"
end

#customer_search_term_insight_path(customer_id:, cluster_id:) ⇒ ::String

Create a fully-qualified CustomerSearchTermInsight resource string.

The resource will be in the following format:

‘customers/customer_id/customerSearchTermInsights/cluster_id`

Parameters:

  • customer_id (String)
  • cluster_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1849
1850
1851
1852
1853
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1849

def customer_search_term_insight_path customer_id:, cluster_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerSearchTermInsights/#{cluster_id}"
end

#customer_user_access_invitation_path(customer_id:, invitation_id:) ⇒ ::String

Create a fully-qualified CustomerUserAccessInvitation resource string.

The resource will be in the following format:

‘customers/customer_id/customerUserAccessInvitations/invitation_id`

Parameters:

  • customer_id (String)
  • invitation_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1883
1884
1885
1886
1887
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1883

def customer_user_access_invitation_path customer_id:, invitation_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerUserAccessInvitations/#{invitation_id}"
end

#customer_user_access_path(customer_id:, user_id:) ⇒ ::String

Create a fully-qualified CustomerUserAccess resource string.

The resource will be in the following format:

‘customers/customer_id/customerUserAccesses/user_id`

Parameters:

  • customer_id (String)
  • user_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1866
1867
1868
1869
1870
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1866

def customer_user_access_path customer_id:, user_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/customerUserAccesses/#{user_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)


1900
1901
1902
1903
1904
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1900

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

#detail_placement_view_path(customer_id:, ad_group_id:, base64_placement:) ⇒ ::String

Create a fully-qualified DetailPlacementView resource string.

The resource will be in the following format:

‘customers/customer_id/detailPlacementViews/ad_group_id~base64_placement`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • base64_placement (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1918
1919
1920
1921
1922
1923
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1918

def detail_placement_view_path customer_id:, ad_group_id:, base64_placement:
  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}/detailPlacementViews/#{ad_group_id}~#{base64_placement}"
end

#detailed_demographic_path(customer_id:, detailed_demographic_id:) ⇒ ::String

Create a fully-qualified DetailedDemographic resource string.

The resource will be in the following format:

‘customers/customer_id/detailedDemographics/detailed_demographic_id`

Parameters:

  • customer_id (String)
  • detailed_demographic_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1936
1937
1938
1939
1940
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1936

def detailed_demographic_path customer_id:, detailed_demographic_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/detailedDemographics/#{detailed_demographic_id}"
end

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

Create a fully-qualified DisplayKeywordView resource string.

The resource will be in the following format:

‘customers/customer_id/displayKeywordViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1954
1955
1956
1957
1958
1959
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1954

def display_keyword_view_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}/displayKeywordViews/#{ad_group_id}~#{criterion_id}"
end

#distance_view_path(customer_id:, placeholder_chain_id:, distance_bucket:) ⇒ ::String

Create a fully-qualified DistanceView resource string.

The resource will be in the following format:

‘customers/customer_id/distanceViews/placeholder_chain_id~distance_bucket`

Parameters:

  • customer_id (String)
  • placeholder_chain_id (String)
  • distance_bucket (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1973
1974
1975
1976
1977
1978
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1973

def distance_view_path customer_id:, placeholder_chain_id:, distance_bucket:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "placeholder_chain_id cannot contain /" if placeholder_chain_id.to_s.include? "/"

  "customers/#{customer_id}/distanceViews/#{placeholder_chain_id}~#{distance_bucket}"
end

#domain_category_path(customer_id:, campaign_id:, base64_category:, language_code:) ⇒ ::String

Create a fully-qualified DomainCategory resource string.

The resource will be in the following format:

‘customers/customer_id/domainCategories/campaign_id~base64_category~language_code`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • base64_category (String)
  • language_code (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


1993
1994
1995
1996
1997
1998
1999
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 1993

def domain_category_path customer_id:, campaign_id:, base64_category:, language_code:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "base64_category cannot contain /" if base64_category.to_s.include? "/"

  "customers/#{customer_id}/domainCategories/#{campaign_id}~#{base64_category}~#{language_code}"
end

#dynamic_search_ads_search_term_view_path(customer_id:, ad_group_id:, search_term_fingerprint:, headline_fingerprint:, landing_page_fingerprint:, page_url_fingerprint:) ⇒ ::String

Create a fully-qualified DynamicSearchAdsSearchTermView resource string.

The resource will be in the following format:

‘customers/customer_id/dynamicSearchAdsSearchTermViews/ad_group_id~search_term_fingerprint~headline_fingerprint~landing_page_fingerprint~page_url_fingerprint`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • search_term_fingerprint (String)
  • headline_fingerprint (String)
  • landing_page_fingerprint (String)
  • page_url_fingerprint (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2016

def dynamic_search_ads_search_term_view_path customer_id:, ad_group_id:, search_term_fingerprint:,
                                             headline_fingerprint:, landing_page_fingerprint:, page_url_fingerprint:
  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? "/"
  if search_term_fingerprint.to_s.include? "/"
    raise ::ArgumentError,
          "search_term_fingerprint cannot contain /"
  end
  raise ::ArgumentError, "headline_fingerprint cannot contain /" if headline_fingerprint.to_s.include? "/"
  if landing_page_fingerprint.to_s.include? "/"
    raise ::ArgumentError,
          "landing_page_fingerprint cannot contain /"
  end

  "customers/#{customer_id}/dynamicSearchAdsSearchTermViews/#{ad_group_id}~#{search_term_fingerprint}~#{headline_fingerprint}~#{landing_page_fingerprint}~#{page_url_fingerprint}"
end

#expanded_landing_page_view_path(customer_id:, expanded_final_url_fingerprint:) ⇒ ::String

Create a fully-qualified ExpandedLandingPageView resource string.

The resource will be in the following format:

‘customers/customer_id/expandedLandingPageViews/expanded_final_url_fingerprint`

Parameters:

  • customer_id (String)
  • expanded_final_url_fingerprint (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2044
2045
2046
2047
2048
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2044

def expanded_landing_page_view_path customer_id:, expanded_final_url_fingerprint:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/expandedLandingPageViews/#{expanded_final_url_fingerprint}"
end

#experiment_arm_path(customer_id:, trial_id:, trial_arm_id:) ⇒ ::String

Create a fully-qualified ExperimentArm resource string.

The resource will be in the following format:

‘customers/customer_id/experimentArms/trial_id~trial_arm_id`

Parameters:

  • customer_id (String)
  • trial_id (String)
  • trial_arm_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2079
2080
2081
2082
2083
2084
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2079

def experiment_arm_path customer_id:, trial_id:, trial_arm_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "trial_id cannot contain /" if trial_id.to_s.include? "/"

  "customers/#{customer_id}/experimentArms/#{trial_id}~#{trial_arm_id}"
end

#experiment_path(customer_id:, trial_id:) ⇒ ::String

Create a fully-qualified Experiment resource string.

The resource will be in the following format:

‘customers/customer_id/experiments/trial_id`

Parameters:

  • customer_id (String)
  • trial_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2061
2062
2063
2064
2065
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2061

def experiment_path customer_id:, trial_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/experiments/#{trial_id}"
end

#extension_feed_item_path(customer_id:, feed_item_id:) ⇒ ::String

Create a fully-qualified ExtensionFeedItem resource string.

The resource will be in the following format:

‘customers/customer_id/extensionFeedItems/feed_item_id`

Parameters:

  • customer_id (String)
  • feed_item_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2097
2098
2099
2100
2101
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2097

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

  "customers/#{customer_id}/extensionFeedItems/#{feed_item_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)


2132
2133
2134
2135
2136
2137
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2132

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

Create a fully-qualified FeedItemSetLink resource string.

The resource will be in the following format:

‘customers/customer_id/feedItemSetLinks/feed_id~feed_item_set_id~feed_item_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2171
2172
2173
2174
2175
2176
2177
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2171

def feed_item_set_link_path customer_id:, feed_id:, feed_item_set_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? "/"
  raise ::ArgumentError, "feed_item_set_id cannot contain /" if feed_item_set_id.to_s.include? "/"

  "customers/#{customer_id}/feedItemSetLinks/#{feed_id}~#{feed_item_set_id}~#{feed_item_id}"
end

#feed_item_set_path(customer_id:, feed_id:, feed_item_set_id:) ⇒ ::String

Create a fully-qualified FeedItemSet resource string.

The resource will be in the following format:

‘customers/customer_id/feedItemSets/feed_id~feed_item_set_id`

Parameters:

  • customer_id (String)
  • feed_id (String)
  • feed_item_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2151
2152
2153
2154
2155
2156
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2151

def feed_item_set_path customer_id:, feed_id:, feed_item_set_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}/feedItemSets/#{feed_id}~#{feed_item_set_id}"
end

#feed_item_target_path(customer_id:, feed_id:, feed_item_id:, feed_item_target_type:, feed_item_target_id:) ⇒ ::String

Create a fully-qualified FeedItemTarget resource string.

The resource will be in the following format:

‘customers/customer_id/feedItemTargets/feed_id~feed_item_id~feed_item_target_type~feed_item_target_id`

Parameters:

  • customer_id (String)
  • feed_id (String)
  • feed_item_id (String)
  • feed_item_target_type (String)
  • feed_item_target_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2193

def feed_item_target_path customer_id:, feed_id:, feed_item_id:, feed_item_target_type:,
                          feed_item_target_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? "/"
  raise ::ArgumentError, "feed_item_id cannot contain /" if feed_item_id.to_s.include? "/"
  if feed_item_target_type.to_s.include? "/"
    raise ::ArgumentError,
          "feed_item_target_type cannot contain /"
  end

  "customers/#{customer_id}/feedItemTargets/#{feed_id}~#{feed_item_id}~#{feed_item_target_type}~#{feed_item_target_id}"
end

#feed_mapping_path(customer_id:, feed_id:, feed_mapping_id:) ⇒ ::String

Create a fully-qualified FeedMapping resource string.

The resource will be in the following format:

‘customers/customer_id/feedMappings/feed_id~feed_mapping_id`

Parameters:

  • customer_id (String)
  • feed_id (String)
  • feed_mapping_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2218
2219
2220
2221
2222
2223
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2218

def feed_mapping_path customer_id:, feed_id:, feed_mapping_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}/feedMappings/#{feed_id}~#{feed_mapping_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)


2114
2115
2116
2117
2118
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2114

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

#feed_placeholder_view_path(customer_id:, placeholder_type:) ⇒ ::String

Create a fully-qualified FeedPlaceholderView resource string.

The resource will be in the following format:

‘customers/customer_id/feedPlaceholderViews/placeholder_type`

Parameters:

  • customer_id (String)
  • placeholder_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2236
2237
2238
2239
2240
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2236

def feed_placeholder_view_path customer_id:, placeholder_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/feedPlaceholderViews/#{placeholder_type}"
end

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

Create a fully-qualified GenderView resource string.

The resource will be in the following format:

‘customers/customer_id/genderViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2254
2255
2256
2257
2258
2259
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2254

def gender_view_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}/genderViews/#{ad_group_id}~#{criterion_id}"
end

#geo_target_constant_path(criterion_id:) ⇒ ::String

Create a fully-qualified GeoTargetConstant resource string.

The resource will be in the following format:

‘geoTargetConstants/criterion_id`

Parameters:

  • criterion_id (String)

Returns:

  • (::String)


2271
2272
2273
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2271

def geo_target_constant_path criterion_id:
  "geoTargetConstants/#{criterion_id}"
end

#geographic_view_path(customer_id:, country_criterion_id:, location_type:) ⇒ ::String

Create a fully-qualified GeographicView resource string.

The resource will be in the following format:

‘customers/customer_id/geographicViews/country_criterion_id~location_type`

Parameters:

  • customer_id (String)
  • country_criterion_id (String)
  • location_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2287
2288
2289
2290
2291
2292
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2287

def geographic_view_path customer_id:, country_criterion_id:, location_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "country_criterion_id cannot contain /" if country_criterion_id.to_s.include? "/"

  "customers/#{customer_id}/geographicViews/#{country_criterion_id}~#{location_type}"
end

#group_placement_view_path(customer_id:, ad_group_id:, base64_placement:) ⇒ ::String

Create a fully-qualified GroupPlacementView resource string.

The resource will be in the following format:

‘customers/customer_id/groupPlacementViews/ad_group_id~base64_placement`

Parameters:

  • customer_id (String)
  • ad_group_id (String)
  • base64_placement (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2306
2307
2308
2309
2310
2311
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2306

def group_placement_view_path customer_id:, ad_group_id:, base64_placement:
  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}/groupPlacementViews/#{ad_group_id}~#{base64_placement}"
end

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

Create a fully-qualified HotelGroupView resource string.

The resource will be in the following format:

‘customers/customer_id/hotelGroupViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2325
2326
2327
2328
2329
2330
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2325

def hotel_group_view_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}/hotelGroupViews/#{ad_group_id}~#{criterion_id}"
end

#hotel_performance_view_path(customer_id:) ⇒ ::String

Create a fully-qualified HotelPerformanceView resource string.

The resource will be in the following format:

‘customers/customer_id/hotelPerformanceView`

Parameters:

  • customer_id (String)

Returns:

  • (::String)


2342
2343
2344
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2342

def hotel_performance_view_path customer_id:
  "customers/#{customer_id}/hotelPerformanceView"
end

#hotel_reconciliation_path(customer_id:, commission_id:) ⇒ ::String

Create a fully-qualified HotelReconciliation resource string.

The resource will be in the following format:

‘customers/customer_id/hotelReconciliations/commission_id`

Parameters:

  • customer_id (String)
  • commission_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2357
2358
2359
2360
2361
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2357

def hotel_reconciliation_path customer_id:, commission_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/hotelReconciliations/#{commission_id}"
end

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

Create a fully-qualified IncomeRangeView resource string.

The resource will be in the following format:

‘customers/customer_id/incomeRangeViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2375
2376
2377
2378
2379
2380
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2375

def income_range_view_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}/incomeRangeViews/#{ad_group_id}~#{criterion_id}"
end

#keyword_plan_ad_group_keyword_path(customer_id:, keyword_plan_ad_group_keyword_id:) ⇒ ::String

Create a fully-qualified KeywordPlanAdGroupKeyword resource string.

The resource will be in the following format:

‘customers/customer_id/keywordPlanAdGroupKeywords/keyword_plan_ad_group_keyword_id`

Parameters:

  • customer_id (String)
  • keyword_plan_ad_group_keyword_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2427
2428
2429
2430
2431
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2427

def keyword_plan_ad_group_keyword_path customer_id:, keyword_plan_ad_group_keyword_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/keywordPlanAdGroupKeywords/#{keyword_plan_ad_group_keyword_id}"
end

#keyword_plan_ad_group_path(customer_id:, keyword_plan_ad_group_id:) ⇒ ::String

Create a fully-qualified KeywordPlanAdGroup resource string.

The resource will be in the following format:

‘customers/customer_id/keywordPlanAdGroups/keyword_plan_ad_group_id`

Parameters:

  • customer_id (String)
  • keyword_plan_ad_group_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2410
2411
2412
2413
2414
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2410

def keyword_plan_ad_group_path customer_id:, keyword_plan_ad_group_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/keywordPlanAdGroups/#{keyword_plan_ad_group_id}"
end

#keyword_plan_campaign_keyword_path(customer_id:, keyword_plan_campaign_keyword_id:) ⇒ ::String

Create a fully-qualified KeywordPlanCampaignKeyword resource string.

The resource will be in the following format:

‘customers/customer_id/keywordPlanCampaignKeywords/keyword_plan_campaign_keyword_id`

Parameters:

  • customer_id (String)
  • keyword_plan_campaign_keyword_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2461
2462
2463
2464
2465
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2461

def keyword_plan_campaign_keyword_path customer_id:, keyword_plan_campaign_keyword_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/keywordPlanCampaignKeywords/#{keyword_plan_campaign_keyword_id}"
end

#keyword_plan_campaign_path(customer_id:, keyword_plan_campaign_id:) ⇒ ::String

Create a fully-qualified KeywordPlanCampaign resource string.

The resource will be in the following format:

‘customers/customer_id/keywordPlanCampaigns/keyword_plan_campaign_id`

Parameters:

  • customer_id (String)
  • keyword_plan_campaign_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2444
2445
2446
2447
2448
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2444

def keyword_plan_campaign_path customer_id:, keyword_plan_campaign_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/keywordPlanCampaigns/#{keyword_plan_campaign_id}"
end

#keyword_plan_path(customer_id:, keyword_plan_id:) ⇒ ::String

Create a fully-qualified KeywordPlan resource string.

The resource will be in the following format:

‘customers/customer_id/keywordPlans/keyword_plan_id`

Parameters:

  • customer_id (String)
  • keyword_plan_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2393
2394
2395
2396
2397
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2393

def keyword_plan_path customer_id:, keyword_plan_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/keywordPlans/#{keyword_plan_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)


2478
2479
2480
2481
2482
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2478

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

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

Create a fully-qualified KeywordView resource string.

The resource will be in the following format:

‘customers/customer_id/keywordViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2496
2497
2498
2499
2500
2501
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2496

def keyword_view_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}/keywordViews/#{ad_group_id}~#{criterion_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)


2514
2515
2516
2517
2518
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2514

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

#landing_page_view_path(customer_id:, unexpanded_final_url_fingerprint:) ⇒ ::String

Create a fully-qualified LandingPageView resource string.

The resource will be in the following format:

‘customers/customer_id/landingPageViews/unexpanded_final_url_fingerprint`

Parameters:

  • customer_id (String)
  • unexpanded_final_url_fingerprint (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2531
2532
2533
2534
2535
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2531

def landing_page_view_path customer_id:, unexpanded_final_url_fingerprint:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/landingPageViews/#{unexpanded_final_url_fingerprint}"
end

#language_constant_path(criterion_id:) ⇒ ::String

Create a fully-qualified LanguageConstant resource string.

The resource will be in the following format:

‘languageConstants/criterion_id`

Parameters:

  • criterion_id (String)

Returns:

  • (::String)


2547
2548
2549
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2547

def language_constant_path criterion_id:
  "languageConstants/#{criterion_id}"
end

#lead_form_submission_data_path(customer_id:, lead_form_user_submission_id:) ⇒ ::String

Create a fully-qualified LeadFormSubmissionData resource string.

The resource will be in the following format:

‘customers/customer_id/leadFormSubmissionData/lead_form_user_submission_id`

Parameters:

  • customer_id (String)
  • lead_form_user_submission_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2562
2563
2564
2565
2566
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2562

def lead_form_submission_data_path customer_id:, lead_form_user_submission_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/leadFormSubmissionData/#{lead_form_user_submission_id}"
end

#life_event_path(customer_id:, life_event_id:) ⇒ ::String

Create a fully-qualified LifeEvent resource string.

The resource will be in the following format:

‘customers/customer_id/lifeEvents/life_event_id`

Parameters:

  • customer_id (String)
  • life_event_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2579
2580
2581
2582
2583
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2579

def life_event_path customer_id:, life_event_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/lifeEvents/#{life_event_id}"
end

#local_services_employee_path(customer_id:, gls_employee_id:) ⇒ ::String

Create a fully-qualified LocalServicesEmployee resource string.

The resource will be in the following format:

‘customers/customer_id/localServicesEmployees/gls_employee_id`

Parameters:

  • customer_id (String)
  • gls_employee_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2596
2597
2598
2599
2600
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2596

def local_services_employee_path customer_id:, gls_employee_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/localServicesEmployees/#{gls_employee_id}"
end

#local_services_lead_conversation_path(customer_id:, local_services_lead_conversation_id:) ⇒ ::String

Create a fully-qualified LocalServicesLeadConversation resource string.

The resource will be in the following format:

‘customers/customer_id/localServicesLeadConversations/local_services_lead_conversation_id`

Parameters:

  • customer_id (String)
  • local_services_lead_conversation_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2630
2631
2632
2633
2634
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2630

def local_services_lead_conversation_path customer_id:, local_services_lead_conversation_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/localServicesLeadConversations/#{local_services_lead_conversation_id}"
end

#local_services_lead_path(customer_id:, local_services_lead_id:) ⇒ ::String

Create a fully-qualified LocalServicesLead resource string.

The resource will be in the following format:

‘customers/customer_id/localServicesLeads/local_services_lead_id`

Parameters:

  • customer_id (String)
  • local_services_lead_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2613
2614
2615
2616
2617
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2613

def local_services_lead_path customer_id:, local_services_lead_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/localServicesLeads/#{local_services_lead_id}"
end

#local_services_verification_artifact_path(customer_id:, gls_verification_artifact_id:) ⇒ ::String

Create a fully-qualified LocalServicesVerificationArtifact resource string.

The resource will be in the following format:

‘customers/customer_id/localServicesVerificationArtifacts/gls_verification_artifact_id`

Parameters:

  • customer_id (String)
  • gls_verification_artifact_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2647
2648
2649
2650
2651
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2647

def local_services_verification_artifact_path customer_id:, gls_verification_artifact_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/localServicesVerificationArtifacts/#{gls_verification_artifact_id}"
end

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

Create a fully-qualified LocationView resource string.

The resource will be in the following format:

‘customers/customer_id/locationViews/campaign_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2665
2666
2667
2668
2669
2670
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2665

def location_view_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}/locationViews/#{campaign_id}~#{criterion_id}"
end

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

Create a fully-qualified ManagedPlacementView resource string.

The resource will be in the following format:

‘customers/customer_id/managedPlacementViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2684
2685
2686
2687
2688
2689
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2684

def managed_placement_view_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}/managedPlacementViews/#{ad_group_id}~#{criterion_id}"
end

#media_file_path(customer_id:, media_file_id:) ⇒ ::String

Create a fully-qualified MediaFile resource string.

The resource will be in the following format:

‘customers/customer_id/mediaFiles/media_file_id`

Parameters:

  • customer_id (String)
  • media_file_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2702
2703
2704
2705
2706
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2702

def media_file_path customer_id:, media_file_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/mediaFiles/#{media_file_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)


2718
2719
2720
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2718

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)


2732
2733
2734
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2732

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

#offline_conversion_upload_client_summary_path(customer_id:, client:) ⇒ ::String

Create a fully-qualified OfflineConversionUploadClientSummary resource string.

The resource will be in the following format:

‘customers/customer_id/offlineConversionUploadClientSummaries/client`

Parameters:

  • customer_id (String)
  • client (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2747
2748
2749
2750
2751
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2747

def offline_conversion_upload_client_summary_path customer_id:, client:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/offlineConversionUploadClientSummaries/#{client}"
end

#offline_conversion_upload_conversion_action_summary_path(customer_id:, conversion_type_id:, client:) ⇒ ::String

Create a fully-qualified OfflineConversionUploadConversionActionSummary resource string.

The resource will be in the following format:

‘customers/customer_id/offlineConversionUploadConversionActionSummaries/conversion_type_id~client`

Parameters:

  • customer_id (String)
  • conversion_type_id (String)
  • client (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2765
2766
2767
2768
2769
2770
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2765

def offline_conversion_upload_conversion_action_summary_path customer_id:, conversion_type_id:, client:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "conversion_type_id cannot contain /" if conversion_type_id.to_s.include? "/"

  "customers/#{customer_id}/offlineConversionUploadConversionActionSummaries/#{conversion_type_id}~#{client}"
end

#offline_user_data_job_path(customer_id:, offline_user_data_update_id:) ⇒ ::String

Create a fully-qualified OfflineUserDataJob resource string.

The resource will be in the following format:

‘customers/customer_id/offlineUserDataJobs/offline_user_data_update_id`

Parameters:

  • customer_id (String)
  • offline_user_data_update_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2783
2784
2785
2786
2787
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2783

def offline_user_data_job_path customer_id:, offline_user_data_update_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/offlineUserDataJobs/#{offline_user_data_update_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)


2799
2800
2801
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2799

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

Create a fully-qualified PaidOrganicSearchTermView resource string.

The resource will be in the following format:

‘customers/customer_id/paidOrganicSearchTermViews/campaign_id~ad_group_id~base64_search_term`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • ad_group_id (String)
  • base64_search_term (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2816
2817
2818
2819
2820
2821
2822
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2816

def paid_organic_search_term_view_path customer_id:, campaign_id:, ad_group_id:, base64_search_term:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "ad_group_id cannot contain /" if ad_group_id.to_s.include? "/"

  "customers/#{customer_id}/paidOrganicSearchTermViews/#{campaign_id}~#{ad_group_id}~#{base64_search_term}"
end

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

Create a fully-qualified ParentalStatusView resource string.

The resource will be in the following format:

‘customers/customer_id/parentalStatusViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2836
2837
2838
2839
2840
2841
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2836

def parental_status_view_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}/parentalStatusViews/#{ad_group_id}~#{criterion_id}"
end

#payments_account_path(customer_id:, payments_account_id:) ⇒ ::String

Create a fully-qualified PaymentsAccount resource string.

The resource will be in the following format:

‘customers/customer_id/paymentsAccounts/payments_account_id`

Parameters:

  • customer_id (String)
  • payments_account_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2854
2855
2856
2857
2858
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2854

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

  "customers/#{customer_id}/paymentsAccounts/#{}"
end

#per_store_view_path(customer_id:, place_id:) ⇒ ::String

Create a fully-qualified PerStoreView resource string.

The resource will be in the following format:

‘customers/customer_id/perStoreViews/place_id`

Parameters:

  • customer_id (String)
  • place_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2871
2872
2873
2874
2875
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2871

def per_store_view_path customer_id:, place_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/perStoreViews/#{place_id}"
end

#product_category_constant_path(level:, category_id:) ⇒ ::String

Create a fully-qualified ProductCategoryConstant resource string.

The resource will be in the following format:

‘productCategoryConstants/level~category_id`

Parameters:

  • level (String)
  • category_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2888
2889
2890
2891
2892
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2888

def product_category_constant_path level:, category_id:
  raise ::ArgumentError, "level cannot contain /" if level.to_s.include? "/"

  "productCategoryConstants/#{level}~#{category_id}"
end

#product_group_view_path(customer_id:, adgroup_id:, criterion_id:) ⇒ ::String

Create a fully-qualified ProductGroupView resource string.

The resource will be in the following format:

‘customers/customer_id/productGroupViews/adgroup_id~criterion_id`

Parameters:

  • customer_id (String)
  • adgroup_id (String)
  • criterion_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2906
2907
2908
2909
2910
2911
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2906

def product_group_view_path customer_id:, adgroup_id:, criterion_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "adgroup_id cannot contain /" if adgroup_id.to_s.include? "/"

  "customers/#{customer_id}/productGroupViews/#{adgroup_id}~#{criterion_id}"
end

Create a fully-qualified ProductLinkInvitation resource string.

The resource will be in the following format:

‘customers/customer_id/productLinkInvitations/customer_invitation_id`

Parameters:

  • customer_id (String)
  • customer_invitation_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2941
2942
2943
2944
2945
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2941

def product_link_invitation_path customer_id:, customer_invitation_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/productLinkInvitations/#{customer_invitation_id}"
end

Create a fully-qualified ProductLink resource string.

The resource will be in the following format:

‘customers/customer_id/productLinks/product_link_id`

Parameters:

  • customer_id (String)
  • product_link_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2924
2925
2926
2927
2928
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2924

def product_link_path customer_id:, product_link_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/productLinks/#{product_link_id}"
end

#qualifying_question_path(qualifying_question_id:) ⇒ ::String

Create a fully-qualified QualifyingQuestion resource string.

The resource will be in the following format:

‘qualifyingQuestions/qualifying_question_id`

Parameters:

  • qualifying_question_id (String)

Returns:

  • (::String)


2957
2958
2959
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2957

def qualifying_question_path qualifying_question_id:
  "qualifyingQuestions/#{qualifying_question_id}"
end

#recommendation_path(customer_id:, recommendation_id:) ⇒ ::String

Create a fully-qualified Recommendation resource string.

The resource will be in the following format:

‘customers/customer_id/recommendations/recommendation_id`

Parameters:

  • customer_id (String)
  • recommendation_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2972
2973
2974
2975
2976
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2972

def recommendation_path customer_id:, recommendation_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/recommendations/#{recommendation_id}"
end

#recommendation_subscription_path(customer_id:, recommendation_type:) ⇒ ::String

Create a fully-qualified RecommendationSubscription resource string.

The resource will be in the following format:

‘customers/customer_id/recommendationSubscriptions/recommendation_type`

Parameters:

  • customer_id (String)
  • recommendation_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


2989
2990
2991
2992
2993
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 2989

def recommendation_subscription_path customer_id:, recommendation_type:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/recommendationSubscriptions/#{recommendation_type}"
end

#remarketing_action_path(customer_id:, remarketing_action_id:) ⇒ ::String

Create a fully-qualified RemarketingAction resource string.

The resource will be in the following format:

‘customers/customer_id/remarketingActions/remarketing_action_id`

Parameters:

  • customer_id (String)
  • remarketing_action_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3006
3007
3008
3009
3010
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3006

def remarketing_action_path customer_id:, remarketing_action_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/remarketingActions/#{remarketing_action_id}"
end

#search_term_view_path(customer_id:, campaign_id:, ad_group_id:, query:) ⇒ ::String

Create a fully-qualified SearchTermView resource string.

The resource will be in the following format:

‘customers/customer_id/searchTermViews/campaign_id~ad_group_id~query`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • ad_group_id (String)
  • query (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3025
3026
3027
3028
3029
3030
3031
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3025

def search_term_view_path customer_id:, campaign_id:, ad_group_id:, query:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
  raise ::ArgumentError, "ad_group_id cannot contain /" if ad_group_id.to_s.include? "/"

  "customers/#{customer_id}/searchTermViews/#{campaign_id}~#{ad_group_id}~#{query}"
end

#shared_criterion_path(customer_id:, shared_set_id:, criterion_id:) ⇒ ::String

Create a fully-qualified SharedCriterion resource string.

The resource will be in the following format:

‘customers/customer_id/sharedCriteria/shared_set_id~criterion_id`

Parameters:

  • customer_id (String)
  • shared_set_id (String)
  • criterion_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3045
3046
3047
3048
3049
3050
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3045

def shared_criterion_path customer_id:, shared_set_id:, criterion_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "shared_set_id cannot contain /" if shared_set_id.to_s.include? "/"

  "customers/#{customer_id}/sharedCriteria/#{shared_set_id}~#{criterion_id}"
end

#shared_set_path(customer_id:, shared_set_id:) ⇒ ::String

Create a fully-qualified SharedSet resource string.

The resource will be in the following format:

‘customers/customer_id/sharedSets/shared_set_id`

Parameters:

  • customer_id (String)
  • shared_set_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3063
3064
3065
3066
3067
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3063

def shared_set_path customer_id:, shared_set_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/sharedSets/#{shared_set_id}"
end

#shopping_performance_view_path(customer_id:) ⇒ ::String

Create a fully-qualified ShoppingPerformanceView resource string.

The resource will be in the following format:

‘customers/customer_id/shoppingPerformanceView`

Parameters:

  • customer_id (String)

Returns:

  • (::String)


3079
3080
3081
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3079

def shopping_performance_view_path customer_id:
  "customers/#{customer_id}/shoppingPerformanceView"
end

#shopping_product_path(customer_id:, merchant_center_id:, channel:, language_code:, feed_label:, item_id:) ⇒ ::String

Create a fully-qualified ShoppingProduct resource string.

The resource will be in the following format:

‘customers/customer_id/shoppingProducts/merchant_center_id~channel~language_code~feed_label~item_id`

Parameters:

  • customer_id (String)
  • merchant_center_id (String)
  • channel (String)
  • language_code (String)
  • feed_label (String)
  • item_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3098

def shopping_product_path customer_id:, merchant_center_id:, channel:, language_code:, feed_label:,
                          item_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "merchant_center_id cannot contain /" if merchant_center_id.to_s.include? "/"
  raise ::ArgumentError, "channel cannot contain /" if channel.to_s.include? "/"
  raise ::ArgumentError, "language_code cannot contain /" if language_code.to_s.include? "/"
  raise ::ArgumentError, "feed_label cannot contain /" if feed_label.to_s.include? "/"

  "customers/#{customer_id}/shoppingProducts/#{merchant_center_id}~#{channel}~#{language_code}~#{feed_label}~#{item_id}"
end

#smart_campaign_search_term_view_path(customer_id:, campaign_id:, query:) ⇒ ::String

Create a fully-qualified SmartCampaignSearchTermView resource string.

The resource will be in the following format:

‘customers/customer_id/smartCampaignSearchTermViews/campaign_id~query`

Parameters:

  • customer_id (String)
  • campaign_id (String)
  • query (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3121
3122
3123
3124
3125
3126
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3121

def smart_campaign_search_term_view_path customer_id:, campaign_id:, query:
  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}/smartCampaignSearchTermViews/#{campaign_id}~#{query}"
end

#smart_campaign_setting_path(customer_id:, campaign_id:) ⇒ ::String

Create a fully-qualified SmartCampaignSetting resource string.

The resource will be in the following format:

‘customers/customer_id/smartCampaignSettings/campaign_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3139
3140
3141
3142
3143
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3139

def smart_campaign_setting_path customer_id:, campaign_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/smartCampaignSettings/#{campaign_id}"
end

Create a fully-qualified ThirdPartyAppAnalyticsLink resource string.

The resource will be in the following format:

‘customers/customer_id/thirdPartyAppAnalyticsLinks/customer_link_id`

Parameters:

  • customer_id (String)
  • customer_link_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3156
3157
3158
3159
3160
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3156

def third_party_app_analytics_link_path customer_id:, customer_link_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/thirdPartyAppAnalyticsLinks/#{customer_link_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)


3172
3173
3174
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3172

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

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

Create a fully-qualified TopicView resource string.

The resource will be in the following format:

‘customers/customer_id/topicViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3188
3189
3190
3191
3192
3193
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3188

def topic_view_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}/topicViews/#{ad_group_id}~#{criterion_id}"
end

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

Create a fully-qualified TravelActivityGroupView resource string.

The resource will be in the following format:

‘customers/customer_id/travelActivityGroupViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3207
3208
3209
3210
3211
3212
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3207

def travel_activity_group_view_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}/travelActivityGroupViews/#{ad_group_id}~#{criterion_id}"
end

#travel_activity_performance_view_path(customer_id:) ⇒ ::String

Create a fully-qualified TravelActivityPerformanceView resource string.

The resource will be in the following format:

‘customers/customer_id/travelActivityPerformanceViews`

Parameters:

  • customer_id (String)

Returns:

  • (::String)


3224
3225
3226
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3224

def travel_activity_performance_view_path customer_id:
  "customers/#{customer_id}/travelActivityPerformanceViews"
end

#user_interest_path(customer_id:, user_interest_id:) ⇒ ::String

Create a fully-qualified UserInterest resource string.

The resource will be in the following format:

‘customers/customer_id/userInterests/user_interest_id`

Parameters:

  • customer_id (String)
  • user_interest_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3239
3240
3241
3242
3243
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3239

def user_interest_path customer_id:, user_interest_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/userInterests/#{user_interest_id}"
end

#user_list_customer_type_path(customer_id:, user_list_id:, semantic_label:) ⇒ ::String

Create a fully-qualified UserListCustomerType resource string.

The resource will be in the following format:

‘customers/customer_id/userListCustomerTypes/user_list_id~semantic_label`

Parameters:

  • customer_id (String)
  • user_list_id (String)
  • semantic_label (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3274
3275
3276
3277
3278
3279
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3274

def user_list_customer_type_path customer_id:, user_list_id:, semantic_label:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "user_list_id cannot contain /" if user_list_id.to_s.include? "/"

  "customers/#{customer_id}/userListCustomerTypes/#{user_list_id}~#{semantic_label}"
end

#user_list_path(customer_id:, user_list_id:) ⇒ ::String

Create a fully-qualified UserList resource string.

The resource will be in the following format:

‘customers/customer_id/userLists/user_list_id`

Parameters:

  • customer_id (String)
  • user_list_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3256
3257
3258
3259
3260
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3256

def user_list_path customer_id:, user_list_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/userLists/#{user_list_id}"
end

#user_location_view_path(customer_id:, country_criterion_id:, is_targeting_location:) ⇒ ::String

Create a fully-qualified UserLocationView resource string.

The resource will be in the following format:

‘customers/customer_id/userLocationViews/country_criterion_id~is_targeting_location`

Parameters:

  • customer_id (String)
  • country_criterion_id (String)
  • is_targeting_location (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3293
3294
3295
3296
3297
3298
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3293

def user_location_view_path customer_id:, country_criterion_id:, is_targeting_location:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
  raise ::ArgumentError, "country_criterion_id cannot contain /" if country_criterion_id.to_s.include? "/"

  "customers/#{customer_id}/userLocationViews/#{country_criterion_id}~#{is_targeting_location}"
end

#video_path(customer_id:, video_id:) ⇒ ::String

Create a fully-qualified Video resource string.

The resource will be in the following format:

‘customers/customer_id/videos/video_id`

Parameters:

  • customer_id (String)
  • video_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3311
3312
3313
3314
3315
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3311

def video_path customer_id:, video_id:
  raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"

  "customers/#{customer_id}/videos/#{video_id}"
end

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

Create a fully-qualified WebpageView resource string.

The resource will be in the following format:

‘customers/customer_id/webpageViews/ad_group_id~criterion_id`

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError)


3329
3330
3331
3332
3333
3334
# File 'lib/google/ads/google_ads/v17/services/google_ads_service/paths.rb', line 3329

def webpage_view_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}/webpageViews/#{ad_group_id}~#{criterion_id}"
end