google-analytics-admin-v1alpha 0.12.0 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +1 -1
- data/lib/google/analytics/admin/v1alpha/access_report_pb.rb +159 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +122 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1941 -163
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +65 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +55 -1
- data/lib/google/analytics/admin/v1alpha/audience_pb.rb +164 -0
- data/lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb +69 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +71 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/lib/google/analytics/admin/v1alpha.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/access_report.rb +389 -0
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +445 -49
- data/proto_docs/google/analytics/admin/v1alpha/audience.rb +413 -0
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +156 -0
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +294 -56
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +0 -2
- metadata +14 -5
@@ -54,6 +54,12 @@ module Google
|
|
54
54
|
# Output only. Resource name of this property.
|
55
55
|
# Format: properties/\\{property_id}
|
56
56
|
# Example: "properties/1000"
|
57
|
+
# @!attribute [rw] property_type
|
58
|
+
# @return [::Google::Analytics::Admin::V1alpha::PropertyType]
|
59
|
+
# Immutable. The property type for this Property resource. When creating a
|
60
|
+
# property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then
|
61
|
+
# "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY"
|
62
|
+
# types cannot yet be created via Google Analytics Admin API.
|
57
63
|
# @!attribute [r] create_time
|
58
64
|
# @return [::Google::Protobuf::Timestamp]
|
59
65
|
# Output only. Time when the entity was originally created.
|
@@ -65,8 +71,8 @@ module Google
|
|
65
71
|
# Immutable. Resource name of this property's logical parent.
|
66
72
|
#
|
67
73
|
# Note: The Property-Moving UI can be used to change the parent.
|
68
|
-
# Format: accounts/\\{account}
|
69
|
-
# Example: "accounts/100"
|
74
|
+
# Format: accounts/\\{account}, properties/\\{property}
|
75
|
+
# Example: "accounts/100", "properties/101"
|
70
76
|
# @!attribute [rw] display_name
|
71
77
|
# @return [::String]
|
72
78
|
# Required. Human-readable display name for this property.
|
@@ -78,9 +84,9 @@ module Google
|
|
78
84
|
# Example: AUTOMOTIVE, FOOD_AND_DRINK
|
79
85
|
# @!attribute [rw] time_zone
|
80
86
|
# @return [::String]
|
81
|
-
# Required. Reporting Time Zone, used as the day boundary for reports,
|
82
|
-
# where the data originates. If the time zone honors DST,
|
83
|
-
# automatically adjust for the changes.
|
87
|
+
# Required. Reporting Time Zone, used as the day boundary for reports,
|
88
|
+
# regardless of where the data originates. If the time zone honors DST,
|
89
|
+
# Analytics will automatically adjust for the changes.
|
84
90
|
#
|
85
91
|
# NOTE: Changing the time zone only affects data going forward, and is not
|
86
92
|
# applied retroactively.
|
@@ -96,16 +102,17 @@ module Google
|
|
96
102
|
# Examples: "USD", "EUR", "JPY"
|
97
103
|
# @!attribute [r] service_level
|
98
104
|
# @return [::Google::Analytics::Admin::V1alpha::ServiceLevel]
|
99
|
-
# Output only. The Google Analytics service level that applies to this
|
105
|
+
# Output only. The Google Analytics service level that applies to this
|
106
|
+
# property.
|
100
107
|
# @!attribute [r] delete_time
|
101
108
|
# @return [::Google::Protobuf::Timestamp]
|
102
|
-
# Output only. If set, the time at which this property was trashed. If not
|
103
|
-
# property is not currently in the trash can.
|
109
|
+
# Output only. If set, the time at which this property was trashed. If not
|
110
|
+
# set, then this property is not currently in the trash can.
|
104
111
|
# @!attribute [r] expire_time
|
105
112
|
# @return [::Google::Protobuf::Timestamp]
|
106
|
-
# Output only. If set, the time at which this trashed property will be
|
107
|
-
# deleted. If not set, then this property is not currently in the
|
108
|
-
# and is not slated to be deleted.
|
113
|
+
# Output only. If set, the time at which this trashed property will be
|
114
|
+
# permanently deleted. If not set, then this property is not currently in the
|
115
|
+
# trash can and is not slated to be deleted.
|
109
116
|
# @!attribute [rw] account
|
110
117
|
# @return [::String]
|
111
118
|
# Immutable. The resource name of the parent account
|
@@ -278,9 +285,9 @@ module Google
|
|
278
285
|
# Output only. Example format: properties/1234/firebaseLinks/5678
|
279
286
|
# @!attribute [rw] project
|
280
287
|
# @return [::String]
|
281
|
-
# Immutable. Firebase project resource name. When creating a FirebaseLink,
|
282
|
-
# provide this resource name using either a project number or project
|
283
|
-
# Once this resource has been created, returned FirebaseLinks will always
|
288
|
+
# Immutable. Firebase project resource name. When creating a FirebaseLink,
|
289
|
+
# you may provide this resource name using either a project number or project
|
290
|
+
# ID. Once this resource has been created, returned FirebaseLinks will always
|
284
291
|
# have a project_name that contains a project number.
|
285
292
|
#
|
286
293
|
# Format: 'projects/\\{project number}'
|
@@ -302,8 +309,8 @@ module Google
|
|
302
309
|
# Example: "properties/123/dataStreams/456/globalSiteTag"
|
303
310
|
# @!attribute [rw] snippet
|
304
311
|
# @return [::String]
|
305
|
-
# Immutable. JavaScript code snippet to be pasted as the first item into the
|
306
|
-
# every webpage to measure.
|
312
|
+
# Immutable. JavaScript code snippet to be pasted as the first item into the
|
313
|
+
# head tag of every webpage to measure.
|
307
314
|
class GlobalSiteTag
|
308
315
|
include ::Google::Protobuf::MessageExts
|
309
316
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -312,7 +319,8 @@ module Google
|
|
312
319
|
# A link between a GA4 property and a Google Ads account.
|
313
320
|
# @!attribute [r] name
|
314
321
|
# @return [::String]
|
315
|
-
# Output only. Format:
|
322
|
+
# Output only. Format:
|
323
|
+
# properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
|
316
324
|
#
|
317
325
|
# Note: googleAdsLinkId is not the Google Ads customer ID.
|
318
326
|
# @!attribute [rw] customer_id
|
@@ -405,6 +413,16 @@ module Google
|
|
405
413
|
# @!attribute [rw] display_name
|
406
414
|
# @return [::String]
|
407
415
|
# Display name for the property referred to in this property summary.
|
416
|
+
# @!attribute [rw] property_type
|
417
|
+
# @return [::Google::Analytics::Admin::V1alpha::PropertyType]
|
418
|
+
# The property's property type.
|
419
|
+
# @!attribute [rw] parent
|
420
|
+
# @return [::String]
|
421
|
+
# Resource name of this property's logical parent.
|
422
|
+
#
|
423
|
+
# Note: The Property-Moving UI can be used to change the parent.
|
424
|
+
# Format: accounts/\\{account}, properties/\\{property}
|
425
|
+
# Example: "accounts/100", "properties/200"
|
408
426
|
class PropertySummary
|
409
427
|
include ::Google::Protobuf::MessageExts
|
410
428
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -413,17 +431,16 @@ module Google
|
|
413
431
|
# A secret value used for sending hits to Measurement Protocol.
|
414
432
|
# @!attribute [r] name
|
415
433
|
# @return [::String]
|
416
|
-
# Output only. Resource name of this secret. This secret may be a child of
|
417
|
-
# stream.
|
418
|
-
#
|
419
|
-
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
434
|
+
# Output only. Resource name of this secret. This secret may be a child of
|
435
|
+
# any type of stream. Format:
|
436
|
+
# properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
420
437
|
# @!attribute [rw] display_name
|
421
438
|
# @return [::String]
|
422
439
|
# Required. Human-readable display name for this secret.
|
423
440
|
# @!attribute [r] secret_value
|
424
441
|
# @return [::String]
|
425
|
-
# Output only. The measurement protocol secret value. Pass this value to the
|
426
|
-
# field of the Measurement Protocol API when sending hits to this
|
442
|
+
# Output only. The measurement protocol secret value. Pass this value to the
|
443
|
+
# api_secret field of the Measurement Protocol API when sending hits to this
|
427
444
|
# secret's parent property.
|
428
445
|
class MeasurementProtocolSecret
|
429
446
|
include ::Google::Protobuf::MessageExts
|
@@ -520,9 +537,21 @@ module Google
|
|
520
537
|
# @!attribute [rw] data_retention_settings
|
521
538
|
# @return [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
|
522
539
|
# A snapshot of a data retention settings resource in change history.
|
540
|
+
# @!attribute [rw] search_ads_360_link
|
541
|
+
# @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
542
|
+
# A snapshot of a SearchAds360Link resource in change history.
|
523
543
|
# @!attribute [rw] data_stream
|
524
544
|
# @return [::Google::Analytics::Admin::V1alpha::DataStream]
|
525
545
|
# A snapshot of a DataStream resource in change history.
|
546
|
+
# @!attribute [rw] attribution_settings
|
547
|
+
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
|
548
|
+
# A snapshot of AttributionSettings resource in change history.
|
549
|
+
# @!attribute [rw] expanded_data_set
|
550
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
|
551
|
+
# A snapshot of an ExpandedDataSet resource in change history.
|
552
|
+
# @!attribute [rw] bigquery_link
|
553
|
+
# @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
554
|
+
# A snapshot of a BigQuery link resource in change history.
|
526
555
|
class ChangeHistoryResource
|
527
556
|
include ::Google::Protobuf::MessageExts
|
528
557
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -532,8 +561,9 @@ module Google
|
|
532
561
|
# A link between a GA4 property and a Display & Video 360 advertiser.
|
533
562
|
# @!attribute [r] name
|
534
563
|
# @return [::String]
|
535
|
-
# Output only. The resource name for this DisplayVideo360AdvertiserLink
|
536
|
-
# Format:
|
564
|
+
# Output only. The resource name for this DisplayVideo360AdvertiserLink
|
565
|
+
# resource. Format:
|
566
|
+
# properties/\\{propertyId}/displayVideo360AdvertiserLinks/\\{linkId}
|
537
567
|
#
|
538
568
|
# Note: linkId is not the Display & Video 360 Advertiser ID
|
539
569
|
# @!attribute [rw] advertiser_id
|
@@ -548,17 +578,17 @@ module Google
|
|
548
578
|
# If this field is not set on create/update, it will be defaulted to true.
|
549
579
|
# @!attribute [rw] campaign_data_sharing_enabled
|
550
580
|
# @return [::Google::Protobuf::BoolValue]
|
551
|
-
# Immutable. Enables the import of campaign data from Display & Video 360
|
552
|
-
# property. After link creation, this can only be updated from
|
553
|
-
# Video 360 product.
|
554
|
-
#
|
581
|
+
# Immutable. Enables the import of campaign data from Display & Video 360
|
582
|
+
# into the GA4 property. After link creation, this can only be updated from
|
583
|
+
# the Display & Video 360 product. If this field is not set on create, it
|
584
|
+
# will be defaulted to true.
|
555
585
|
# @!attribute [rw] cost_data_sharing_enabled
|
556
586
|
# @return [::Google::Protobuf::BoolValue]
|
557
|
-
# Immutable. Enables the import of cost data from Display & Video 360 into
|
558
|
-
# property. This can only be enabled if campaign_data_sharing_enabled
|
559
|
-
# enabled. After link creation, this can only be updated from the Display
|
560
|
-
# Video 360 product.
|
561
|
-
#
|
587
|
+
# Immutable. Enables the import of cost data from Display & Video 360 into
|
588
|
+
# the GA4 property. This can only be enabled if campaign_data_sharing_enabled
|
589
|
+
# is enabled. After link creation, this can only be updated from the Display
|
590
|
+
# & Video 360 product. If this field is not set on create, it will be
|
591
|
+
# defaulted to true.
|
562
592
|
class DisplayVideo360AdvertiserLink
|
563
593
|
include ::Google::Protobuf::MessageExts
|
564
594
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -572,8 +602,8 @@ module Google
|
|
572
602
|
# admins approve outbound proposals.
|
573
603
|
# @!attribute [r] name
|
574
604
|
# @return [::String]
|
575
|
-
# Output only. The resource name for this
|
576
|
-
# Format:
|
605
|
+
# Output only. The resource name for this
|
606
|
+
# DisplayVideo360AdvertiserLinkProposal resource. Format:
|
577
607
|
# properties/\\{propertyId}/displayVideo360AdvertiserLinkProposals/\\{proposalId}
|
578
608
|
#
|
579
609
|
# Note: proposalId is not the Display & Video 360 Advertiser ID
|
@@ -589,12 +619,12 @@ module Google
|
|
589
619
|
# Only populated for proposals that originated from Display & Video 360.
|
590
620
|
# @!attribute [rw] validation_email
|
591
621
|
# @return [::String]
|
592
|
-
# Input only. On a proposal being sent to Display & Video 360, this field
|
593
|
-
# the email address of an admin on the target advertiser. This
|
594
|
-
# verify that the Google Analytics admin is aware of at least one
|
595
|
-
# the Display & Video 360 Advertiser. This does not restrict
|
596
|
-
# proposal to a single user. Any admin on the Display & Video
|
597
|
-
# may approve the proposal.
|
622
|
+
# Input only. On a proposal being sent to Display & Video 360, this field
|
623
|
+
# must be set to the email address of an admin on the target advertiser. This
|
624
|
+
# is used to verify that the Google Analytics admin is aware of at least one
|
625
|
+
# admin on the Display & Video 360 Advertiser. This does not restrict
|
626
|
+
# approval of the proposal to a single user. Any admin on the Display & Video
|
627
|
+
# 360 Advertiser may approve the proposal.
|
598
628
|
# @!attribute [rw] ads_personalization_enabled
|
599
629
|
# @return [::Google::Protobuf::BoolValue]
|
600
630
|
# Immutable. Enables personalized advertising features with this integration.
|
@@ -613,6 +643,47 @@ module Google
|
|
613
643
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
614
644
|
end
|
615
645
|
|
646
|
+
# A link between a GA4 property and a Search Ads 360 entity.
|
647
|
+
# @!attribute [r] name
|
648
|
+
# @return [::String]
|
649
|
+
# Output only. The resource name for this SearchAds360Link resource.
|
650
|
+
# Format: properties/\\{propertyId}/searchAds360Links/\\{linkId}
|
651
|
+
#
|
652
|
+
# Note: linkId is not the Search Ads 360 advertiser ID
|
653
|
+
# @!attribute [rw] advertiser_id
|
654
|
+
# @return [::String]
|
655
|
+
# Immutable. This field represents the Advertiser ID of the Search Ads 360
|
656
|
+
# Advertiser. that has been linked.
|
657
|
+
# @!attribute [rw] campaign_data_sharing_enabled
|
658
|
+
# @return [::Google::Protobuf::BoolValue]
|
659
|
+
# Immutable. Enables the import of campaign data from Search Ads 360 into the
|
660
|
+
# GA4 property. After link creation, this can only be updated from the Search
|
661
|
+
# Ads 360 product.
|
662
|
+
# If this field is not set on create, it will be defaulted to true.
|
663
|
+
# @!attribute [rw] cost_data_sharing_enabled
|
664
|
+
# @return [::Google::Protobuf::BoolValue]
|
665
|
+
# Immutable. Enables the import of cost data from Search Ads 360 to the GA4
|
666
|
+
# property. This can only be enabled if campaign_data_sharing_enabled is
|
667
|
+
# enabled. After link creation, this can only be updated from
|
668
|
+
# the Search Ads 360 product.
|
669
|
+
# If this field is not set on create, it will be defaulted to true.
|
670
|
+
# @!attribute [r] advertiser_display_name
|
671
|
+
# @return [::String]
|
672
|
+
# Output only. The display name of the Search Ads 360 Advertiser.
|
673
|
+
# Allows users to easily identify the linked resource.
|
674
|
+
# @!attribute [rw] ads_personalization_enabled
|
675
|
+
# @return [::Google::Protobuf::BoolValue]
|
676
|
+
# Enables personalized advertising features with this integration.
|
677
|
+
# If this field is not set on create, it will be defaulted to true.
|
678
|
+
# @!attribute [rw] site_stats_sharing_enabled
|
679
|
+
# @return [::Google::Protobuf::BoolValue]
|
680
|
+
# Enables export of site stats with this integration.
|
681
|
+
# If this field is not set on create, it will be defaulted to true.
|
682
|
+
class SearchAds360Link
|
683
|
+
include ::Google::Protobuf::MessageExts
|
684
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
685
|
+
end
|
686
|
+
|
616
687
|
# Status information for a link proposal.
|
617
688
|
# @!attribute [r] link_proposal_initiating_product
|
618
689
|
# @return [::Google::Analytics::Admin::V1alpha::LinkProposalInitiatingProduct]
|
@@ -642,14 +713,15 @@ module Google
|
|
642
713
|
# Output only. Time when this conversion event was created in the property.
|
643
714
|
# @!attribute [r] deletable
|
644
715
|
# @return [::Boolean]
|
645
|
-
# Output only. If set, this event can currently be deleted via
|
716
|
+
# Output only. If set, this event can currently be deleted via
|
717
|
+
# DeleteConversionEvent.
|
646
718
|
# @!attribute [r] custom
|
647
719
|
# @return [::Boolean]
|
648
|
-
# Output only. If set to true, this conversion event refers to a custom
|
649
|
-
# false, this conversion event refers to a default event in
|
650
|
-
# events typically have special meaning in GA. Default events are
|
651
|
-
# created for you by the GA system, but in some cases can be created
|
652
|
-
# property admins. Custom events count towards the maximum number of
|
720
|
+
# Output only. If set to true, this conversion event refers to a custom
|
721
|
+
# event. If set to false, this conversion event refers to a default event in
|
722
|
+
# GA. Default events typically have special meaning in GA. Default events are
|
723
|
+
# usually created for you by the GA system, but in some cases can be created
|
724
|
+
# by property admins. Custom events count towards the maximum number of
|
653
725
|
# custom conversion events that may be created per property.
|
654
726
|
class ConversionEvent
|
655
727
|
include ::Google::Protobuf::MessageExts
|
@@ -691,21 +763,22 @@ module Google
|
|
691
763
|
# characters for event-scoped dimensions.
|
692
764
|
# @!attribute [rw] display_name
|
693
765
|
# @return [::String]
|
694
|
-
# Required. Display name for this custom dimension as shown in the Analytics
|
695
|
-
# Max length of 82 characters, alphanumeric plus space and underscore
|
766
|
+
# Required. Display name for this custom dimension as shown in the Analytics
|
767
|
+
# UI. Max length of 82 characters, alphanumeric plus space and underscore
|
696
768
|
# starting with a letter. Legacy system-generated display names may contain
|
697
769
|
# square brackets, but updates to this field will never permit square
|
698
770
|
# brackets.
|
699
771
|
# @!attribute [rw] description
|
700
772
|
# @return [::String]
|
701
|
-
# Optional. Description for this custom dimension. Max length of 150
|
773
|
+
# Optional. Description for this custom dimension. Max length of 150
|
774
|
+
# characters.
|
702
775
|
# @!attribute [rw] scope
|
703
776
|
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope]
|
704
777
|
# Required. Immutable. The scope of this dimension.
|
705
778
|
# @!attribute [rw] disallow_ads_personalization
|
706
779
|
# @return [::Boolean]
|
707
|
-
# Optional. If set to true, sets this dimension as NPA and excludes it from
|
708
|
-
# personalization.
|
780
|
+
# Optional. If set to true, sets this dimension as NPA and excludes it from
|
781
|
+
# ads personalization.
|
709
782
|
#
|
710
783
|
# This is currently only supported by user-scoped custom dimensions.
|
711
784
|
class CustomDimension
|
@@ -758,9 +831,9 @@ module Google
|
|
758
831
|
# Required. Immutable. The scope of this custom metric.
|
759
832
|
# @!attribute [rw] restricted_metric_type
|
760
833
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::CustomMetric::RestrictedMetricType>]
|
761
|
-
# Optional. Types of restricted data that this metric may contain. Required
|
762
|
-
# with CURRENCY measurement unit. Must be empty for metrics with
|
763
|
-
# non-CURRENCY measurement unit.
|
834
|
+
# Optional. Types of restricted data that this metric may contain. Required
|
835
|
+
# for metrics with CURRENCY measurement unit. Must be empty for metrics with
|
836
|
+
# a non-CURRENCY measurement unit.
|
764
837
|
class CustomMetric
|
765
838
|
include ::Google::Protobuf::MessageExts
|
766
839
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -868,6 +941,144 @@ module Google
|
|
868
941
|
end
|
869
942
|
end
|
870
943
|
|
944
|
+
# The attribution settings used for a given property. This is a singleton
|
945
|
+
# resource.
|
946
|
+
# @!attribute [r] name
|
947
|
+
# @return [::String]
|
948
|
+
# Output only. Resource name of this attribution settings resource.
|
949
|
+
# Format: properties/\\{property_id}/attributionSettings
|
950
|
+
# Example: "properties/1000/attributionSettings"
|
951
|
+
# @!attribute [rw] acquisition_conversion_event_lookback_window
|
952
|
+
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::AcquisitionConversionEventLookbackWindow]
|
953
|
+
# Required. The lookback window configuration for acquisition conversion
|
954
|
+
# events. The default window size is 30 days.
|
955
|
+
# @!attribute [rw] other_conversion_event_lookback_window
|
956
|
+
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::OtherConversionEventLookbackWindow]
|
957
|
+
# Required. The lookback window for all other, non-acquisition conversion
|
958
|
+
# events. The default window size is 90 days.
|
959
|
+
# @!attribute [rw] reporting_attribution_model
|
960
|
+
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::ReportingAttributionModel]
|
961
|
+
# Required. The reporting attribution model used to calculate conversion
|
962
|
+
# credit in this property's reports.
|
963
|
+
#
|
964
|
+
# Changing the attribution model will apply to both historical and future
|
965
|
+
# data. These changes will be reflected in reports with conversion and
|
966
|
+
# revenue data. User and session data will be unaffected.
|
967
|
+
class AttributionSettings
|
968
|
+
include ::Google::Protobuf::MessageExts
|
969
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
970
|
+
|
971
|
+
# How far back in time events should be considered for inclusion in a
|
972
|
+
# converting path which leads to the first install of an app or the first
|
973
|
+
# visit to a site.
|
974
|
+
module AcquisitionConversionEventLookbackWindow
|
975
|
+
# Lookback window size unspecified.
|
976
|
+
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0
|
977
|
+
|
978
|
+
# 7-day lookback window.
|
979
|
+
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS = 1
|
980
|
+
|
981
|
+
# 30-day lookback window.
|
982
|
+
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 2
|
983
|
+
end
|
984
|
+
|
985
|
+
# How far back in time events should be considered for inclusion in a
|
986
|
+
# converting path for all conversions other than first app install/first site
|
987
|
+
# visit.
|
988
|
+
module OtherConversionEventLookbackWindow
|
989
|
+
# Lookback window size unspecified.
|
990
|
+
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0
|
991
|
+
|
992
|
+
# 30-day lookback window.
|
993
|
+
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 1
|
994
|
+
|
995
|
+
# 60-day lookback window.
|
996
|
+
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS = 2
|
997
|
+
|
998
|
+
# 90-day lookback window.
|
999
|
+
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS = 3
|
1000
|
+
end
|
1001
|
+
|
1002
|
+
# The reporting attribution model used to calculate conversion credit in this
|
1003
|
+
# property's reports.
|
1004
|
+
module ReportingAttributionModel
|
1005
|
+
# Reporting attribution model unspecified.
|
1006
|
+
REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED = 0
|
1007
|
+
|
1008
|
+
# Data-driven attribution distributes credit for the conversion based on
|
1009
|
+
# data for each conversion event. Each Data-driven model is specific to
|
1010
|
+
# each advertiser and each conversion event.
|
1011
|
+
CROSS_CHANNEL_DATA_DRIVEN = 1
|
1012
|
+
|
1013
|
+
# Ignores direct traffic and attributes 100% of the conversion value to the
|
1014
|
+
# last channel that the customer clicked through (or engaged view through
|
1015
|
+
# for YouTube) before converting.
|
1016
|
+
CROSS_CHANNEL_LAST_CLICK = 2
|
1017
|
+
|
1018
|
+
# Gives all credit for the conversion to the first channel that a customer
|
1019
|
+
# clicked (or engaged view through for YouTube) before converting.
|
1020
|
+
CROSS_CHANNEL_FIRST_CLICK = 3
|
1021
|
+
|
1022
|
+
# Distributes the credit for the conversion equally across all the channels
|
1023
|
+
# a customer clicked (or engaged view through for YouTube) before
|
1024
|
+
# converting.
|
1025
|
+
CROSS_CHANNEL_LINEAR = 4
|
1026
|
+
|
1027
|
+
# Attributes 40% credit to the first and last interaction, and the
|
1028
|
+
# remaining 20% credit is distributed evenly to the middle interactions.
|
1029
|
+
CROSS_CHANNEL_POSITION_BASED = 5
|
1030
|
+
|
1031
|
+
# Gives more credit to the touchpoints that happened closer in time to
|
1032
|
+
# the conversion.
|
1033
|
+
CROSS_CHANNEL_TIME_DECAY = 6
|
1034
|
+
|
1035
|
+
# Attributes 100% of the conversion value to the last Google Ads channel
|
1036
|
+
# that the customer clicked through before converting.
|
1037
|
+
ADS_PREFERRED_LAST_CLICK = 7
|
1038
|
+
end
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# A link between a GA4 Property and BigQuery project.
|
1042
|
+
# @!attribute [r] name
|
1043
|
+
# @return [::String]
|
1044
|
+
# Output only. Resource name of this BigQuery link.
|
1045
|
+
# Format: 'properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id}'
|
1046
|
+
# Format: 'properties/1234/bigQueryLinks/abc567'
|
1047
|
+
# @!attribute [rw] project
|
1048
|
+
# @return [::String]
|
1049
|
+
# Immutable. The linked Google Cloud project. When creating a BigQueryLink,
|
1050
|
+
# you may provide this resource name using either a project number or project
|
1051
|
+
# ID. Once this resource has been created, the returned project will always
|
1052
|
+
# have a project that contains a project number.
|
1053
|
+
# Format: 'projects/\\{project number}'
|
1054
|
+
# Example: 'projects/1234'
|
1055
|
+
# @!attribute [r] create_time
|
1056
|
+
# @return [::Google::Protobuf::Timestamp]
|
1057
|
+
# Output only. Time when the link was created.
|
1058
|
+
# @!attribute [rw] daily_export_enabled
|
1059
|
+
# @return [::Boolean]
|
1060
|
+
# If set true, enables daily data export to the linked Google Cloud project.
|
1061
|
+
# @!attribute [rw] streaming_export_enabled
|
1062
|
+
# @return [::Boolean]
|
1063
|
+
# If set true, enables streaming export to the linked Google Cloud project.
|
1064
|
+
# @!attribute [rw] include_advertising_id
|
1065
|
+
# @return [::Boolean]
|
1066
|
+
# If set true, exported data will include advertising identifiers for mobile
|
1067
|
+
# app streams.
|
1068
|
+
# @!attribute [rw] export_streams
|
1069
|
+
# @return [::Array<::String>]
|
1070
|
+
# The list of streams under the parent property for which data will be
|
1071
|
+
# exported.
|
1072
|
+
# Format: properties/\\{property_id}/dataStreams/\\{stream_id}
|
1073
|
+
# Example: ['properties/1000/dataStreams/2000']
|
1074
|
+
# @!attribute [rw] excluded_events
|
1075
|
+
# @return [::Array<::String>]
|
1076
|
+
# The list of event names that will be excluded from exports.
|
1077
|
+
class BigQueryLink
|
1078
|
+
include ::Google::Protobuf::MessageExts
|
1079
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1080
|
+
end
|
1081
|
+
|
871
1082
|
# The category selected for this property, used for industry benchmarking.
|
872
1083
|
module IndustryCategory
|
873
1084
|
# Industry category unspecified
|
@@ -1036,8 +1247,20 @@ module Google
|
|
1036
1247
|
# DisplayVideo360AdvertiserLinkProposal resource
|
1037
1248
|
DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15
|
1038
1249
|
|
1250
|
+
# SearchAds360Link resource
|
1251
|
+
SEARCH_ADS_360_LINK = 16
|
1252
|
+
|
1039
1253
|
# DataStream resource
|
1040
1254
|
DATA_STREAM = 18
|
1255
|
+
|
1256
|
+
# AttributionSettings resource
|
1257
|
+
ATTRIBUTION_SETTINGS = 20
|
1258
|
+
|
1259
|
+
# ExpandedDataSet resource
|
1260
|
+
EXPANDED_DATA_SET = 21
|
1261
|
+
|
1262
|
+
# ChannelGroup resource
|
1263
|
+
CHANNEL_GROUP = 22
|
1041
1264
|
end
|
1042
1265
|
|
1043
1266
|
# Status of the Google Signals settings (i.e., whether this feature has been
|
@@ -1113,6 +1336,21 @@ module Google
|
|
1113
1336
|
# proposal will be automatically deleted after some time.
|
1114
1337
|
OBSOLETE = 6
|
1115
1338
|
end
|
1339
|
+
|
1340
|
+
# Types of Property resources.
|
1341
|
+
module PropertyType
|
1342
|
+
# Unknown or unspecified property type
|
1343
|
+
PROPERTY_TYPE_UNSPECIFIED = 0
|
1344
|
+
|
1345
|
+
# Ordinary GA4 property
|
1346
|
+
PROPERTY_TYPE_ORDINARY = 1
|
1347
|
+
|
1348
|
+
# GA4 subproperty
|
1349
|
+
PROPERTY_TYPE_SUBPROPERTY = 2
|
1350
|
+
|
1351
|
+
# GA4 rollup property
|
1352
|
+
PROPERTY_TYPE_ROLLUP = 3
|
1353
|
+
end
|
1116
1354
|
end
|
1117
1355
|
end
|
1118
1356
|
end
|