google-apis-analyticsadmin_v1alpha 0.32.0 → 0.35.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fccf28352d1f5420dfd38bb3e43f76288c3c217233ec0009a2a22f31575b741f
4
- data.tar.gz: cc3211ac162dc4d1ca790ed6b660b48cdc3a3dc7bc73dfcb543e256e4f71734c
3
+ metadata.gz: 13a5b16d0a6618012f6bac9320e09edd0462c2d73df945e7b17cf2eb90b45fec
4
+ data.tar.gz: 3c49a6ce6464ff3a3b639b174472f40904fef6e04f1e77482be3a54d4d753e42
5
5
  SHA512:
6
- metadata.gz: 263a5a412e09c15e1a04c620e1f1678e5f1df780da050fa18f4f045352c3a8de65adf7b7de6bfedb477e4e18a345d9b0e811e5ae62b59a7a5201d2b9e977d4d0
7
- data.tar.gz: 9823d90df85dafbb0853c3c51b47e3591dfbf5c581f5ed4e724d3d430c9ecbfa7ef921b1807db568542047ffa60105682b272dbb37d1837711a60fe664b111d6
6
+ metadata.gz: 6a7ab88cd281972166af606bacc636ea6fa8f56857c01ab27a0d95495c44fcf695975131b92cb8b171e7bdf5ec3f9b782ec853e9207d083542d148a0aa3e0a65
7
+ data.tar.gz: 1ffc02b9748fea12a66de6be14be66af7ed478b8e7776e4b3d38e8f2815a937fb720c420b74a4ce67a47fbcf7f56a142af2ae4a5eae63bf7cf107f3388349226
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.35.0 (2022-08-04)
4
+
5
+ * Regenerated from discovery document revision 20220803
6
+
7
+ ### v0.34.0 (2022-07-27)
8
+
9
+ * Regenerated from discovery document revision 20220725
10
+
11
+ ### v0.33.0 (2022-07-08)
12
+
13
+ * Regenerated from discovery document revision 20220706
14
+ * Regenerated using generator version 0.9.0
15
+
3
16
  ### v0.32.0 (2022-06-30)
4
17
 
5
18
  * Regenerated using generator version 0.8.0
@@ -84,7 +84,9 @@ module Google
84
84
  class GoogleAnalyticsAdminV1alphaAccessDimension
85
85
  include Google::Apis::Core::Hashable
86
86
 
87
- # The API name of the dimension. Dimensions are referenced by name in `
87
+ # The API name of the dimension. See [Data Access Schema](https://developers.
88
+ # google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list
89
+ # of dimensions supported in this API. Dimensions are referenced by name in `
88
90
  # dimensionFilter` and `orderBys`.
89
91
  # Corresponds to the JSON property `dimensionName`
90
92
  # @return [String]
@@ -107,7 +109,7 @@ module Google
107
109
  class GoogleAnalyticsAdminV1alphaAccessDimensionHeader
108
110
  include Google::Apis::Core::Hashable
109
111
 
110
- # The dimension's name; for example 'country'.
112
+ # The dimension's name; for example 'userEmail'.
111
113
  # Corresponds to the JSON property `dimensionName`
112
114
  # @return [String]
113
115
  attr_accessor :dimension_name
@@ -274,8 +276,10 @@ module Google
274
276
  class GoogleAnalyticsAdminV1alphaAccessMetric
275
277
  include Google::Apis::Core::Hashable
276
278
 
277
- # The API name of the metric. Metrics are referenced by name in `metricFilter` &
278
- # `orderBys`.
279
+ # The API name of the metric. See [Data Access Schema](https://developers.google.
280
+ # com/analytics/devguides/config/admin/v1/access-api-schema) for the list of
281
+ # metrics supported in this API. Metrics are referenced by name in `metricFilter`
282
+ # & `orderBys`.
279
283
  # Corresponds to the JSON property `metricName`
280
284
  # @return [String]
281
285
  attr_accessor :metric_name
@@ -719,6 +723,19 @@ module Google
719
723
  end
720
724
  end
721
725
 
726
+ # Request message for ArchiveAudience RPC.
727
+ class GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
728
+ include Google::Apis::Core::Hashable
729
+
730
+ def initialize(**args)
731
+ update!(**args)
732
+ end
733
+
734
+ # Update properties of this object
735
+ def update!(**args)
736
+ end
737
+ end
738
+
722
739
  # Request message for ArchiveCustomDimension RPC.
723
740
  class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
724
741
  include Google::Apis::Core::Hashable
@@ -790,6 +807,534 @@ module Google
790
807
  end
791
808
  end
792
809
 
