Module: Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Paths

Extended by:
Paths
Included in:
Client, Paths, Rest::Client
Defined in:
lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb

Overview

Path helper methods for the AnalyticsAdminService API.

Instance Method Summary collapse

Instance Method Details

#access_binding_path(account: , access_binding: ) ⇒ ::String #access_binding_path(property: , access_binding: ) ⇒ ::String

Create a fully-qualified AccessBinding resource string.

Overloads:

  • #access_binding_path(account: , access_binding: ) ⇒ ::String

    The resource will be in the following format:

    accounts/{account}/accessBindings/{access_binding}

    Parameters:

    • account (String) (defaults to: )
    • access_binding (String) (defaults to: )
  • #access_binding_path(property: , access_binding: ) ⇒ ::String

    The resource will be in the following format:

    properties/{property}/accessBindings/{access_binding}

    Parameters:

    • property (String) (defaults to: )
    • access_binding (String) (defaults to: )

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 47

def access_binding_path **args
  resources = {
    "access_binding:account" => (proc do |account:, access_binding:|
      raise ::ArgumentError, "account cannot contain /" if .to_s.include? "/"

      "accounts/#{}/accessBindings/#{access_binding}"
    end),
    "access_binding:property" => (proc do |property:, access_binding:|
      raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

      "properties/#{property}/accessBindings/#{access_binding}"
    end)
  }

  resource = resources[args.keys.sort.join(":")]
  raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
  resource.call(**args)
end

#account_path(account:) ⇒ ::String

Create a fully-qualified Account resource string.

The resource will be in the following format:

accounts/{account}

Parameters:

  • account (String)

Returns:

  • (::String) 


76
77
78
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 76

def  account:
  "accounts/#{}"
end

#ad_sense_link_path(property:, adsense_link:) ⇒ ::String

Create a fully-qualified AdSenseLink resource string.

The resource will be in the following format:

properties/{property}/adSenseLinks/{adsense_link}

Parameters:

  • property (String)
  • adsense_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


91
92
93
94
95
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 91

def ad_sense_link_path property:, adsense_link:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/adSenseLinks/#{adsense_link}"
end

#attribution_settings_path(property:) ⇒ ::String

Create a fully-qualified AttributionSettings resource string.

The resource will be in the following format:

properties/{property}/attributionSettings

Parameters:

  • property (String)

Returns:

  • (::String) 


107
108
109
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 107

def attribution_settings_path property:
  "properties/#{property}/attributionSettings"
end

#audience_path(property:, audience:) ⇒ ::String

Create a fully-qualified Audience resource string.

The resource will be in the following format:

properties/{property}/audiences/{audience}

