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

Extended by:
Paths
Included in:
Client, Paths
Defined in:
lib/google/ads/google_ads/v19/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/v19/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/v19/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/v19/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/v19/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/v19/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/v19/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/v19/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/v19/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/v19/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_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)


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

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/v19/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)


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

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/v19/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)


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

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)


346
347
348
349
350
351
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 346

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)


307
308
309
310
311
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 307

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)


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

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)


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

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)


401
402
403
404
405
406
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 401

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)


383
384
385
386
387
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 383

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)


419
420
421
422
423
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 419

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)


436
437
438
439
440
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 436

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)


453
454
455
456
457
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 453

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)


470
471
472
473
474
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 470

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)


487
488
489
490
491
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 487

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)


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

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)


543
544
545
546
547
548
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 543

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)


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

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)


580
581
582
583
584
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 580

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)


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

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)


619
620
621
622
623
624
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 619

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)


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

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)


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

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


675
676
677
678
679
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 675

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)


693
694
695
696
697
698
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 693

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)


504
505
506
507
508
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 504

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)


712
713
714
715
716
717
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 712

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)


729
730
731
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 729

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)


744
745
746
747
748
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 744

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)


761
762
763
764
765
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 761

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)


778
779
780
781
782
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 778

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)


795
796
797
798
799
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 795

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)


812
813
814
815
816
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 812

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)


829
830
831
832
833
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 829

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)


846
847
848
849
850
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 846

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)


878
879
880
881
882
883
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 878

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)


897
898
899
900
901
902
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 897

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)


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

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


932
933
934
935
936
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 932

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)


949
950
951
952
953
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 949

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)


862
863
864
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 862

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)


966
967
968
969
970
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 966

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)


983
984
985
986
987
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 983

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)


1018
1019
1020
1021
1022
1023
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1018

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)


1000
1001
1002
1003
1004
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1000

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

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


1035
1036
1037
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1035

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)


1084
1085
1086
1087
1088
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1084

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)


1067
1068
1069
1070
1071
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1067

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)


1118
1119
1120
1121
1122
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1118

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)


1101
1102
1103
1104
1105
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1101

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)


1050
1051
1052
1053
1054
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1050

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)


1135
1136
1137
1138
1139
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1135

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)


1152
1153
1154
1155
1156
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1152

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)


1168
1169
1170
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1168

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)


1183
1184
1185
1186
1187
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1183

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)


1199
1200
1201
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1199

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)


1213
1214
1215
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1213

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)


1227
1228
1229
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1227

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)


1242
1243
1244
1245
1246
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1242

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)


1259
1260
1261
1262
1263
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1259

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)


1277
1278
1279
1280
1281
1282
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1277

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)


1295
1296
1297
1298
1299
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1295

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)


1312
1313
1314
1315
1316
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1312

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)


1328
1329
1330
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1328

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)


1343
1344
1345
1346
1347
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1343

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)


1360
1361
1362
1363
1364
# File 'lib/google/ads/google_ads/v19/services/batch_job_service/paths.rb', line 1360

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