810
+ # A resource message representing a GA4 Audience.
811
+ class GoogleAnalyticsAdminV1alphaAudience
812
+ include Google::Apis::Core::Hashable
813
+
814
+ # Output only. It is automatically set by GA to false if this is an NPA Audience
815
+ # and is excluded from ads personalization.
816
+ # Corresponds to the JSON property `adsPersonalizationEnabled`
817
+ # @return [Boolean]
818
+ attr_accessor :ads_personalization_enabled
819
+ alias_method :ads_personalization_enabled?, :ads_personalization_enabled
820
+
821
+ # Required. The description of the Audience.
822
+ # Corresponds to the JSON property `description`
823
+ # @return [String]
824
+ attr_accessor :description
825
+
826
+ # Required. The display name of the Audience.
827
+ # Corresponds to the JSON property `displayName`
828
+ # @return [String]
829
+ attr_accessor :display_name
830
+
831
+ # Specifies an event to log when a user joins the Audience.
832
+ # Corresponds to the JSON property `eventTrigger`
833
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger]
834
+ attr_accessor :event_trigger
835
+
836
+ # Immutable. Specifies how long an exclusion lasts for users that meet the
837
+ # exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored
838
+ # when there is no EXCLUDE filter clause in the Audience.
839
+ # Corresponds to the JSON property `exclusionDurationMode`
840
+ # @return [String]
841
+ attr_accessor :exclusion_duration_mode
842
+
843
+ # Required. Immutable. null Filter clauses that define the Audience. All clauses
844
+ # will be AND’ed together.
845
+ # Corresponds to the JSON property `filterClauses`
846
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause>]
847
+ attr_accessor :filter_clauses
848
+
849
+ # Required. Immutable. The duration a user should stay in an Audience. It cannot
850
+ # be set to more than 540 days.
851
+ # Corresponds to the JSON property `membershipDurationDays`
852
+ # @return [Fixnum]
853
+ attr_accessor :membership_duration_days
854
+
855
+ # Output only. The resource name for this Audience resource. Format: properties/`
856
+ # propertyId`/audiences/`audienceId`
857
+ # Corresponds to the JSON property `name`
858
+ # @return [String]
859
+ attr_accessor :name
860
+
861
+ def initialize(**args)
862
+ update!(**args)
863
+ end
864
+
865
+ # Update properties of this object
866
+ def update!(**args)
867
+ @ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
868
+ @description = args[:description] if args.key?(:description)
869
+ @display_name = args[:display_name] if args.key?(:display_name)
870
+ @event_trigger = args[:event_trigger] if args.key?(:event_trigger)
871
+ @exclusion_duration_mode = args[:exclusion_duration_mode] if args.key?(:exclusion_duration_mode)
872
+ @filter_clauses = args[:filter_clauses] if args.key?(:filter_clauses)
873
+ @membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days)
874
+ @name = args[:name] if args.key?(:name)
875
+ end
876
+ end
877
+
878
+ # A specific filter for a single dimension or metric.
879
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
880
+ include Google::Apis::Core::Hashable
881
+
882
+ # Optional. Indicates whether this filter needs dynamic evaluation or not. If
883
+ # set to true, users join the Audience if they ever met the condition (static
884
+ # evaluation). If unset or set to false, user evaluation for an Audience is
885
+ # dynamic; users are added to an Audience when they meet the conditions and then
886
+ # removed when they no longer meet them. This can only be set when Audience
887
+ # scope is ACROSS_ALL_SESSIONS.
888
+ # Corresponds to the JSON property `atAnyPointInTime`
889
+ # @return [Boolean]
890
+ attr_accessor :at_any_point_in_time
891
+ alias_method :at_any_point_in_time?, :at_any_point_in_time
892
+
893
+ # A filter for numeric or date values between certain values on a dimension or
894
+ # metric.
895
+ # Corresponds to the JSON property `betweenFilter`
896
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter]
897
+ attr_accessor :between_filter
898
+
899
+ # Required. Immutable. The dimension name or metric name to filter.
900
+ # Corresponds to the JSON property `fieldName`
901
+ # @return [String]
902
+ attr_accessor :field_name
903
+
904
+ # Optional. If set, specifies the time window for which to evaluate data in
905
+ # number of days. If not set, then audience data is evaluated against lifetime
906
+ # data (i.e., infinite time window). For example, if set to 1 day, only the
907
+ # current day's data is evaluated. The reference point is the current day when
908
+ # at_any_point_in_time is unset or false. It can only be set when Audience scope
909
+ # is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
910
+ # Corresponds to the JSON property `inAnyNDayPeriod`
911
+ # @return [Fixnum]
912
+ attr_accessor :in_any_n_day_period
913
+
914
+ # A filter for a string dimension that matches a particular list of options.
915
+ # Corresponds to the JSON property `inListFilter`
916
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter]
917
+ attr_accessor :in_list_filter
918
+
919
+ # A filter for numeric or date values on a dimension or metric.
920
+ # Corresponds to the JSON property `numericFilter`
921
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter]
922
+ attr_accessor :numeric_filter
923
+
924
+ # A filter for a string-type dimension that matches a particular pattern.
925
+ # Corresponds to the JSON property `stringFilter`
926
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter]
927
+ attr_accessor :string_filter
928
+
929
+ def initialize(**args)
930
+ update!(**args)
931
+ end
932
+
933
+ # Update properties of this object
934
+ def update!(**args)
935
+ @at_any_point_in_time = args[:at_any_point_in_time] if args.key?(:at_any_point_in_time)
936
+ @between_filter = args[:between_filter] if args.key?(:between_filter)
937
+ @field_name = args[:field_name] if args.key?(:field_name)
938
+ @in_any_n_day_period = args[:in_any_n_day_period] if args.key?(:in_any_n_day_period)
939
+ @in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
940
+ @numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
941
+ @string_filter = args[:string_filter] if args.key?(:string_filter)
942
+ end
943
+ end
944
+
945
+ # A filter for numeric or date values between certain values on a dimension or
946
+ # metric.
947
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
948
+ include Google::Apis::Core::Hashable
949
+
950
+ # To represent a number.
951
+ # Corresponds to the JSON property `fromValue`
952
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
953
+ attr_accessor :from_value
954
+
955
+ # To represent a number.
956
+ # Corresponds to the JSON property `toValue`
957
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
958
+ attr_accessor :to_value
959
+
960
+ def initialize(**args)
961
+ update!(**args)
962
+ end
963
+
964
+ # Update properties of this object
965
+ def update!(**args)
966
+ @from_value = args[:from_value] if args.key?(:from_value)
967
+ @to_value = args[:to_value] if args.key?(:to_value)
968
+ end
969
+ end
970
+
971
+ # A filter for a string dimension that matches a particular list of options.
972
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
973
+ include Google::Apis::Core::Hashable
974
+
975
+ # Optional. If true, the match is case-sensitive. If false, the match is case-
976
+ # insensitive.
977
+ # Corresponds to the JSON property `caseSensitive`
978
+ # @return [Boolean]
979
+ attr_accessor :case_sensitive
980
+ alias_method :case_sensitive?, :case_sensitive
981
+
982
+ # Required. The list of possible string values to match against. Must be non-
983
+ # empty.
984
+ # Corresponds to the JSON property `values`
985
+ # @return [Array<String>]
986
+ attr_accessor :values
987
+
988
+ def initialize(**args)
989
+ update!(**args)
990
+ end
991
+
992
+ # Update properties of this object
993
+ def update!(**args)
994
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
995
+ @values = args[:values] if args.key?(:values)
996
+ end
997
+ end
998
+
999
+ # A filter for numeric or date values on a dimension or metric.
1000
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
1001
+ include Google::Apis::Core::Hashable
1002
+
1003
+ # Required. The operation applied to a numeric filter.
1004
+ # Corresponds to the JSON property `operation`
1005
+ # @return [String]
1006
+ attr_accessor :operation
1007
+
1008
+ # To represent a number.
1009
+ # Corresponds to the JSON property `value`
1010
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
1011
+ attr_accessor :value
1012
+
1013
+ def initialize(**args)
1014
+ update!(**args)
1015
+ end
1016
+
1017
+ # Update properties of this object
1018
+ def update!(**args)
1019
+ @operation = args[:operation] if args.key?(:operation)
1020
+ @value = args[:value] if args.key?(:value)
1021
+ end
1022
+ end
1023
+
1024
+ # To represent a number.
1025
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
1026
+ include Google::Apis::Core::Hashable
1027
+
1028
+ # Double value.
1029
+ # Corresponds to the JSON property `doubleValue`
1030
+ # @return [Float]
1031
+ attr_accessor :double_value
1032
+
1033
+ # Integer value.
1034
+ # Corresponds to the JSON property `int64Value`
1035
+ # @return [Fixnum]
1036
+ attr_accessor :int64_value
1037
+
1038
+ def initialize(**args)
1039
+ update!(**args)
1040
+ end
1041
+
1042
+ # Update properties of this object
1043
+ def update!(**args)
1044
+ @double_value = args[:double_value] if args.key?(:double_value)
1045
+ @int64_value = args[:int64_value] if args.key?(:int64_value)
1046
+ end
1047
+ end
1048
+
1049
+ # A filter for a string-type dimension that matches a particular pattern.
1050
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
1051
+ include Google::Apis::Core::Hashable
1052
+
1053
+ # Optional. If true, the match is case-sensitive. If false, the match is case-
1054
+ # insensitive.
1055
+ # Corresponds to the JSON property `caseSensitive`
1056
+ # @return [Boolean]
1057
+ attr_accessor :case_sensitive
1058
+ alias_method :case_sensitive?, :case_sensitive
1059
+
1060
+ # Required. The match type for the string filter.
1061
+ # Corresponds to the JSON property `matchType`
1062
+ # @return [String]
1063
+ attr_accessor :match_type
1064
+
1065
+ # Required. The string value to be matched against.
1066
+ # Corresponds to the JSON property `value`
1067
+ # @return [String]
1068
+ attr_accessor :value
1069
+
1070
+ def initialize(**args)
1071
+ update!(**args)
1072
+ end
1073
+
1074
+ # Update properties of this object
1075
+ def update!(**args)
1076
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
1077
+ @match_type = args[:match_type] if args.key?(:match_type)
1078
+ @value = args[:value] if args.key?(:value)
1079
+ end
1080
+ end
1081
+
1082
+ # A filter that matches events of a single event name. If an event parameter is
1083
+ # specified, only the subset of events that match both the single event name and
1084
+ # the parameter filter expressions match this event filter.
1085
+ class GoogleAnalyticsAdminV1alphaAudienceEventFilter
1086
+ include Google::Apis::Core::Hashable
1087
+
1088
+ # Required. Immutable. The name of the event to match against.
1089
+ # Corresponds to the JSON property `eventName`
1090
+ # @return [String]
1091
+ attr_accessor :event_name
1092
+
1093
+ # A logical expression of Audience dimension, metric, or event filters.
1094
+ # Corresponds to the JSON property `eventParameterFilterExpression`
1095
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
1096
+ attr_accessor :event_parameter_filter_expression
1097
+
1098
+ def initialize(**args)
1099
+ update!(**args)
1100
+ end
1101
+
1102
+ # Update properties of this object
1103
+ def update!(**args)
1104
+ @event_name = args[:event_name] if args.key?(:event_name)
1105
+ @event_parameter_filter_expression = args[:event_parameter_filter_expression] if args.key?(:event_parameter_filter_expression)
1106
+ end
1107
+ end
1108
+
1109
+ # Specifies an event to log when a user joins the Audience.
1110
+ class GoogleAnalyticsAdminV1alphaAudienceEventTrigger
1111
+ include Google::Apis::Core::Hashable
1112
+
1113
+ # Required. The event name that will be logged.
1114
+ # Corresponds to the JSON property `eventName`
1115
+ # @return [String]
1116
+ attr_accessor :event_name
1117
+
1118
+ # Required. When to log the event.
1119
+ # Corresponds to the JSON property `logCondition`
1120
+ # @return [String]
1121
+ attr_accessor :log_condition
1122
+
1123
+ def initialize(**args)
1124
+ update!(**args)
1125
+ end
1126
+
1127
+ # Update properties of this object
1128
+ def update!(**args)
1129
+ @event_name = args[:event_name] if args.key?(:event_name)
1130
+ @log_condition = args[:log_condition] if args.key?(:log_condition)
1131
+ end
1132
+ end
1133
+
1134
+ # A clause for defining either a simple or sequence filter. A filter can be
1135
+ # inclusive (i.e., users satisfying the filter clause are included in the
1136
+ # Audience) or exclusive (i.e., users satisfying the filter clause are excluded
1137
+ # from the Audience).
1138
+ class GoogleAnalyticsAdminV1alphaAudienceFilterClause
1139
+ include Google::Apis::Core::Hashable
1140
+
1141
+ # Required. Specifies whether this is an include or exclude filter clause.
1142
+ # Corresponds to the JSON property `clauseType`
1143
+ # @return [String]
1144
+ attr_accessor :clause_type
1145
+
1146
+ # Defines filters that must occur in a specific order for the user to be a
1147
+ # member of the Audience.
1148
+ # Corresponds to the JSON property `sequenceFilter`
1149
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilter]
1150
+ attr_accessor :sequence_filter
1151
+
1152
+ # Defines a simple filter that a user must satisfy to be a member of the
1153
+ # Audience.
1154
+ # Corresponds to the JSON property `simpleFilter`
1155
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSimpleFilter]
1156
+ attr_accessor :simple_filter
1157
+
1158
+ def initialize(**args)
1159
+ update!(**args)
1160
+ end
1161
+
1162
+ # Update properties of this object
1163
+ def update!(**args)
1164
+ @clause_type = args[:clause_type] if args.key?(:clause_type)
1165
+ @sequence_filter = args[:sequence_filter] if args.key?(:sequence_filter)
1166
+ @simple_filter = args[:simple_filter] if args.key?(:simple_filter)
1167
+ end
1168
+ end
1169
+
1170
+ # A logical expression of Audience dimension, metric, or event filters.
1171
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpression
1172
+ include Google::Apis::Core::Hashable
1173
+
1174
+ # A list of Audience filter expressions.
1175
+ # Corresponds to the JSON property `andGroup`
1176
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList]
1177
+ attr_accessor :and_group
1178
+
1179
+ # A specific filter for a single dimension or metric.
1180
+ # Corresponds to the JSON property `dimensionOrMetricFilter`
1181
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter]
1182
+ attr_accessor :dimension_or_metric_filter
1183
+
1184
+ # A filter that matches events of a single event name. If an event parameter is
1185
+ # specified, only the subset of events that match both the single event name and
1186
+ # the parameter filter expressions match this event filter.
1187
+ # Corresponds to the JSON property `eventFilter`
1188
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventFilter]
1189
+ attr_accessor :event_filter
1190
+
1191
+ # A logical expression of Audience dimension, metric, or event filters.
1192
+ # Corresponds to the JSON property `notExpression`
1193
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
1194
+ attr_accessor :not_expression
1195
+
1196
+ # A list of Audience filter expressions.
1197
+ # Corresponds to the JSON property `orGroup`
1198
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList]
1199
+ attr_accessor :or_group
1200
+
1201
+ def initialize(**args)
1202
+ update!(**args)
1203
+ end
1204
+
1205
+ # Update properties of this object
1206
+ def update!(**args)
1207
+ @and_group = args[:and_group] if args.key?(:and_group)
1208
+ @dimension_or_metric_filter = args[:dimension_or_metric_filter] if args.key?(:dimension_or_metric_filter)
1209
+ @event_filter = args[:event_filter] if args.key?(:event_filter)
1210
+ @not_expression = args[:not_expression] if args.key?(:not_expression)
1211
+ @or_group = args[:or_group] if args.key?(:or_group)
1212
+ end
1213
+ end
1214
+
1215
+ # A list of Audience filter expressions.
1216
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
1217
+ include Google::Apis::Core::Hashable
1218
+
1219
+ # A list of Audience filter expressions.
1220
+ # Corresponds to the JSON property `filterExpressions`
1221
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression>]
1222
+ attr_accessor :filter_expressions
1223
+
1224
+ def initialize(**args)
1225
+ update!(**args)
1226
+ end
1227
+
1228
+ # Update properties of this object
1229
+ def update!(**args)
1230
+ @filter_expressions = args[:filter_expressions] if args.key?(:filter_expressions)
1231
+ end
1232
+ end
1233
+
1234
+ # Defines filters that must occur in a specific order for the user to be a
1235
+ # member of the Audience.
1236
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
1237
+ include Google::Apis::Core::Hashable
1238
+
1239
+ # Required. Immutable. Specifies the scope for this filter.
1240
+ # Corresponds to the JSON property `scope`
1241
+ # @return [String]
1242
+ attr_accessor :scope
1243
+
1244
+ # Optional. Defines the time period in which the whole sequence must occur.
1245
+ # Corresponds to the JSON property `sequenceMaximumDuration`
1246
+ # @return [String]
1247
+ attr_accessor :sequence_maximum_duration
1248
+
1249
+ # Required. An ordered sequence of steps. A user must complete each step in
1250
+ # order to join the sequence filter.
1251
+ # Corresponds to the JSON property `sequenceSteps`
1252
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep>]
1253
+ attr_accessor :sequence_steps
1254
+
1255
+ def initialize(**args)
1256
+ update!(**args)
1257
+ end
1258
+
1259
+ # Update properties of this object
1260
+ def update!(**args)
1261
+ @scope = args[:scope] if args.key?(:scope)
1262
+ @sequence_maximum_duration = args[:sequence_maximum_duration] if args.key?(:sequence_maximum_duration)
1263
+ @sequence_steps = args[:sequence_steps] if args.key?(:sequence_steps)
1264
+ end
1265
+ end
1266
+
1267
+ # A condition that must occur in the specified step order for this user to match
1268
+ # the sequence.
1269
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
1270
+ include Google::Apis::Core::Hashable
1271
+
1272
+ # Optional. When set, this step must be satisfied within the constraint_duration
1273
+ # of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set,
1274
+ # there is no duration requirement (the duration is effectively unlimited). It
1275
+ # is ignored for the first step.
1276
+ # Corresponds to the JSON property `constraintDuration`
1277
+ # @return [String]
1278
+ attr_accessor :constraint_duration
1279
+
1280
+ # A logical expression of Audience dimension, metric, or event filters.
1281
+ # Corresponds to the JSON property `filterExpression`
1282
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
1283
+ attr_accessor :filter_expression
1284
+
1285
+ # Optional. If true, the event satisfying this step must be the very next event
1286
+ # after the event satisfying the last step. If unset or false, this step
1287
+ # indirectly follows the prior step; for example, there may be events between
1288
+ # the prior step and this step. It is ignored for the first step.
1289
+ # Corresponds to the JSON property `immediatelyFollows`
1290
+ # @return [Boolean]
1291
+ attr_accessor :immediately_follows
1292
+ alias_method :immediately_follows?, :immediately_follows
1293
+
1294
+ # Required. Immutable. Specifies the scope for this step.
1295
+ # Corresponds to the JSON property `scope`
1296
+ # @return [String]
1297
+ attr_accessor :scope
1298
+
1299
+ def initialize(**args)
1300
+ update!(**args)
1301
+ end
1302
+
1303
+ # Update properties of this object
1304
+ def update!(**args)
1305
+ @constraint_duration = args[:constraint_duration] if args.key?(:constraint_duration)
1306
+ @filter_expression = args[:filter_expression] if args.key?(:filter_expression)
1307
+ @immediately_follows = args[:immediately_follows] if args.key?(:immediately_follows)
1308
+ @scope = args[:scope] if args.key?(:scope)
1309
+ end
1310
+ end
1311
+
1312
+ # Defines a simple filter that a user must satisfy to be a member of the
1313
+ # Audience.
1314
+ class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
1315
+ include Google::Apis::Core::Hashable
1316
+
1317
+ # A logical expression of Audience dimension, metric, or event filters.
1318
+ # Corresponds to the JSON property `filterExpression`
1319
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
1320
+ attr_accessor :filter_expression
1321
+
1322
+ # Required. Immutable. Specifies the scope for this filter.
1323
+ # Corresponds to the JSON property `scope`
1324
+ # @return [String]
1325
+ attr_accessor :scope
1326
+
1327
+ def initialize(**args)
1328
+ update!(**args)
1329
+ end
1330
+
1331
+ # Update properties of this object
1332
+ def update!(**args)
1333
+ @filter_expression = args[:filter_expression] if args.key?(:filter_expression)
1334
+ @scope = args[:scope] if args.key?(:scope)
1335
+ end
1336
+ end
1337
+
793
1338
  # Read-only resource used to summarize a principal's effective roles.
