google-analytics-admin-v1alpha 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +8 -8
- data/README.md +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +194 -5
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +2998 -293
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +126 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +82 -2
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +153 -9
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +550 -14
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +476 -27
- data/proto_docs/google/api/field_behavior.rb +7 -1
- metadata +13 -7
@@ -94,6 +94,9 @@ module Google
|
|
94
94
|
#
|
95
95
|
# Format: https://en.wikipedia.org/wiki/ISO_4217
|
96
96
|
# Examples: "USD", "EUR", "JPY"
|
97
|
+
# @!attribute [r] service_level
|
98
|
+
# @return [::Google::Analytics::Admin::V1alpha::ServiceLevel]
|
99
|
+
# Output only. The Google Analytics service level that applies to this property.
|
97
100
|
# @!attribute [r] delete_time
|
98
101
|
# @return [::Google::Protobuf::Timestamp]
|
99
102
|
# Output only. If set, the time at which this property was trashed. If not set, then this
|
@@ -204,12 +207,12 @@ module Google
|
|
204
207
|
|
205
208
|
# A resource message representing a user's permissions on an Account or
|
206
209
|
# Property resource.
|
207
|
-
# @!attribute [
|
210
|
+
# @!attribute [r] name
|
208
211
|
# @return [::String]
|
209
|
-
# Example format: properties/1234/userLinks/5678
|
212
|
+
# Output only. Example format: properties/1234/userLinks/5678
|
210
213
|
# @!attribute [rw] email_address
|
211
214
|
# @return [::String]
|
212
|
-
# Email address of the user to link
|
215
|
+
# Immutable. Email address of the user to link
|
213
216
|
# @!attribute [rw] direct_roles
|
214
217
|
# @return [::Array<::String>]
|
215
218
|
# Roles directly assigned to this user for this account or property.
|
@@ -331,10 +334,6 @@ module Google
|
|
331
334
|
# @!attribute [r] create_time
|
332
335
|
# @return [::Google::Protobuf::Timestamp]
|
333
336
|
# Output only. Time when this FirebaseLink was originally created.
|
334
|
-
# @!attribute [rw] maximum_user_access
|
335
|
-
# @return [::Google::Analytics::Admin::V1alpha::MaximumUserAccess]
|
336
|
-
# Maximum user access to the GA4 property allowed to admins of
|
337
|
-
# the linked Firebase project.
|
338
337
|
class FirebaseLink
|
339
338
|
include ::Google::Protobuf::MessageExts
|
340
339
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -372,17 +371,17 @@ module Google
|
|
372
371
|
# Enable personalized advertising features with this integration.
|
373
372
|
# Automatically publish my Google Analytics audience lists and Google
|
374
373
|
# Analytics remarketing events/parameters to the linked Google Ads account.
|
375
|
-
# If this field is not set on create/update it will be defaulted to true.
|
376
|
-
# @!attribute [r] email_address
|
377
|
-
# @return [::String]
|
378
|
-
# Output only. Email address of the user that created the link.
|
379
|
-
# An empty string will be returned if the email address can't be retrieved.
|
374
|
+
# If this field is not set on create/update, it will be defaulted to true.
|
380
375
|
# @!attribute [r] create_time
|
381
376
|
# @return [::Google::Protobuf::Timestamp]
|
382
377
|
# Output only. Time when this link was originally created.
|
383
378
|
# @!attribute [r] update_time
|
384
379
|
# @return [::Google::Protobuf::Timestamp]
|
385
380
|
# Output only. Time when this link was last updated.
|
381
|
+
# @!attribute [r] creator_email_address
|
382
|
+
# @return [::String]
|
383
|
+
# Output only. Email address of the user that created the link.
|
384
|
+
# An empty string will be returned if the email address can't be retrieved.
|
386
385
|
class GoogleAdsLink
|
387
386
|
include ::Google::Protobuf::MessageExts
|
388
387
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -456,6 +455,26 @@ module Google
|
|
456
455
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
457
456
|
end
|
458
457
|
|
458
|
+
# A secret value used for sending hits to Measurement Protocol.
|
459
|
+
# @!attribute [r] name
|
460
|
+
# @return [::String]
|
461
|
+
# Output only. Resource name of this secret. This secret may be a child of any type of
|
462
|
+
# stream.
|
463
|
+
# Format:
|
464
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
465
|
+
# @!attribute [rw] display_name
|
466
|
+
# @return [::String]
|
467
|
+
# Required. Human-readable display name for this secret.
|
468
|
+
# @!attribute [r] secret_value
|
469
|
+
# @return [::String]
|
470
|
+
# Output only. The measurement protocol secret value. Pass this value to the api_secret
|
471
|
+
# field of the Measurement Protocol API when sending hits to this
|
472
|
+
# secret's parent property.
|
473
|
+
class MeasurementProtocolSecret
|
474
|
+
include ::Google::Protobuf::MessageExts
|
475
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
476
|
+
end
|
477
|
+
|
459
478
|
# A set of changes within a Google Analytics account or its child properties
|
460
479
|
# that resulted from the same cause. Common causes would be updates made in the
|
461
480
|
# Google Analytics UI, changes from customer support, or automatic Google
|
@@ -529,31 +548,357 @@ module Google
|
|
529
548
|
# @!attribute [rw] google_ads_link
|
530
549
|
# @return [::Google::Analytics::Admin::V1alpha::GoogleAdsLink]
|
531
550
|
# A snapshot of a GoogleAdsLink resource in change history.
|
551
|
+
# @!attribute [rw] google_signals_settings
|
552
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
553
|
+
# A snapshot of a GoogleSignalsSettings resource in change history.
|
554
|
+
# @!attribute [rw] display_video_360_advertiser_link
|
555
|
+
# @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
|
556
|
+
# A snapshot of a DisplayVideo360AdvertiserLink resource in change
|
557
|
+
# history.
|
558
|
+
# @!attribute [rw] display_video_360_advertiser_link_proposal
|
559
|
+
# @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal]
|
560
|
+
# A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in
|
561
|
+
# change history.
|
562
|
+
# @!attribute [rw] conversion_event
|
563
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
564
|
+
# A snapshot of a ConversionEvent resource in change history.
|
565
|
+
# @!attribute [rw] measurement_protocol_secret
|
566
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
567
|
+
# A snapshot of a MeasurementProtocolSecret resource in change history.
|
568
|
+
# @!attribute [rw] custom_dimension
|
569
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
570
|
+
# A snapshot of a CustomDimension resource in change history.
|
571
|
+
# @!attribute [rw] custom_metric
|
572
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
573
|
+
# A snapshot of a CustomMetric resource in change history.
|
574
|
+
# @!attribute [rw] data_retention_settings
|
575
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
|
576
|
+
# A snapshot of a data retention settings resource in change history.
|
532
577
|
class ChangeHistoryResource
|
533
578
|
include ::Google::Protobuf::MessageExts
|
534
579
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
535
580
|
end
|
536
581
|
end
|
537
582
|
|
538
|
-
#
|
539
|
-
#
|
540
|
-
|
541
|
-
|
542
|
-
|
583
|
+
# A link between a GA4 property and a Display & Video 360 advertiser.
|
584
|
+
# @!attribute [r] name
|
585
|
+
# @return [::String]
|
586
|
+
# Output only. The resource name for this DisplayVideo360AdvertiserLink resource.
|
587
|
+
# Format: properties/\\{propertyId}/displayVideo360AdvertiserLinks/\\{linkId}
|
588
|
+
#
|
589
|
+
# Note: linkId is not the Display & Video 360 Advertiser ID
|
590
|
+
# @!attribute [rw] advertiser_id
|
591
|
+
# @return [::String]
|
592
|
+
# Immutable. The Display & Video 360 Advertiser's advertiser ID.
|
593
|
+
# @!attribute [r] advertiser_display_name
|
594
|
+
# @return [::String]
|
595
|
+
# Output only. The display name of the Display & Video 360 Advertiser.
|
596
|
+
# @!attribute [rw] ads_personalization_enabled
|
597
|
+
# @return [::Google::Protobuf::BoolValue]
|
598
|
+
# Enables personalized advertising features with this integration.
|
599
|
+
# If this field is not set on create/update, it will be defaulted to true.
|
600
|
+
# @!attribute [rw] campaign_data_sharing_enabled
|
601
|
+
# @return [::Google::Protobuf::BoolValue]
|
602
|
+
# Immutable. Enables the import of campaign data from Display & Video 360 into the GA4
|
603
|
+
# property. After link creation, this can only be updated from the Display &
|
604
|
+
# Video 360 product.
|
605
|
+
# If this field is not set on create, it will be defaulted to true.
|
606
|
+
# @!attribute [rw] cost_data_sharing_enabled
|
607
|
+
# @return [::Google::Protobuf::BoolValue]
|
608
|
+
# Immutable. Enables the import of cost data from Display & Video 360 into the GA4
|
609
|
+
# property. This can only be enabled if campaign_data_import_enabled is
|
610
|
+
# enabled. After link creation, this can only be updated from the Display &
|
611
|
+
# Video 360 product.
|
612
|
+
# If this field is not set on create, it will be defaulted to true.
|
613
|
+
class DisplayVideo360AdvertiserLink
|
614
|
+
include ::Google::Protobuf::MessageExts
|
615
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
616
|
+
end
|
543
617
|
|
544
|
-
|
545
|
-
|
618
|
+
# A proposal for a link between an GA4 property and a Display & Video 360
|
619
|
+
# advertiser.
|
620
|
+
#
|
621
|
+
# A proposal is converted to a DisplayVideo360AdvertiserLink once approved.
|
622
|
+
# Google Analytics admins approve inbound proposals while Display & Video 360
|
623
|
+
# admins approve outbound proposals.
|
624
|
+
# @!attribute [r] name
|
625
|
+
# @return [::String]
|
626
|
+
# Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource.
|
627
|
+
# Format:
|
628
|
+
# properties/\\{propertyId}/displayVideo360AdvertiserLinkProposals/\\{proposalId}
|
629
|
+
#
|
630
|
+
# Note: proposalId is not the Display & Video 360 Advertiser ID
|
631
|
+
# @!attribute [rw] advertiser_id
|
632
|
+
# @return [::String]
|
633
|
+
# Immutable. The Display & Video 360 Advertiser's advertiser ID.
|
634
|
+
# @!attribute [r] link_proposal_status_details
|
635
|
+
# @return [::Google::Analytics::Admin::V1alpha::LinkProposalStatusDetails]
|
636
|
+
# Output only. The status information for this link proposal.
|
637
|
+
# @!attribute [r] advertiser_display_name
|
638
|
+
# @return [::String]
|
639
|
+
# Output only. The display name of the Display & Video Advertiser.
|
640
|
+
# Only populated for proposals that originated from Display & Video 360.
|
641
|
+
# @!attribute [rw] validation_email
|
642
|
+
# @return [::String]
|
643
|
+
# Input only. On a proposal being sent to Display & Video 360, this field must be set to
|
644
|
+
# the email address of an admin on the target advertiser. This is used to
|
645
|
+
# verify that the Google Analytics admin is aware of at least one admin on
|
646
|
+
# the Display & Video 360 Advertiser. This does not restrict approval of the
|
647
|
+
# proposal to a single user. Any admin on the Display & Video 360 Advertiser
|
648
|
+
# may approve the proposal.
|
649
|
+
# @!attribute [rw] ads_personalization_enabled
|
650
|
+
# @return [::Google::Protobuf::BoolValue]
|
651
|
+
# Immutable. Enables personalized advertising features with this integration.
|
652
|
+
# If this field is not set on create, it will be defaulted to true.
|
653
|
+
# @!attribute [rw] campaign_data_sharing_enabled
|
654
|
+
# @return [::Google::Protobuf::BoolValue]
|
655
|
+
# Immutable. Enables the import of campaign data from Display & Video 360.
|
656
|
+
# If this field is not set on create, it will be defaulted to true.
|
657
|
+
# @!attribute [rw] cost_data_sharing_enabled
|
658
|
+
# @return [::Google::Protobuf::BoolValue]
|
659
|
+
# Immutable. Enables the import of cost data from Display & Video 360.
|
660
|
+
# This can only be enabled if campaign_data_import_enabled is enabled.
|
661
|
+
# If this field is not set on create, it will be defaulted to true.
|
662
|
+
class DisplayVideo360AdvertiserLinkProposal
|
663
|
+
include ::Google::Protobuf::MessageExts
|
664
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
665
|
+
end
|
546
666
|
|
547
|
-
|
548
|
-
|
667
|
+
# Status information for a link proposal.
|
668
|
+
# @!attribute [r] link_proposal_initiating_product
|
669
|
+
# @return [::Google::Analytics::Admin::V1alpha::LinkProposalInitiatingProduct]
|
670
|
+
# Output only. The source of this proposal.
|
671
|
+
# @!attribute [r] requestor_email
|
672
|
+
# @return [::String]
|
673
|
+
# Output only. The email address of the user that proposed this linkage.
|
674
|
+
# @!attribute [r] link_proposal_state
|
675
|
+
# @return [::Google::Analytics::Admin::V1alpha::LinkProposalState]
|
676
|
+
# Output only. The state of this proposal.
|
677
|
+
class LinkProposalStatusDetails
|
678
|
+
include ::Google::Protobuf::MessageExts
|
679
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
680
|
+
end
|
549
681
|
|
550
|
-
|
551
|
-
|
552
|
-
|
682
|
+
# A conversion event in a Google Analytics property.
|
683
|
+
# @!attribute [r] name
|
684
|
+
# @return [::String]
|
685
|
+
# Output only. Resource name of this conversion event.
|
686
|
+
# Format: properties/\\{property}/conversionEvents/\\{conversion_event}
|
687
|
+
# @!attribute [rw] event_name
|
688
|
+
# @return [::String]
|
689
|
+
# Immutable. The event name for this conversion event.
|
690
|
+
# Examples: 'click', 'purchase'
|
691
|
+
# @!attribute [r] create_time
|
692
|
+
# @return [::Google::Protobuf::Timestamp]
|
693
|
+
# Output only. Time when this conversion event was created in the property.
|
694
|
+
# @!attribute [r] deletable
|
695
|
+
# @return [::Boolean]
|
696
|
+
# Output only. If set, this event can currently be deleted via DeleteConversionEvent.
|
697
|
+
# @!attribute [r] custom
|
698
|
+
# @return [::Boolean]
|
699
|
+
# Output only. If set to true, this conversion event refers to a custom event. If set to
|
700
|
+
# false, this conversion event refers to a default event in GA. Default
|
701
|
+
# events typically have special meaning in GA. Default events are usually
|
702
|
+
# created for you by the GA system, but in some cases can be created by
|
703
|
+
# property admins. Custom events count towards the maximum number of
|
704
|
+
# custom conversion events that may be created per property.
|
705
|
+
class ConversionEvent
|
706
|
+
include ::Google::Protobuf::MessageExts
|
707
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
708
|
+
end
|
553
709
|
|
554
|
-
|
555
|
-
|
556
|
-
|
710
|
+
# Settings values for Google Signals. This is a singleton resource.
|
711
|
+
# @!attribute [r] name
|
712
|
+
# @return [::String]
|
713
|
+
# Output only. Resource name of this setting.
|
714
|
+
# Format: properties/\\{property_id}/googleSignalsSettings
|
715
|
+
# Example: "properties/1000/googleSignalsSettings"
|
716
|
+
# @!attribute [rw] state
|
717
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsState]
|
718
|
+
# Status of this setting.
|
719
|
+
# @!attribute [r] consent
|
720
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsConsent]
|
721
|
+
# Output only. Terms of Service acceptance.
|
722
|
+
class GoogleSignalsSettings
|
723
|
+
include ::Google::Protobuf::MessageExts
|
724
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
725
|
+
end
|
726
|
+
|
727
|
+
# A definition for a CustomDimension.
|
728
|
+
# @!attribute [r] name
|
729
|
+
# @return [::String]
|
730
|
+
# Output only. Resource name for this CustomDimension resource.
|
731
|
+
# Format: properties/\\{property}/customDimensions/\\{customDimension}
|
732
|
+
# @!attribute [rw] parameter_name
|
733
|
+
# @return [::String]
|
734
|
+
# Required. Immutable. Tagging parameter name for this custom dimension.
|
735
|
+
#
|
736
|
+
# If this is a user-scoped dimension, then this is the user property name.
|
737
|
+
# If this is an event-scoped dimension, then this is the event parameter
|
738
|
+
# name.
|
739
|
+
#
|
740
|
+
# May only contain alphanumeric and underscore characters, starting with a
|
741
|
+
# letter. Max length of 24 characters for user-scoped dimensions, 40
|
742
|
+
# characters for event-scoped dimensions.
|
743
|
+
# @!attribute [rw] display_name
|
744
|
+
# @return [::String]
|
745
|
+
# Required. Display name for this custom dimension as shown in the Analytics UI.
|
746
|
+
# Max length of 82 characters, alphanumeric plus space and underscore
|
747
|
+
# starting with a letter. Legacy system-generated display names may contain
|
748
|
+
# square brackets, but updates to this field will never permit square
|
749
|
+
# brackets.
|
750
|
+
# @!attribute [rw] description
|
751
|
+
# @return [::String]
|
752
|
+
# Optional. Description for this custom dimension. Max length of 150 characters.
|
753
|
+
# @!attribute [rw] scope
|
754
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope]
|
755
|
+
# Required. Immutable. The scope of this dimension.
|
756
|
+
# @!attribute [rw] disallow_ads_personalization
|
757
|
+
# @return [::Boolean]
|
758
|
+
# Optional. If set to true, sets this dimension as NPA and excludes it from ads
|
759
|
+
# personalization.
|
760
|
+
#
|
761
|
+
# This is currently only supported by user-scoped custom dimensions.
|
762
|
+
class CustomDimension
|
763
|
+
include ::Google::Protobuf::MessageExts
|
764
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
765
|
+
|
766
|
+
# Valid values for the scope of this dimension.
|
767
|
+
module DimensionScope
|
768
|
+
# Scope unknown or not specified.
|
769
|
+
DIMENSION_SCOPE_UNSPECIFIED = 0
|
770
|
+
|
771
|
+
# Dimension scoped to an event.
|
772
|
+
EVENT = 1
|
773
|
+
|
774
|
+
# Dimension scoped to a user.
|
775
|
+
USER = 2
|
776
|
+
end
|
777
|
+
end
|
778
|
+
|
779
|
+
# A definition for a custom metric.
|
780
|
+
# @!attribute [r] name
|
781
|
+
# @return [::String]
|
782
|
+
# Output only. Resource name for this CustomMetric resource.
|
783
|
+
# Format: properties/\\{property}/customMetrics/\\{customMetric}
|
784
|
+
# @!attribute [rw] parameter_name
|
785
|
+
# @return [::String]
|
786
|
+
# Required. Immutable. Tagging name for this custom metric.
|
787
|
+
#
|
788
|
+
# If this is an event-scoped metric, then this is the event parameter
|
789
|
+
# name.
|
790
|
+
#
|
791
|
+
# May only contain alphanumeric and underscore charactes, starting with a
|
792
|
+
# letter. Max length of 40 characters for event-scoped metrics.
|
793
|
+
# @!attribute [rw] display_name
|
794
|
+
# @return [::String]
|
795
|
+
# Required. Display name for this custom metric as shown in the Analytics UI.
|
796
|
+
# Max length of 82 characters, alphanumeric plus space and underscore
|
797
|
+
# starting with a letter. Legacy system-generated display names may contain
|
798
|
+
# square brackets, but updates to this field will never permit square
|
799
|
+
# brackets.
|
800
|
+
# @!attribute [rw] description
|
801
|
+
# @return [::String]
|
802
|
+
# Optional. Description for this custom dimension.
|
803
|
+
# Max length of 150 characters.
|
804
|
+
# @!attribute [rw] measurement_unit
|
805
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric::MeasurementUnit]
|
806
|
+
# Required. The type for the custom metric's value.
|
807
|
+
# @!attribute [rw] scope
|
808
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric::MetricScope]
|
809
|
+
# Required. Immutable. The scope of this custom metric.
|
810
|
+
class CustomMetric
|
811
|
+
include ::Google::Protobuf::MessageExts
|
812
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
813
|
+
|
814
|
+
# Possible types of representing the custom metric's value.
|
815
|
+
#
|
816
|
+
# Currency representation may change in the future, requiring a breaking API
|
817
|
+
# change.
|
818
|
+
module MeasurementUnit
|
819
|
+
# MeasurementUnit unspecified or missing.
|
820
|
+
MEASUREMENT_UNIT_UNSPECIFIED = 0
|
821
|
+
|
822
|
+
# This metric uses default units.
|
823
|
+
STANDARD = 1
|
824
|
+
|
825
|
+
# This metric measures a currency.
|
826
|
+
CURRENCY = 2
|
827
|
+
|
828
|
+
# This metric measures feet.
|
829
|
+
FEET = 3
|
830
|
+
|
831
|
+
# This metric measures meters.
|
832
|
+
METERS = 4
|
833
|
+
|
834
|
+
# This metric measures kilometers.
|
835
|
+
KILOMETERS = 5
|
836
|
+
|
837
|
+
# This metric measures miles.
|
838
|
+
MILES = 6
|
839
|
+
|
840
|
+
# This metric measures milliseconds.
|
841
|
+
MILLISECONDS = 7
|
842
|
+
|
843
|
+
# This metric measures seconds.
|
844
|
+
SECONDS = 8
|
845
|
+
|
846
|
+
# This metric measures minutes.
|
847
|
+
MINUTES = 9
|
848
|
+
|
849
|
+
# This metric measures hours.
|
850
|
+
HOURS = 10
|
851
|
+
end
|
852
|
+
|
853
|
+
# The scope of this metric.
|
854
|
+
module MetricScope
|
855
|
+
# Scope unknown or not specified.
|
856
|
+
METRIC_SCOPE_UNSPECIFIED = 0
|
857
|
+
|
858
|
+
# Metric scoped to an event.
|
859
|
+
EVENT = 1
|
860
|
+
end
|
861
|
+
end
|
862
|
+
|
863
|
+
# Settings values for data retention. This is a singleton resource.
|
864
|
+
# @!attribute [r] name
|
865
|
+
# @return [::String]
|
866
|
+
# Output only. Resource name for this DataRetentionSetting resource.
|
867
|
+
# Format: properties/\\{property}/dataRetentionSettings
|
868
|
+
# @!attribute [rw] event_data_retention
|
869
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataRetentionSettings::RetentionDuration]
|
870
|
+
# The length of time that event-level data is retained.
|
871
|
+
# @!attribute [rw] reset_user_data_on_new_activity
|
872
|
+
# @return [::Boolean]
|
873
|
+
# If true, reset the retention period for the user identifier with every
|
874
|
+
# event from that user.
|
875
|
+
class DataRetentionSettings
|
876
|
+
include ::Google::Protobuf::MessageExts
|
877
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
878
|
+
|
879
|
+
# Valid values for the data retention duration.
|
880
|
+
module RetentionDuration
|
881
|
+
# Data retention time duration is not specified.
|
882
|
+
RETENTION_DURATION_UNSPECIFIED = 0
|
883
|
+
|
884
|
+
# The data retention time duration is 2 months.
|
885
|
+
TWO_MONTHS = 1
|
886
|
+
|
887
|
+
# The data retention time duration is 14 months.
|
888
|
+
FOURTEEN_MONTHS = 3
|
889
|
+
|
890
|
+
# The data retention time duration is 26 months.
|
891
|
+
# Available to 360 properties only.
|
892
|
+
TWENTY_SIX_MONTHS = 4
|
893
|
+
|
894
|
+
# The data retention time duration is 38 months.
|
895
|
+
# Available to 360 properties only.
|
896
|
+
THIRTY_EIGHT_MONTHS = 5
|
897
|
+
|
898
|
+
# The data retention time duration is 50 months.
|
899
|
+
# Available to 360 properties only.
|
900
|
+
FIFTY_MONTHS = 6
|
901
|
+
end
|
557
902
|
end
|
558
903
|
|
559
904
|
# The category selected for this property, used for industry benchmarking.
|
@@ -640,6 +985,18 @@ module Google
|
|
640
985
|
SHOPPING = 26
|
641
986
|
end
|
642
987
|
|
988
|
+
# Various levels of service for Google Analytics.
|
989
|
+
module ServiceLevel
|
990
|
+
# Service level not specified or invalid.
|
991
|
+
SERVICE_LEVEL_UNSPECIFIED = 0
|
992
|
+
|
993
|
+
# The standard version of Google Analytics.
|
994
|
+
GOOGLE_ANALYTICS_STANDARD = 1
|
995
|
+
|
996
|
+
# The paid, premium version of Google Analytics.
|
997
|
+
GOOGLE_ANALYTICS_360 = 2
|
998
|
+
end
|
999
|
+
|
643
1000
|
# Different kinds of actors that can make changes to Google Analytics
|
644
1001
|
# resources.
|
645
1002
|
module ActorType
|
@@ -696,6 +1053,98 @@ module Google
|
|
696
1053
|
|
697
1054
|
# GoogleAdsLink resource
|
698
1055
|
GOOGLE_ADS_LINK = 7
|
1056
|
+
|
1057
|
+
# GoogleSignalsSettings resource
|
1058
|
+
GOOGLE_SIGNALS_SETTINGS = 8
|
1059
|
+
|
1060
|
+
# ConversionEvent resource
|
1061
|
+
CONVERSION_EVENT = 9
|
1062
|
+
|
1063
|
+
# MeasurementProtocolSecret resource
|
1064
|
+
MEASUREMENT_PROTOCOL_SECRET = 10
|
1065
|
+
|
1066
|
+
# CustomDimension resource
|
1067
|
+
CUSTOM_DIMENSION = 11
|
1068
|
+
|
1069
|
+
# CustomMetric resource
|
1070
|
+
CUSTOM_METRIC = 12
|
1071
|
+
|
1072
|
+
# DataRetentionSettings resource
|
1073
|
+
DATA_RETENTION_SETTINGS = 13
|
1074
|
+
end
|
1075
|
+
|
1076
|
+
# Status of the Google Signals settings (i.e., whether this feature has been
|
1077
|
+
# enabled for the property).
|
1078
|
+
module GoogleSignalsState
|
1079
|
+
# Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to
|
1080
|
+
# represent that the user has not made an explicit choice.
|
1081
|
+
GOOGLE_SIGNALS_STATE_UNSPECIFIED = 0
|
1082
|
+
|
1083
|
+
# Google Signals is enabled.
|
1084
|
+
GOOGLE_SIGNALS_ENABLED = 1
|
1085
|
+
|
1086
|
+
# Google Signals is disabled.
|
1087
|
+
GOOGLE_SIGNALS_DISABLED = 2
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# Consent field of the Google Signals settings (i.e., whether the user has
|
1091
|
+
# consented to the Google Signals terms of service.)
|
1092
|
+
module GoogleSignalsConsent
|
1093
|
+
# Google Signals consent value defaults to
|
1094
|
+
# GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as
|
1095
|
+
# GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED.
|
1096
|
+
GOOGLE_SIGNALS_CONSENT_UNSPECIFIED = 0
|
1097
|
+
|
1098
|
+
# Terms of service have been accepted
|
1099
|
+
GOOGLE_SIGNALS_CONSENT_CONSENTED = 2
|
1100
|
+
|
1101
|
+
# Terms of service have not been accepted
|
1102
|
+
GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1
|
1103
|
+
end
|
1104
|
+
|
1105
|
+
# An indication of which product the user initiated a link proposal from.
|
1106
|
+
module LinkProposalInitiatingProduct
|
1107
|
+
# Unspecified product.
|
1108
|
+
LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED = 0
|
1109
|
+
|
1110
|
+
# This proposal was created by a user from Google Analytics.
|
1111
|
+
GOOGLE_ANALYTICS = 1
|
1112
|
+
|
1113
|
+
# This proposal was created by a user from a linked product (not Google
|
1114
|
+
# Analytics).
|
1115
|
+
LINKED_PRODUCT = 2
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
# The state of a link proposal resource.
|
1119
|
+
module LinkProposalState
|
1120
|
+
# Unspecified state
|
1121
|
+
LINK_PROPOSAL_STATE_UNSPECIFIED = 0
|
1122
|
+
|
1123
|
+
# This proposal is awaiting review from a Google Analytics user. This
|
1124
|
+
# proposal will automatically expire after some time.
|
1125
|
+
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS = 1
|
1126
|
+
|
1127
|
+
# This proposal is awaiting review from a user of a linked product. This
|
1128
|
+
# proposal will automatically expire after some time.
|
1129
|
+
AWAITING_REVIEW_FROM_LINKED_PRODUCT = 2
|
1130
|
+
|
1131
|
+
# This proposal has been withdrawn by an admin on the initiating product.
|
1132
|
+
# This proposal will be automatically deleted after some time.
|
1133
|
+
WITHDRAWN = 3
|
1134
|
+
|
1135
|
+
# This proposal has been declined by an admin on the receiving product. This
|
1136
|
+
# proposal will be automatically deleted after some time.
|
1137
|
+
DECLINED = 4
|
1138
|
+
|
1139
|
+
# This proposal expired due to lack of response from an admin on the
|
1140
|
+
# receiving product. This proposal will be automatically deleted after some
|
1141
|
+
# time.
|
1142
|
+
EXPIRED = 5
|
1143
|
+
|
1144
|
+
# This proposal has become obsolete because a link was directly created to
|
1145
|
+
# the same external product resource that this proposal specifies. This
|
1146
|
+
# proposal will be automatically deleted after some time.
|
1147
|
+
OBSOLETE = 6
|
699
1148
|
end
|
700
1149
|
end
|
701
1150
|
end
|