google-analytics-admin-v1alpha 0.8.2 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +74 -5
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1201 -249
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +48 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +37 -2
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +70 -10
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +206 -14
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +222 -25
- metadata +2 -2
@@ -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
|
@@ -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
|
@@ -373,16 +372,16 @@ module Google
|
|
373
372
|
# Automatically publish my Google Analytics audience lists and Google
|
374
373
|
# Analytics remarketing events/parameters to the linked Google Ads account.
|
375
374
|
# 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.
|
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
|
@@ -552,6 +551,14 @@ module Google
|
|
552
551
|
# @!attribute [rw] google_signals_settings
|
553
552
|
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
554
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.
|
555
562
|
# @!attribute [rw] conversion_event
|
556
563
|
# @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
557
564
|
# A snapshot of a ConversionEvent resource in change history.
|
@@ -564,12 +571,114 @@ module Google
|
|
564
571
|
# @!attribute [rw] custom_metric
|
565
572
|
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
566
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.
|
567
577
|
class ChangeHistoryResource
|
568
578
|
include ::Google::Protobuf::MessageExts
|
569
579
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
570
580
|
end
|
571
581
|
end
|
572
582
|
|
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
|
617
|
+
|
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
|
666
|
+
|
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
|
681
|
+
|
573
682
|
# A conversion event in a Google Analytics property.
|
574
683
|
# @!attribute [r] name
|
575
684
|
# @return [::String]
|
@@ -582,9 +691,17 @@ module Google
|
|
582
691
|
# @!attribute [r] create_time
|
583
692
|
# @return [::Google::Protobuf::Timestamp]
|
584
693
|
# Output only. Time when this conversion event was created in the property.
|
585
|
-
# @!attribute [r]
|
694
|
+
# @!attribute [r] deletable
|
586
695
|
# @return [::Boolean]
|
587
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.
|
588
705
|
class ConversionEvent
|
589
706
|
include ::Google::Protobuf::MessageExts
|
590
707
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -686,7 +803,7 @@ module Google
|
|
686
803
|
# Max length of 150 characters.
|
687
804
|
# @!attribute [rw] measurement_unit
|
688
805
|
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric::MeasurementUnit]
|
689
|
-
# Required.
|
806
|
+
# Required. The type for the custom metric's value.
|
690
807
|
# @!attribute [rw] scope
|
691
808
|
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric::MetricScope]
|
692
809
|
# Required. Immutable. The scope of this custom metric.
|
@@ -743,25 +860,45 @@ module Google
|
|
743
860
|
end
|
744
861
|
end
|
745
862
|
|
746
|
-
#
|
747
|
-
#
|
748
|
-
|
749
|
-
|
750
|
-
|
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
|
751
878
|
|
752
|
-
#
|
753
|
-
|
879
|
+
# Valid values for the data retention duration.
|
880
|
+
module RetentionDuration
|
881
|
+
# Data retention time duration is not specified.
|
882
|
+
RETENTION_DURATION_UNSPECIFIED = 0
|
754
883
|
|
755
|
-
|
756
|
-
|
884
|
+
# The data retention time duration is 2 months.
|
885
|
+
TWO_MONTHS = 1
|
757
886
|
|
758
|
-
|
759
|
-
|
760
|
-
EDITOR_WITHOUT_LINK_MANAGEMENT = 3
|
887
|
+
# The data retention time duration is 14 months.
|
888
|
+
FOURTEEN_MONTHS = 3
|
761
889
|
|
762
|
-
|
763
|
-
|
764
|
-
|
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
|
765
902
|
end
|
766
903
|
|
767
904
|
# The category selected for this property, used for industry benchmarking.
|
@@ -848,6 +985,18 @@ module Google
|
|
848
985
|
SHOPPING = 26
|
849
986
|
end
|
850
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
|
+
|
851
1000
|
# Different kinds of actors that can make changes to Google Analytics
|
852
1001
|
# resources.
|
853
1002
|
module ActorType
|
@@ -919,6 +1068,9 @@ module Google
|
|
919
1068
|
|
920
1069
|
# CustomMetric resource
|
921
1070
|
CUSTOM_METRIC = 12
|
1071
|
+
|
1072
|
+
# DataRetentionSettings resource
|
1073
|
+
DATA_RETENTION_SETTINGS = 13
|
922
1074
|
end
|
923
1075
|
|
924
1076
|
# Status of the Google Signals settings (i.e., whether this feature has been
|
@@ -949,6 +1101,51 @@ module Google
|
|
949
1101
|
# Terms of service have not been accepted
|
950
1102
|
GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1
|
951
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
|
1148
|
+
end
|
952
1149
|
end
|
953
1150
|
end
|
954
1151
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-analytics-admin-v1alpha
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.9.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-08-
|
11
|
+
date: 2021-08-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|