794
1339
  class GoogleAnalyticsAdminV1alphaAuditUserLink
795
1340
  include Google::Apis::Core::Hashable
@@ -2088,6 +2633,32 @@ module Google
2088
2633
  end
2089
2634
  end
2090
2635
 
2636
+ # Response message for ListAudiences RPC.
2637
+ class GoogleAnalyticsAdminV1alphaListAudiencesResponse
2638
+ include Google::Apis::Core::Hashable
2639
+
2640
+ # List of Audiences.
2641
+ # Corresponds to the JSON property `audiences`
2642
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience>]
2643
+ attr_accessor :audiences
2644
+
2645
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
2646
+ # field is omitted, there are no subsequent pages.
2647
+ # Corresponds to the JSON property `nextPageToken`
2648
+ # @return [String]
2649
+ attr_accessor :next_page_token
2650
+
2651
+ def initialize(**args)
2652
+ update!(**args)
2653
+ end
2654
+
2655
+ # Update properties of this object
2656
+ def update!(**args)
2657
+ @audiences = args[:audiences] if args.key?(:audiences)
2658
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2659
+ end
2660
+ end
2661
+
2091
2662
  # Response message for ListConversionEvents RPC.
2092
2663
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
2093
2664
  include Google::Apis::Core::Hashable
