Module: Google::Ads::GoogleAds::V16::Services::BatchJobService::Paths

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

Overview

Path helper methods for the BatchJobService 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/v16/services/batch_job_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

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


111
112
113
114
115
116
117
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 111

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) 


91
92
93
94
95
96
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 91

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) 


132
133
134
135
136
137
138
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 132

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


152
153
154
155
156
157
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 152

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) 


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

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) 


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

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) 


171
172
173
174
175
176
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 171

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


232
233
234
235
236
237
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 232

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) 


251
252
253
254
255
256
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 251

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) 


270
271
272
273
274
275
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 270

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) 


289
290
291
292
293
294
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 289

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) 


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

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


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

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) 


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

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

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


364
365
366
367
368
369
370
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 364

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) 


384
385
386
387
388
389
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 384

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) 


345
346
347
348
349
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 345

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


403
404
405
406
407
408
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 403

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


328
329
330
331
332
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 328

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) 


439
440
441
442
443
444
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 439

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) 


421
422
423
424
425
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 421

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

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


457
458
459
460
461
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 457

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) 


474
475
476
477
478
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 474

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) 


491
492
493
494
495
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 491

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) 


508
509
510
511
512
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 508

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) 


525
526
527
528
529
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 525

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

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


561
562
563
564
565
566
567
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 561

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) 


581
582
583
584
585
586
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 581

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


600
601
602
603
604
605
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 600

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) 


618
619
620
621
622
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 618

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) 


637
638
639
640
641
642
643
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 637

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) 


657
658
659
660
661
662
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 657

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) 


676
677
678
679
680
681
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 676

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) 


695
696
697
698
699
700
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 695

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) 


714
715
716
717
718
719
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 714

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) 


733
734
735
736
737
738
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 733

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) 


751
752
753
754
755
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 751

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) 


769
770
771
772
773
774
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 769

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

  "customers/#{customer_id}/campaignLabels/#{campaign_id}~#{label_id}"
end

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

Create a fully-qualified Campaign resource string.

The resource will be in the following format:

‘customers/customer_id/campaigns/campaign_id`

Parameters:

  • customer_id (String)
  • campaign_id (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


542
543
544
545
546
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 542

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


788
789
790
791
792
793
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 788

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

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


805
806
807
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 805

def carrier_constant_path criterion_id:
  "carrierConstants/#{criterion_id}"
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) 


820
821
822
823
824
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 820

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) 


837
838
839
840
841
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 837

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) 


854
855
856
857
858
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 854

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) 


871
872
873
874
875
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 871

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) 


888
889
890
891
892
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 888

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) 


905
906
907
908
909
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 905

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

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


922
923
924
925
926
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 922

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

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


954
955
956
957
958
959
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 954

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


973
974
975
976
977
978
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 973

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) 


991
992
993
994
995
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 991

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) 


1008
1009
1010
1011
1012
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1008

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) 


1025
1026
1027
1028
1029
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1025

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) 


1042
1043
1044
1045
1046
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1042

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


1059
1060
1061
1062
1063
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1059

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) 


938
939
940
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 938

def customer_path customer_id:
  "customers/#{customer_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) 


1076
1077
1078
1079
1080
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1076

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

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


1093
1094
1095
1096
1097
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1093

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

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


1128
1129
1130
1131
1132
1133
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1128

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) 


1110
1111
1112
1113
1114
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1110

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) 


1146
1147
1148
1149
1150
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1146

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) 


1181
1182
1183
1184
1185
1186
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1181

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

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

#feed_item_set_link_path(customer_id:, feed_id:, feed_item_set_id:, feed_item_id:) ⇒ ::String

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) 


1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1220

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) 


1200
1201
1202
1203
1204
1205
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1200

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) 


1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1242

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) 


1267
1268
1269
1270
1271
1272
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1267

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) 


1163
1164
1165
1166
1167
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1163

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

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


1284
1285
1286
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1284

def geo_target_constant_path criterion_id:
  "geoTargetConstants/#{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) 


1333
1334
1335
1336
1337
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1333

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) 


1316
1317
1318
1319
1320
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1316

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) 


1367
1368
1369
1370
1371
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1367

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) 


1350
1351
1352
1353
1354
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1350

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) 


1299
1300
1301
1302
1303
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1299

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) 


1384
1385
1386
1387
1388
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1384

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

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


1401
1402
1403
1404
1405
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1401

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

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


1417
1418
1419
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1417

def language_constant_path criterion_id:
  "languageConstants/#{criterion_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) 


1432
1433
1434
1435
1436
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1432

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

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


1448
1449
1450
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1448

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) 


1462
1463
1464
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1462

def mobile_device_constant_path criterion_id:
  "mobileDeviceConstants/#{criterion_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) 


1476
1477
1478
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1476

def operating_system_version_constant_path criterion_id:
  "operatingSystemVersionConstants/#{criterion_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) 


1491
1492
1493
1494
1495
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1491

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) 


1508
1509
1510
1511
1512
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1508

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

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


1526
1527
1528
1529
1530
1531
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1526

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) 


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

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

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


1561
1562
1563
1564
1565
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1561

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

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


1577
1578
1579
 
# File 'lib/google/ads/google_ads/v16/services/batch_job_service/paths.rb', line 1577

def topic_constant_path topic_id:
  "topicConstants/#{topic_id}"
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) 


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

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


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

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