Parameters:

  • property (String)
  • audience (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


122
123
124
125
126
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 122

def audience_path property:, audience:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/audiences/#{audience}"
end

#big_query_link_path(property:, bigquery_link:) ⇒ ::String

Create a fully-qualified BigQueryLink resource string.

The resource will be in the following format:

properties/{property}/bigQueryLinks/{bigquery_link}

Parameters:

  • property (String)
  • bigquery_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


139
140
141
142
143
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 139

def big_query_link_path property:, bigquery_link:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/bigQueryLinks/#{bigquery_link}"
end

#calculated_metric_path(property:, calculated_metric:) ⇒ ::String

Create a fully-qualified CalculatedMetric resource string.

The resource will be in the following format:

properties/{property}/calculatedMetrics/{calculated_metric}

Parameters:

  • property (String)
  • calculated_metric (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


156
157
158
159
160
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 156

def calculated_metric_path property:, calculated_metric:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/calculatedMetrics/#{calculated_metric}"
end

#channel_group_path(property:, channel_group:) ⇒ ::String

Create a fully-qualified ChannelGroup resource string.

The resource will be in the following format:

properties/{property}/channelGroups/{channel_group}

Parameters:

  • property (String)
  • channel_group (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


173
174
175
176
177
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 173

def channel_group_path property:, channel_group:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/channelGroups/#{channel_group}"
end

#conversion_event_path(property:, conversion_event:) ⇒ ::String

Create a fully-qualified ConversionEvent resource string.

The resource will be in the following format:

properties/{property}/conversionEvents/{conversion_event}

Parameters:

  • property (String)
  • conversion_event (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


190
191
192
193
194
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 190

def conversion_event_path property:, conversion_event:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/conversionEvents/#{conversion_event}"
end

#custom_dimension_path(property:, custom_dimension:) ⇒ ::String

Create a fully-qualified CustomDimension resource string.

The resource will be in the following format:

properties/{property}/customDimensions/{custom_dimension}

Parameters:

  • property (String)
  • custom_dimension (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


207
208
209
210
211
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 207

def custom_dimension_path property:, custom_dimension:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/customDimensions/#{custom_dimension}"
end

#custom_metric_path(property:, custom_metric:) ⇒ ::String

Create a fully-qualified CustomMetric resource string.

The resource will be in the following format:

properties/{property}/customMetrics/{custom_metric}

Parameters:

  • property (String)
  • custom_metric (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


224
225
226
227
228
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 224

def custom_metric_path property:, custom_metric:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/customMetrics/#{custom_metric}"
end

#data_redaction_settings_path(property:, data_stream:) ⇒ ::String

Create a fully-qualified DataRedactionSettings resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}/dataRedactionSettings

Parameters:

  • property (String)
  • data_stream (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


241
242
243
244
245
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 241

def data_redaction_settings_path property:, data_stream:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}/dataRedactionSettings"
end

#data_retention_settings_path(property:) ⇒ ::String

Create a fully-qualified DataRetentionSettings resource string.

The resource will be in the following format:

properties/{property}/dataRetentionSettings

Parameters:

  • property (String)

Returns:

  • (::String) 


257
258
259
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 257

def data_retention_settings_path property:
  "properties/#{property}/dataRetentionSettings"
end

#data_sharing_settings_path(account:) ⇒ ::String

Create a fully-qualified DataSharingSettings resource string.

The resource will be in the following format:

accounts/{account}/dataSharingSettings

Parameters:

  • account (String)

Returns:

  • (::String) 


271
272
273
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 271

def data_sharing_settings_path account:
  "accounts/#{}/dataSharingSettings"
end

#data_stream_path(property:, data_stream:) ⇒ ::String

Create a fully-qualified DataStream resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}

Parameters:

  • property (String)
  • data_stream (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


286
287
288
289
290
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 286

def data_stream_path property:, data_stream:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}"
end

#display_video360_advertiser_link_path(property:, display_video_360_advertiser_link:) ⇒ ::String

Create a fully-qualified DisplayVideo360AdvertiserLink resource string.

The resource will be in the following format:

properties/{property}/displayVideo360AdvertiserLinks/{display_video_360_advertiser_link}

Parameters:

  • property (String)
  • display_video_360_advertiser_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


303
304
305
306
307
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 303

def display_video360_advertiser_link_path property:, display_video_360_advertiser_link:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/displayVideo360AdvertiserLinks/#{display_video_360_advertiser_link}"
end

#display_video360_advertiser_link_proposal_path(property:, display_video_360_advertiser_link_proposal:) ⇒ ::String

Create a fully-qualified DisplayVideo360AdvertiserLinkProposal resource string.

The resource will be in the following format:

properties/{property}/displayVideo360AdvertiserLinkProposals/{display_video_360_advertiser_link_proposal}

Parameters:

  • property (String)
  • display_video_360_advertiser_link_proposal (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


320
321
322
323
324
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 320

def display_video360_advertiser_link_proposal_path property:, display_video_360_advertiser_link_proposal:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/displayVideo360AdvertiserLinkProposals/#{display_video_360_advertiser_link_proposal}"
end

#enhanced_measurement_settings_path(property:, data_stream:) ⇒ ::String

Create a fully-qualified EnhancedMeasurementSettings resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings

Parameters:

  • property (String)
  • data_stream (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


337
338
339
340
341
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 337

def enhanced_measurement_settings_path property:, data_stream:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}/enhancedMeasurementSettings"
end

#event_create_rule_path(property:, data_stream:, event_create_rule:) ⇒ ::String

Create a fully-qualified EventCreateRule resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

Parameters:

  • property (String)
  • data_stream (String)
  • event_create_rule (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


355
356
357
358
359
360
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 355

def event_create_rule_path property:, data_stream:, event_create_rule:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
  raise ::ArgumentError, "data_stream cannot contain /" if data_stream.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}/eventCreateRules/#{event_create_rule}"
end

#event_edit_rule_path(property:, data_stream:, event_edit_rule:) ⇒ ::String

Create a fully-qualified EventEditRule resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}

Parameters:

  • property (String)
  • data_stream (String)
  • event_edit_rule (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


374
375
376
377
378
379
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 374

def event_edit_rule_path property:, data_stream:, event_edit_rule:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
  raise ::ArgumentError, "data_stream cannot contain /" if data_stream.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}/eventEditRules/#{event_edit_rule}"
end

#expanded_data_set_path(property:, expanded_data_set:) ⇒ ::String

Create a fully-qualified ExpandedDataSet resource string.

The resource will be in the following format:

properties/{property}/expandedDataSets/{expanded_data_set}

Parameters:

  • property (String)
  • expanded_data_set (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


392
393
394
395
396
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 392

def expanded_data_set_path property:, expanded_data_set:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/expandedDataSets/#{expanded_data_set}"
end

#firebase_link_path(property:, firebase_link:) ⇒ ::String

Create a fully-qualified FirebaseLink resource string.

The resource will be in the following format:

properties/{property}/firebaseLinks/{firebase_link}

Parameters:

  • property (String)
  • firebase_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


409
410
411
412
413
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 409

def firebase_link_path property:, firebase_link:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/firebaseLinks/#{firebase_link}"
end

#global_site_tag_path(property:, data_stream:) ⇒ ::String

Create a fully-qualified GlobalSiteTag resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}/globalSiteTag

Parameters:

  • property (String)
  • data_stream (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


426
427
428
429
430
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 426

def global_site_tag_path property:, data_stream:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}/globalSiteTag"
end

Create a fully-qualified GoogleAdsLink resource string.

The resource will be in the following format:

properties/{property}/googleAdsLinks/{google_ads_link}

Parameters:

  • property (String)
  • google_ads_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


443
444
445
446
447
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 443

def google_ads_link_path property:, google_ads_link:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/googleAdsLinks/#{google_ads_link}"
end

#google_signals_settings_path(property:) ⇒ ::String

Create a fully-qualified GoogleSignalsSettings resource string.

The resource will be in the following format:

properties/{property}/googleSignalsSettings

Parameters:

  • property (String)

Returns:

  • (::String) 


459
460
461
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 459

def google_signals_settings_path property:
  "properties/#{property}/googleSignalsSettings"
end

#key_event_path(property:, key_event:) ⇒ ::String

Create a fully-qualified KeyEvent resource string.

The resource will be in the following format:

properties/{property}/keyEvents/{key_event}

Parameters:

  • property (String)
  • key_event (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


474
475
476
477
478
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 474

def key_event_path property:, key_event:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/keyEvents/#{key_event}"
end

#measurement_protocol_secret_path(property:, data_stream:, measurement_protocol_secret:) ⇒ ::String

Create a fully-qualified MeasurementProtocolSecret resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}

Parameters:

  • property (String)
  • data_stream (String)
  • measurement_protocol_secret (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


492
493
494
495
496
497
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 492

def measurement_protocol_secret_path property:, data_stream:, measurement_protocol_secret:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
  raise ::ArgumentError, "data_stream cannot contain /" if data_stream.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}/measurementProtocolSecrets/#{measurement_protocol_secret}"
end

#organization_path(organization:) ⇒ ::String

Create a fully-qualified Organization resource string.

The resource will be in the following format:

organizations/{organization}

Parameters:

  • organization (String)

Returns:

  • (::String) 


509
510
511
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 509

def organization_path organization:
  "organizations/#{organization}"
end

#property_path(property:) ⇒ ::String

Create a fully-qualified Property resource string.

The resource will be in the following format:

properties/{property}

Parameters:

  • property (String)

Returns:

  • (::String) 


523
524
525
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 523

def property_path property:
  "properties/#{property}"
end

#rollup_property_source_link_path(property:, rollup_property_source_link:) ⇒ ::String

Create a fully-qualified RollupPropertySourceLink resource string.

The resource will be in the following format:

properties/{property}/rollupPropertySourceLinks/{rollup_property_source_link}

Parameters:

  • property (String)
  • rollup_property_source_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


538
539
540
541
542
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 538

def rollup_property_source_link_path property:, rollup_property_source_link:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/rollupPropertySourceLinks/#{rollup_property_source_link}"
end

#search_ads360_link_path(property:, search_ads_360_link:) ⇒ ::String

Create a fully-qualified SearchAds360Link resource string.

The resource will be in the following format:

properties/{property}/searchAds360Links/{search_ads_360_link}

Parameters:

  • property (String)
  • search_ads_360_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


574
575
576
577
578
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 574

def search_ads360_link_path property:, search_ads_360_link:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/searchAds360Links/#{search_ads_360_link}"
end

#sk_ad_network_conversion_value_schema_path(property:, data_stream:, skadnetwork_conversion_value_schema:) ⇒ ::String

Create a fully-qualified SKAdNetworkConversionValueSchema resource string.

The resource will be in the following format:

properties/{property}/dataStreams/{data_stream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

Parameters:

  • property (String)
  • data_stream (String)
  • skadnetwork_conversion_value_schema (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


556
557
558
559
560
561
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 556

def sk_ad_network_conversion_value_schema_path property:, data_stream:, skadnetwork_conversion_value_schema:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
  raise ::ArgumentError, "data_stream cannot contain /" if data_stream.to_s.include? "/"

  "properties/#{property}/dataStreams/#{data_stream}/sKAdNetworkConversionValueSchema/#{skadnetwork_conversion_value_schema}"
end

#subproperty_event_filter_path(property:, sub_property_event_filter:) ⇒ ::String

Create a fully-qualified SubpropertyEventFilter resource string.

The resource will be in the following format:

properties/{property}/subpropertyEventFilters/{sub_property_event_filter}

Parameters:

  • property (String)
  • sub_property_event_filter (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


591
592
593
594
595
 
# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb', line 591

def subproperty_event_filter_path property:, sub_property_event_filter:
  raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"

  "properties/#{property}/subpropertyEventFilters/#{sub_property_event_filter}"
end