@@ -2691,11 +3262,11 @@ module Google
2691
3262
  attr_accessor :order_bys
2692
3263
 
2693
3264
  # Toggles whether to return the current state of this Analytics Property's quota.
2694
- # Quota is returned in [PropertyQuota](#PropertyQuota).
2695
- # Corresponds to the JSON property `returnPropertyQuota`
3265
+ # Quota is returned in [AccessQuota](#AccessQuota).
3266
+ # Corresponds to the JSON property `returnEntityQuota`
2696
3267
  # @return [Boolean]
2697
- attr_accessor :return_property_quota
2698
- alias_method :return_property_quota?, :return_property_quota
3268
+ attr_accessor :return_entity_quota
3269
+ alias_method :return_entity_quota?, :return_entity_quota
2699
3270
 
2700
3271
  # This request's time zone if specified. If unspecified, the property's time
2701
3272
  # zone is used. The request's time zone is used to interpret the start & end
@@ -2720,7 +3291,7 @@ module Google
2720
3291
  @metrics = args[:metrics] if args.key?(:metrics)
2721
3292
  @offset = args[:offset] if args.key?(:offset)
2722
3293
  @order_bys = args[:order_bys] if args.key?(:order_bys)
2723
- @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
3294
+ @return_entity_quota = args[:return_entity_quota] if args.key?(:return_entity_quota)
2724
3295
  @time_zone = args[:time_zone] if args.key?(:time_zone)
2725
3296
  end
2726
3297
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AnalyticsadminV1alpha
18
18
  # Version of the google-apis-analyticsadmin_v1alpha gem
19
- GEM_VERSION = "0.32.0"
19
+ GEM_VERSION = "0.35.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.8.0"
22
+ GENERATOR_VERSION = "0.9.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220625"
25
+ REVISION = "20220803"
26
26
  end
27
27
  end
28
28
  end
@@ -178,6 +178,12 @@ module Google
178
178
  include Google::Apis::Core::JsonObjectSupport
179
179
  end
180
180
 
181
+ class GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
182
+ class Representation < Google::Apis::Core::JsonRepresentation; end
183
+
184
+ include Google::Apis::Core::JsonObjectSupport
185
+ end
186
+
181
187
  class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
182
188
  class Representation < Google::Apis::Core::JsonRepresentation; end
183
189
 
@@ -196,6 +202,96 @@ module Google
196
202
  include Google::Apis::Core::JsonObjectSupport
197
203
  end
198
204
 
205
+ class GoogleAnalyticsAdminV1alphaAudience
206
+ class Representation < Google::Apis::Core::JsonRepresentation; end
207
+
208
+ include Google::Apis::Core::JsonObjectSupport
209
+ end
210
+
211
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
217
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
218
+ class Representation < Google::Apis::Core::JsonRepresentation; end
219
+
220
+ include Google::Apis::Core::JsonObjectSupport
221
+ end
222
+
223
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
224
+ class Representation < Google::Apis::Core::JsonRepresentation; end
225
+
226
+ include Google::Apis::Core::JsonObjectSupport
227
+ end
228
+
229
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
230
+ class Representation < Google::Apis::Core::JsonRepresentation; end
231
+
232
+ include Google::Apis::Core::JsonObjectSupport
233
+ end
234
+
235
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
236
+ class Representation < Google::Apis::Core::JsonRepresentation; end
237
+
238
+ include Google::Apis::Core::JsonObjectSupport
239
+ end
240
+
241
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
242
+ class Representation < Google::Apis::Core::JsonRepresentation; end
243
+
244
+ include Google::Apis::Core::JsonObjectSupport
245
+ end
246
+
247
+ class GoogleAnalyticsAdminV1alphaAudienceEventFilter
248
+ class Representation < Google::Apis::Core::JsonRepresentation; end
249
+
250
+ include Google::Apis::Core::JsonObjectSupport
251
+ end
252
+
253
+ class GoogleAnalyticsAdminV1alphaAudienceEventTrigger
254
+ class Representation < Google::Apis::Core::JsonRepresentation; end
255
+
256
+ include Google::Apis::Core::JsonObjectSupport
257
+ end
258
+
259
+ class GoogleAnalyticsAdminV1alphaAudienceFilterClause
260
+ class Representation < Google::Apis::Core::JsonRepresentation; end
261
+
262
+ include Google::Apis::Core::JsonObjectSupport
263
+ end
264
+
265
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpression
266
+ class Representation < Google::Apis::Core::JsonRepresentation; end
267
+
268
+ include Google::Apis::Core::JsonObjectSupport
269
+ end
270
+
271
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
272
+ class Representation < Google::Apis::Core::JsonRepresentation; end
273
+
274
+ include Google::Apis::Core::JsonObjectSupport
275
+ end
276
+
277
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
278
+ class Representation < Google::Apis::Core::JsonRepresentation; end
279
+
280
+ include Google::Apis::Core::JsonObjectSupport
281
+ end
282
+
283
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
284
+ class Representation < Google::Apis::Core::JsonRepresentation; end
285
+
286
+ include Google::Apis::Core::JsonObjectSupport
287
+ end
288
+
289
+ class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
290
+ class Representation < Google::Apis::Core::JsonRepresentation; end
291
+
292
+ include Google::Apis::Core::JsonObjectSupport
293
+ end
294
+
199
295
  class GoogleAnalyticsAdminV1alphaAuditUserLink
200
296
  class Representation < Google::Apis::Core::JsonRepresentation; end
201
297
 
@@ -394,6 +490,12 @@ module Google
394
490
  include Google::Apis::Core::JsonObjectSupport
395
491
  end
396
492
 
493
+ class GoogleAnalyticsAdminV1alphaListAudiencesResponse
494
+ class Representation < Google::Apis::Core::JsonRepresentation; end
495
+
496
+ include Google::Apis::Core::JsonObjectSupport
497
+ end
498
+
397
499
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
398
500
  class Representation < Google::Apis::Core::JsonRepresentation; end
399
501
 
@@ -769,6 +871,12 @@ module Google
769
871
  end
770
872
  end
771
873
 
874
+ class GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
875
+ # @private
876
+ class Representation < Google::Apis::Core::JsonRepresentation
877
+ end
878
+ end
879
+
772
880
  class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
773
881
  # @private
774
882
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -791,6 +899,165 @@ module Google
791
899
  end
792
900
  end
793
901
 
902
+ class GoogleAnalyticsAdminV1alphaAudience
903
+ # @private
904
+ class Representation < Google::Apis::Core::JsonRepresentation
905
+ property :ads_personalization_enabled, as: 'adsPersonalizationEnabled'
906
+ property :description, as: 'description'
907
+ property :display_name, as: 'displayName'
908
+ property :event_trigger, as: 'eventTrigger', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger::Representation
909
+
910
+ property :exclusion_duration_mode, as: 'exclusionDurationMode'
911
+ collection :filter_clauses, as: 'filterClauses', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause::Representation
912
+
913
+ property :membership_duration_days, as: 'membershipDurationDays'
914
+ property :name, as: 'name'
915
+ end
916
+ end
917
+
918
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
919
+ # @private
920
+ class Representation < Google::Apis::Core::JsonRepresentation
921
+ property :at_any_point_in_time, as: 'atAnyPointInTime'
922
+ property :between_filter, as: 'betweenFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter::Representation
923
+
924
+ property :field_name, as: 'fieldName'
925
+ property :in_any_n_day_period, as: 'inAnyNDayPeriod'
926
+ property :in_list_filter, as: 'inListFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter::Representation
927
+
928
+ property :numeric_filter, as: 'numericFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter::Representation
929
+
930
+ property :string_filter, as: 'stringFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter::Representation
931
+
932
+ end
933
+ end
934
+
935
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
936
+ # @private
937
+ class Representation < Google::Apis::Core::JsonRepresentation
938
+ property :from_value, as: 'fromValue', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue::Representation
939
+
940
+ property :to_value, as: 'toValue', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue::Representation
941
+
942
+ end
943
+ end
944
+
945
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
946
+ # @private
947
+ class Representation < Google::Apis::Core::JsonRepresentation
948
+ property :case_sensitive, as: 'caseSensitive'
949
+ collection :values, as: 'values'
950
+ end
951
+ end
952
+
953
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
954
+ # @private
955
+ class Representation < Google::Apis::Core::JsonRepresentation
956
+ property :operation, as: 'operation'
957
+ property :value, as: 'value', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue::Representation
958
+
959
+ end
960
+ end
961
+
962
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
963
+ # @private
964
+ class Representation < Google::Apis::Core::JsonRepresentation
965
+ property :double_value, as: 'doubleValue'
966
+ property :int64_value, :numeric_string => true, as: 'int64Value'
967
+ end
968
+ end
969
+
970
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
971
+ # @private
972
+ class Representation < Google::Apis::Core::JsonRepresentation
973
+ property :case_sensitive, as: 'caseSensitive'
974
+ property :match_type, as: 'matchType'
975
+ property :value, as: 'value'
976
+ end
977
+ end
978
+
979
+ class GoogleAnalyticsAdminV1alphaAudienceEventFilter
980
+ # @private
981
+ class Representation < Google::Apis::Core::JsonRepresentation
982
+ property :event_name, as: 'eventName'
983
+ property :event_parameter_filter_expression, as: 'eventParameterFilterExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
984
+
985
+ end
986
+ end
987
+
988
+ class GoogleAnalyticsAdminV1alphaAudienceEventTrigger
989
+ # @private
990
+ class Representation < Google::Apis::Core::JsonRepresentation
991
+ property :event_name, as: 'eventName'
992
+ property :log_condition, as: 'logCondition'
993
+ end
994
+ end
995
+
996
+ class GoogleAnalyticsAdminV1alphaAudienceFilterClause
997
+ # @private
998
+ class Representation < Google::Apis::Core::JsonRepresentation
999
+ property :clause_type, as: 'clauseType'
1000
+ property :sequence_filter, as: 'sequenceFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilter::Representation
1001
+
1002
+ property :simple_filter, as: 'simpleFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSimpleFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSimpleFilter::Representation
1003
+
1004
+ end
1005
+ end
1006
+
1007
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpression
1008
+ # @private
1009
+ class Representation < Google::Apis::Core::JsonRepresentation
1010
+ property :and_group, as: 'andGroup', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList::Representation
1011
+
1012
+ property :dimension_or_metric_filter, as: 'dimensionOrMetricFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter::Representation
1013
+
1014
+ property :event_filter, as: 'eventFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventFilter::Representation
1015
+
1016
+ property :not_expression, as: 'notExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
1017
+
1018
+ property :or_group, as: 'orGroup', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList::Representation
1019
+
1020
+ end
1021
+ end
1022
+
1023
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
1024
+ # @private
1025
+ class Representation < Google::Apis::Core::JsonRepresentation
1026
+ collection :filter_expressions, as: 'filterExpressions', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
1027
+
1028
+ end
1029
+ end
1030
+
1031
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
1032
+ # @private
1033
+ class Representation < Google::Apis::Core::JsonRepresentation
1034
+ property :scope, as: 'scope'
1035
+ property :sequence_maximum_duration, as: 'sequenceMaximumDuration'
1036
+ collection :sequence_steps, as: 'sequenceSteps', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep::Representation
1037
+
1038
+ end
1039
+ end
1040
+
1041
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
1042
+ # @private
1043
+ class Representation < Google::Apis::Core::JsonRepresentation
1044
+ property :constraint_duration, as: 'constraintDuration'
1045
+ property :filter_expression, as: 'filterExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
1046
+
1047
+ property :immediately_follows, as: 'immediatelyFollows'
1048
+ property :scope, as: 'scope'
1049
+ end
1050
+ end
1051
+
1052
+ class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
1053
+ # @private
1054
+ class Representation < Google::Apis::Core::JsonRepresentation
1055
+ property :filter_expression, as: 'filterExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
1056
+
1057
+ property :scope, as: 'scope'
1058
+ end
1059
+ end
1060
+
794
1061
  class GoogleAnalyticsAdminV1alphaAuditUserLink
795
1062
  # @private
796
1063
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1141,6 +1408,15 @@ module Google
1141
1408
  end
1142
1409
  end
1143
1410
 
1411
+ class GoogleAnalyticsAdminV1alphaListAudiencesResponse
1412
+ # @private
1413
+ class Representation < Google::Apis::Core::JsonRepresentation
1414
+ collection :audiences, as: 'audiences', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1415
+
1416
+ property :next_page_token, as: 'nextPageToken'
1417
+ end
1418
+ end
1419
+
1144
1420
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
1145
1421
  # @private
1146
1422
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1319,7 +1595,7 @@ module Google
1319
1595
  property :offset, :numeric_string => true, as: 'offset'
1320
1596
  collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderBy, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessOrderBy::Representation
1321
1597
 
1322
- property :return_property_quota, as: 'returnPropertyQuota'
1598
+ property :return_entity_quota, as: 'returnEntityQuota'
1323
1599
  property :time_zone, as: 'timeZone'
1324
1600
  end
1325
1601
  end
@@ -1173,6 +1173,184 @@ module Google
1173
1173
  execute_or_queue_command(command, &block)
1174
1174
  end
1175
1175
 
1176
+ # Archives an Audience on a property.
1177
+ # @param [String] name
1178
+ # Required. Example format: properties/1234/audiences/5678
1179
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveAudienceRequest] google_analytics_admin_v1alpha_archive_audience_request_object
1180
+ # @param [String] fields
1181
+ # Selector specifying which fields to include in a partial response.
1182
+ # @param [String] quota_user
1183
+ # Available to use for quota purposes for server-side applications. Can be any
1184
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1185
+ # @param [Google::Apis::RequestOptions] options
1186
+ # Request-specific options
1187
+ #
1188
+ # @yield [result, err] Result & error if block supplied
1189
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1190
+ # @yieldparam err [StandardError] error object if request failed
1191
+ #
1192
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1193
+ #
1194
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1195
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1196
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1197
+ def archive_property_audience(name, google_analytics_admin_v1alpha_archive_audience_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1198
+ command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1199
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveAudienceRequest::Representation
1200
+ command.request_object = google_analytics_admin_v1alpha_archive_audience_request_object
1201
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1202
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1203
+ command.params['name'] = name unless name.nil?
1204
+ command.query['fields'] = fields unless fields.nil?
1205
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1206
+ execute_or_queue_command(command, &block)
1207
+ end
1208
+
1209
+ # Creates an Audience.
1210
+ # @param [String] parent
1211
+ # Required. Example format: properties/1234
1212
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] google_analytics_admin_v1alpha_audience_object
1213
+ # @param [String] fields
1214
+ # Selector specifying which fields to include in a partial response.
1215
+ # @param [String] quota_user
1216
+ # Available to use for quota purposes for server-side applications. Can be any
1217
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1218
+ # @param [Google::Apis::RequestOptions] options
1219
+ # Request-specific options
1220
+ #
1221
+ # @yield [result, err] Result & error if block supplied
1222
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] parsed result object
1223
+ # @yieldparam err [StandardError] error object if request failed
1224
+ #
1225
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience]
1226
+ #
1227
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1228
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1229
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1230
+ def create_property_audience(parent, google_analytics_admin_v1alpha_audience_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1231
+ command = make_simple_command(:post, 'v1alpha/{+parent}/audiences', options)
1232
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1233
+ command.request_object = google_analytics_admin_v1alpha_audience_object
1234
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1235
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience
1236
+ command.params['parent'] = parent unless parent.nil?
1237
+ command.query['fields'] = fields unless fields.nil?
1238
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1239
+ execute_or_queue_command(command, &block)
1240
+ end
1241
+
1242
+ # Lookup for a single Audience. Audiences created before 2020 may not be
1243
+ # supported.
1244
+ # @param [String] name
1245
+ # Required. The name of the Audience to get. Example format: properties/1234/
1246
+ # audiences/5678
1247
+ # @param [String] fields
1248
+ # Selector specifying which fields to include in a partial response.
1249
+ # @param [String] quota_user
1250
+ # Available to use for quota purposes for server-side applications. Can be any
1251
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1252
+ # @param [Google::Apis::RequestOptions] options
1253
+ # Request-specific options
1254
+ #
1255
+ # @yield [result, err] Result & error if block supplied
1256
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] parsed result object
1257
+ # @yieldparam err [StandardError] error object if request failed
1258
+ #
1259
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience]
1260
+ #
1261
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1262
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1263
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1264
+ def get_property_audience(name, fields: nil, quota_user: nil, options: nil, &block)
1265
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1266
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1267
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience
1268
+ command.params['name'] = name unless name.nil?
1269
+ command.query['fields'] = fields unless fields.nil?
1270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1271
+ execute_or_queue_command(command, &block)
1272
+ end
1273
+
1274
+ # Lists Audiences on a property. Audiences created before 2020 may not be
1275
+ # supported.
1276
+ # @param [String] parent
1277
+ # Required. Example format: properties/1234
1278
+ # @param [Fixnum] page_size
1279
+ # The maximum number of resources to return. If unspecified, at most 50
1280
+ # resources will be returned. The maximum value is 200 (higher values will be
1281
+ # coerced to the maximum).
1282
+ # @param [String] page_token
1283
+ # A page token, received from a previous `ListAudiences` call. Provide this to
1284
+ # retrieve the subsequent page. When paginating, all other parameters provided
1285
+ # to `ListAudiences` must match the call that provided the page token.
1286
+ # @param [String] fields
1287
+ # Selector specifying which fields to include in a partial response.
1288
+ # @param [String] quota_user
1289
+ # Available to use for quota purposes for server-side applications. Can be any
1290
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1291
+ # @param [Google::Apis::RequestOptions] options
1292
+ # Request-specific options
1293
+ #
1294
+ # @yield [result, err] Result & error if block supplied
1295
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse] parsed result object
1296
+ # @yieldparam err [StandardError] error object if request failed
1297
+ #
1298
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse]
1299
+ #
1300
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1301
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1302
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1303
+ def list_property_audiences(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1304
+ command = make_simple_command(:get, 'v1alpha/{+parent}/audiences', options)
1305
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse::Representation
1306
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse
1307
+ command.params['parent'] = parent unless parent.nil?
1308
+ command.query['pageSize'] = page_size unless page_size.nil?
1309
+ command.query['pageToken'] = page_token unless page_token.nil?
1310
+ command.query['fields'] = fields unless fields.nil?
1311
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1312
+ execute_or_queue_command(command, &block)
1313
+ end
1314
+
1315
+ # Updates an Audience on a property.
1316
+ # @param [String] name
1317
+ # Output only. The resource name for this Audience resource. Format: properties/`
1318
+ # propertyId`/audiences/`audienceId`
1319
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] google_analytics_admin_v1alpha_audience_object
1320
+ # @param [String] update_mask
1321
+ # Required. The list of fields to be updated. Field names must be in snake case (
1322
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1323
+ # entire entity, use one path with the string "*" to match all fields.
1324
+ # @param [String] fields
1325
+ # Selector specifying which fields to include in a partial response.
1326
+ # @param [String] quota_user
1327
+ # Available to use for quota purposes for server-side applications. Can be any
1328
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1329
+ # @param [Google::Apis::RequestOptions] options
1330
+ # Request-specific options
1331
+ #
1332
+ # @yield [result, err] Result & error if block supplied
1333
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] parsed result object
1334
+ # @yieldparam err [StandardError] error object if request failed
1335
+ #
1336
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience]
1337
+ #
1338
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1339
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1340
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1341
+ def patch_property_audience(name, google_analytics_admin_v1alpha_audience_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1342
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1343
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1344
+ command.request_object = google_analytics_admin_v1alpha_audience_object
1345
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1346
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience
1347
+ command.params['name'] = name unless name.nil?
1348
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1349
+ command.query['fields'] = fields unless fields.nil?
1350
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1351
+ execute_or_queue_command(command, &block)
1352
+ end
1353
+
1176
1354
  # Creates a conversion event with the specified attributes.
1177
1355
  # @param [String] parent
1178
1356
  # Required. The resource name of the parent property where this conversion event
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-analyticsadmin_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.32.0
4
+ version: 0.35.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: 2022-07-04 00:00:00.000000000 Z
11
+ date: 2022-08-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.32.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.35.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []