google-analytics-admin-v1alpha 0.12.0 → 0.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,383 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Analytics
22
+ module Admin
23
+ module V1alpha
24
+ # Dimensions are attributes of your data. For example, the dimension
25
+ # `userEmail` indicates the email of the user that accessed reporting data.
26
+ # Dimension values in report responses are strings.
27
+ # @!attribute [rw] dimension_name
28
+ # @return [::String]
29
+ # The API name of the dimension. See [Data Access
30
+ # Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema)
31
+ # for the list of dimensions supported in this API.
32
+ #
33
+ # Dimensions are referenced by name in `dimensionFilter` and `orderBys`.
34
+ class AccessDimension
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+
39
+ # The quantitative measurements of a report. For example, the metric
40
+ # `accessCount` is the total number of data access records.
41
+ # @!attribute [rw] metric_name
42
+ # @return [::String]
43
+ # The API name of the metric. See [Data Access
44
+ # Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema)
45
+ # for the list of metrics supported in this API.
46
+ #
47
+ # Metrics are referenced by name in `metricFilter` & `orderBys`.
48
+ class AccessMetric
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+ end
52
+
53
+ # A contiguous range of days: startDate, startDate + 1, ..., endDate.
54
+ # @!attribute [rw] start_date
55
+ # @return [::String]
56
+ # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
57
+ # be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also
58
+ # accepted, and in that case, the date is inferred based on the current time
59
+ # in the request's time zone.
60
+ # @!attribute [rw] end_date
61
+ # @return [::String]
62
+ # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot
63
+ # be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is
64
+ # also accepted, and in that case, the date is inferred based on the current
65
+ # time in the request's time zone.
66
+ class AccessDateRange
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
71
+ # Expresses dimension or metric filters. The fields in the same expression need
72
+ # to be either all dimensions or all metrics.
73
+ # @!attribute [rw] and_group
74
+ # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpressionList]
75
+ # Each of the FilterExpressions in the and_group has an AND relationship.
76
+ # @!attribute [rw] or_group
77
+ # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpressionList]
78
+ # Each of the FilterExpressions in the or_group has an OR relationship.
79
+ # @!attribute [rw] not_expression
80
+ # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression]
81
+ # The FilterExpression is NOT of not_expression.
82
+ # @!attribute [rw] access_filter
83
+ # @return [::Google::Analytics::Admin::V1alpha::AccessFilter]
84
+ # A primitive filter. In the same FilterExpression, all of the filter's
85
+ # field names need to be either all dimensions or all metrics.
86
+ class AccessFilterExpression
87
+ include ::Google::Protobuf::MessageExts
88
+ extend ::Google::Protobuf::MessageExts::ClassMethods
89
+ end
90
+
91
+ # A list of filter expressions.
92
+ # @!attribute [rw] expressions
93
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessFilterExpression>]
94
+ # A list of filter expressions.
95
+ class AccessFilterExpressionList
96
+ include ::Google::Protobuf::MessageExts
97
+ extend ::Google::Protobuf::MessageExts::ClassMethods
98
+ end
99
+
100
+ # An expression to filter dimension or metric values.
101
+ # @!attribute [rw] string_filter
102
+ # @return [::Google::Analytics::Admin::V1alpha::AccessStringFilter]
103
+ # Strings related filter.
104
+ # @!attribute [rw] in_list_filter
105
+ # @return [::Google::Analytics::Admin::V1alpha::AccessInListFilter]
106
+ # A filter for in list values.
107
+ # @!attribute [rw] numeric_filter
108
+ # @return [::Google::Analytics::Admin::V1alpha::AccessNumericFilter]
109
+ # A filter for numeric or date values.
110
+ # @!attribute [rw] between_filter
111
+ # @return [::Google::Analytics::Admin::V1alpha::AccessBetweenFilter]
112
+ # A filter for two values.
113
+ # @!attribute [rw] field_name
114
+ # @return [::String]
115
+ # The dimension name or metric name.
116
+ class AccessFilter
117
+ include ::Google::Protobuf::MessageExts
118
+ extend ::Google::Protobuf::MessageExts::ClassMethods
119
+ end
120
+
121
+ # The filter for strings.
122
+ # @!attribute [rw] match_type
123
+ # @return [::Google::Analytics::Admin::V1alpha::AccessStringFilter::MatchType]
124
+ # The match type for this filter.
125
+ # @!attribute [rw] value
126
+ # @return [::String]
127
+ # The string value used for the matching.
128
+ # @!attribute [rw] case_sensitive
129
+ # @return [::Boolean]
130
+ # If true, the string value is case sensitive.
131
+ class AccessStringFilter
132
+ include ::Google::Protobuf::MessageExts
133
+ extend ::Google::Protobuf::MessageExts::ClassMethods
134
+
135
+ # The match type of a string filter.
136
+ module MatchType
137
+ # Unspecified
138
+ MATCH_TYPE_UNSPECIFIED = 0
139
+
140
+ # Exact match of the string value.
141
+ EXACT = 1
142
+
143
+ # Begins with the string value.
144
+ BEGINS_WITH = 2
145
+
146
+ # Ends with the string value.
147
+ ENDS_WITH = 3
148
+
149
+ # Contains the string value.
150
+ CONTAINS = 4
151
+
152
+ # Full match for the regular expression with the string value.
153
+ FULL_REGEXP = 5
154
+
155
+ # Partial match for the regular expression with the string value.
156
+ PARTIAL_REGEXP = 6
157
+ end
158
+ end
159
+
160
+ # The result needs to be in a list of string values.
161
+ # @!attribute [rw] values
162
+ # @return [::Array<::String>]
163
+ # The list of string values. Must be non-empty.
164
+ # @!attribute [rw] case_sensitive
165
+ # @return [::Boolean]
166
+ # If true, the string value is case sensitive.
167
+ class AccessInListFilter
168
+ include ::Google::Protobuf::MessageExts
169
+ extend ::Google::Protobuf::MessageExts::ClassMethods
170
+ end
171
+
172
+ # Filters for numeric or date values.
173
+ # @!attribute [rw] operation
174
+ # @return [::Google::Analytics::Admin::V1alpha::AccessNumericFilter::Operation]
175
+ # The operation type for this filter.
176
+ # @!attribute [rw] value
177
+ # @return [::Google::Analytics::Admin::V1alpha::NumericValue]
178
+ # A numeric value or a date value.
179
+ class AccessNumericFilter
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+
183
+ # The operation applied to a numeric filter.
184
+ module Operation
185
+ # Unspecified.
186
+ OPERATION_UNSPECIFIED = 0
187
+
188
+ # Equal
189
+ EQUAL = 1
190
+
191
+ # Less than
192
+ LESS_THAN = 2
193
+
194
+ # Less than or equal
195
+ LESS_THAN_OR_EQUAL = 3
196
+
197
+ # Greater than
198
+ GREATER_THAN = 4
199
+
200
+ # Greater than or equal
201
+ GREATER_THAN_OR_EQUAL = 5
202
+ end
203
+ end
204
+
205
+ # To express that the result needs to be between two numbers (inclusive).
206
+ # @!attribute [rw] from_value
207
+ # @return [::Google::Analytics::Admin::V1alpha::NumericValue]
208
+ # Begins with this number.
209
+ # @!attribute [rw] to_value
210
+ # @return [::Google::Analytics::Admin::V1alpha::NumericValue]
211
+ # Ends with this number.
212
+ class AccessBetweenFilter
213
+ include ::Google::Protobuf::MessageExts
214
+ extend ::Google::Protobuf::MessageExts::ClassMethods
215
+ end
216
+
217
+ # To represent a number.
218
+ # @!attribute [rw] int64_value
219
+ # @return [::Integer]
220
+ # Integer value
221
+ # @!attribute [rw] double_value
222
+ # @return [::Float]
223
+ # Double value
224
+ class NumericValue
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Order bys define how rows will be sorted in the response. For example,
230
+ # ordering rows by descending access count is one ordering, and ordering rows
231
+ # by the country string is a different ordering.
232
+ # @!attribute [rw] metric
233
+ # @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::MetricOrderBy]
234
+ # Sorts results by a metric's values.
235
+ # @!attribute [rw] dimension
236
+ # @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::DimensionOrderBy]
237
+ # Sorts results by a dimension's values.
238
+ # @!attribute [rw] desc
239
+ # @return [::Boolean]
240
+ # If true, sorts by descending order. If false or unspecified, sorts in
241
+ # ascending order.
242
+ class AccessOrderBy
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
+
246
+ # Sorts by metric values.
247
+ # @!attribute [rw] metric_name
248
+ # @return [::String]
249
+ # A metric name in the request to order by.
250
+ class MetricOrderBy
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+ end
254
+
255
+ # Sorts by dimension values.
256
+ # @!attribute [rw] dimension_name
257
+ # @return [::String]
258
+ # A dimension name in the request to order by.
259
+ # @!attribute [rw] order_type
260
+ # @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::DimensionOrderBy::OrderType]
261
+ # Controls the rule for dimension value ordering.
262
+ class DimensionOrderBy
263
+ include ::Google::Protobuf::MessageExts
264
+ extend ::Google::Protobuf::MessageExts::ClassMethods
265
+
266
+ # Rule to order the string dimension values by.
267
+ module OrderType
268
+ # Unspecified.
269
+ ORDER_TYPE_UNSPECIFIED = 0
270
+
271
+ # Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" <
272
+ # "b" < "z".
273
+ ALPHANUMERIC = 1
274
+
275
+ # Case insensitive alphanumeric sort by lower case Unicode code point.
276
+ # For example, "2" < "A" < "b" < "X" < "z".
277
+ CASE_INSENSITIVE_ALPHANUMERIC = 2
278
+
279
+ # Dimension values are converted to numbers before sorting. For example
280
+ # in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" <
281
+ # "25". Non-numeric dimension values all have equal ordering value below
282
+ # all numeric values.
283
+ NUMERIC = 3
284
+ end
285
+ end
286
+ end
287
+
288
+ # Describes a dimension column in the report. Dimensions requested in a report
289
+ # produce column entries within rows and DimensionHeaders. However, dimensions
290
+ # used exclusively within filters or expressions do not produce columns in a
291
+ # report; correspondingly, those dimensions do not produce headers.
292
+ # @!attribute [rw] dimension_name
293
+ # @return [::String]
294
+ # The dimension's name; for example 'userEmail'.
295
+ class AccessDimensionHeader
296
+ include ::Google::Protobuf::MessageExts
297
+ extend ::Google::Protobuf::MessageExts::ClassMethods
298
+ end
299
+
300
+ # Describes a metric column in the report. Visible metrics requested in a
301
+ # report produce column entries within rows and MetricHeaders. However,
302
+ # metrics used exclusively within filters or expressions do not produce columns
303
+ # in a report; correspondingly, those metrics do not produce headers.
304
+ # @!attribute [rw] metric_name
305
+ # @return [::String]
306
+ # The metric's name; for example 'accessCount'.
307
+ class AccessMetricHeader
308
+ include ::Google::Protobuf::MessageExts
309
+ extend ::Google::Protobuf::MessageExts::ClassMethods
310
+ end
311
+
312
+ # Access report data for each row.
313
+ # @!attribute [rw] dimension_values
314
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimensionValue>]
315
+ # List of dimension values. These values are in the same order as specified
316
+ # in the request.
317
+ # @!attribute [rw] metric_values
318
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessMetricValue>]
319
+ # List of metric values. These values are in the same order as specified
320
+ # in the request.
321
+ class AccessRow
322
+ include ::Google::Protobuf::MessageExts
323
+ extend ::Google::Protobuf::MessageExts::ClassMethods
324
+ end
325
+
326
+ # The value of a dimension.
327
+ # @!attribute [rw] value
328
+ # @return [::String]
329
+ # The dimension value. For example, this value may be 'France' for the
330
+ # 'country' dimension.
331
+ class AccessDimensionValue
332
+ include ::Google::Protobuf::MessageExts
333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
334
+ end
335
+
336
+ # The value of a metric.
337
+ # @!attribute [rw] value
338
+ # @return [::String]
339
+ # The measurement value. For example, this value may be '13'.
340
+ class AccessMetricValue
341
+ include ::Google::Protobuf::MessageExts
342
+ extend ::Google::Protobuf::MessageExts::ClassMethods
343
+ end
344
+
345
+ # Current state of all quotas for this Analytics property. If any quota for a
346
+ # property is exhausted, all requests to that property will return Resource
347
+ # Exhausted errors.
348
+ # @!attribute [rw] tokens_per_day
349
+ # @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
350
+ # Properties can use 250,000 tokens per day. Most requests consume fewer than
351
+ # 10 tokens.
352
+ # @!attribute [rw] tokens_per_hour
353
+ # @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
354
+ # Properties can use 50,000 tokens per hour. An API request consumes a single
355
+ # number of tokens, and that number is deducted from both the hourly and
356
+ # daily quotas.
357
+ # @!attribute [rw] concurrent_requests
358
+ # @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
359
+ # Properties can use up to 50 concurrent requests.
360
+ # @!attribute [rw] server_errors_per_project_per_hour
361
+ # @return [::Google::Analytics::Admin::V1alpha::AccessQuotaStatus]
362
+ # Properties and cloud project pairs can have up to 50 server errors per
363
+ # hour.
364
+ class AccessQuota
365
+ include ::Google::Protobuf::MessageExts
366
+ extend ::Google::Protobuf::MessageExts::ClassMethods
367
+ end
368
+
369
+ # Current state for a particular quota group.
370
+ # @!attribute [rw] consumed
371
+ # @return [::Integer]
372
+ # Quota consumed by this request.
373
+ # @!attribute [rw] remaining
374
+ # @return [::Integer]
375
+ # Quota remaining after this request.
376
+ class AccessQuotaStatus
377
+ include ::Google::Protobuf::MessageExts
378
+ extend ::Google::Protobuf::MessageExts::ClassMethods
379
+ end
380
+ end
381
+ end
382
+ end
383
+ end
@@ -21,6 +21,115 @@ module Google
21
21
  module Analytics
22
22
  module Admin
23
23
  module V1alpha
24
+ # The request for a Data Access Record Report.
25
+ # @!attribute [rw] entity
26
+ # @return [::String]
27
+ # The Data Access Report is requested for this property.
28
+ # For example if "123" is your GA4 property ID, then entity should be
29
+ # "properties/123".
30
+ # @!attribute [rw] dimensions
31
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension>]
32
+ # The dimensions requested and displayed in the response. Requests are
33
+ # allowed up to 9 dimensions.
34
+ # @!attribute [rw] metrics
35
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessMetric>]
36
+ # The metrics requested and displayed in the response. Requests are allowed
37
+ # up to 10 metrics.
38
+ # @!attribute [rw] date_ranges
39
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange>]
40
+ # Date ranges of access records to read. If multiple date ranges are
41
+ # requested, each response row will contain a zero based date range index. If
42
+ # two date ranges overlap, the access records for the overlapping days is
43
+ # included in the response rows for both date ranges. Requests are allowed up
44
+ # to 2 date ranges.
45
+ # @!attribute [rw] dimension_filter
46
+ # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression]
47
+ # Dimension filters allow you to restrict report response to specific
48
+ # dimension values which match the filter. For example, filtering on access
49
+ # records of a single user. To learn more, see [Fundamentals of Dimension
50
+ # Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
51
+ # for examples. Metrics cannot be used in this filter.
52
+ # @!attribute [rw] metric_filter
53
+ # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression]
54
+ # Metric filters allow you to restrict report response to specific metric
55
+ # values which match the filter. Metric filters are applied after aggregating
56
+ # the report's rows, similar to SQL having-clause. Dimensions cannot be used
57
+ # in this filter.
58
+ # @!attribute [rw] offset
59
+ # @return [::Integer]
60
+ # The row count of the start row. The first row is counted as row 0. If
61
+ # offset is unspecified, it is treated as 0. If offset is zero, then this
62
+ # method will return the first page of results with `limit` entries.
63
+ #
64
+ # To learn more about this pagination parameter, see
65
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
66
+ # @!attribute [rw] limit
67
+ # @return [::Integer]
68
+ # The number of rows to return. If unspecified, 10,000 rows are returned. The
69
+ # API returns a maximum of 100,000 rows per request, no matter how many you
70
+ # ask for. `limit` must be positive.
71
+ #
72
+ # The API may return fewer rows than the requested `limit`, if there aren't
73
+ # as many remaining rows as the `limit`. For instance, there are fewer than
74
+ # 300 possible values for the dimension `country`, so when reporting on only
75
+ # `country`, you can't get more than 300 rows, even if you set `limit` to a
76
+ # higher value.
77
+ #
78
+ # To learn more about this pagination parameter, see
79
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
80
+ # @!attribute [rw] time_zone
81
+ # @return [::String]
82
+ # This request's time zone if specified. If unspecified, the property's time
83
+ # zone is used. The request's time zone is used to interpret the start & end
84
+ # dates of the report.
85
+ #
86
+ # Formatted as strings from the IANA Time Zone database
87
+ # (https://www.iana.org/time-zones); for example "America/New_York" or
88
+ # "Asia/Tokyo".
89
+ # @!attribute [rw] order_bys
90
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy>]
91
+ # Specifies how rows are ordered in the response.
92
+ # @!attribute [rw] return_entity_quota
93
+ # @return [::Boolean]
94
+ # Toggles whether to return the current state of this Analytics Property's
95
+ # quota. Quota is returned in [AccessQuota](#AccessQuota).
96
+ class RunAccessReportRequest
97
+ include ::Google::Protobuf::MessageExts
98
+ extend ::Google::Protobuf::MessageExts::ClassMethods
99
+ end
100
+
101
+ # The customized Data Access Record Report response.
102
+ # @!attribute [rw] dimension_headers
103
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimensionHeader>]
104
+ # The header for a column in the report that corresponds to a specific
105
+ # dimension. The number of DimensionHeaders and ordering of DimensionHeaders
106
+ # matches the dimensions present in rows.
107
+ # @!attribute [rw] metric_headers
108
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessMetricHeader>]
109
+ # The header for a column in the report that corresponds to a specific
110
+ # metric. The number of MetricHeaders and ordering of MetricHeaders matches
111
+ # the metrics present in rows.
112
+ # @!attribute [rw] rows
113
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessRow>]
114
+ # Rows of dimension value combinations and metric values in the report.
115
+ # @!attribute [rw] row_count
116
+ # @return [::Integer]
117
+ # The total number of rows in the query result. `rowCount` is independent of
118
+ # the number of rows returned in the response, the `limit` request
119
+ # parameter, and the `offset` request parameter. For example if a query
120
+ # returns 175 rows and includes `limit` of 50 in the API request, the
121
+ # response will contain `rowCount` of 175 but only 50 rows.
122
+ #
123
+ # To learn more about this pagination parameter, see
124
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
125
+ # @!attribute [rw] quota
126
+ # @return [::Google::Analytics::Admin::V1alpha::AccessQuota]
127
+ # The quota state for this Analytics property including this request.
128
+ class RunAccessReportResponse
129
+ include ::Google::Protobuf::MessageExts
130
+ extend ::Google::Protobuf::MessageExts::ClassMethods
131
+ end
132
+
24
133
  # Request message for GetAccount RPC.
25
134
  # @!attribute [rw] name
26
135
  # @return [::String]
@@ -1318,6 +1427,111 @@ module Google
1318
1427
  include ::Google::Protobuf::MessageExts
1319
1428
  extend ::Google::Protobuf::MessageExts::ClassMethods
1320
1429
  end
1430
+
1431
+ # Request message for GetAudience RPC.
1432
+ # @!attribute [rw] name
1433
+ # @return [::String]
1434
+ # Required. The name of the Audience to get.
1435
+ # Example format: properties/1234/audiences/5678
1436
+ class GetAudienceRequest
1437
+ include ::Google::Protobuf::MessageExts
1438
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1439
+ end
1440
+
1441
+ # Request message for ListAudiences RPC.
1442
+ # @!attribute [rw] parent
1443
+ # @return [::String]
1444
+ # Required. Example format: properties/1234
1445
+ # @!attribute [rw] page_size
1446
+ # @return [::Integer]
1447
+ # The maximum number of resources to return.
1448
+ # If unspecified, at most 50 resources will be returned.
1449
+ # The maximum value is 200 (higher values will be coerced to the maximum).
1450
+ # @!attribute [rw] page_token
1451
+ # @return [::String]
1452
+ # A page token, received from a previous `ListAudiences` call. Provide this
1453
+ # to retrieve the subsequent page.
1454
+ #
1455
+ # When paginating, all other parameters provided to `ListAudiences` must
1456
+ # match the call that provided the page token.
1457
+ class ListAudiencesRequest
1458
+ include ::Google::Protobuf::MessageExts
1459
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1460
+ end
1461
+
1462
+ # Response message for ListAudiences RPC.
1463
+ # @!attribute [rw] audiences
1464
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::Audience>]
1465
+ # List of Audiences.
1466
+ # @!attribute [rw] next_page_token
1467
+ # @return [::String]
1468
+ # A token, which can be sent as `page_token` to retrieve the next page.
1469
+ # If this field is omitted, there are no subsequent pages.
1470
+ class ListAudiencesResponse
1471
+ include ::Google::Protobuf::MessageExts
1472
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1473
+ end
1474
+
1475
+ # Request message for CreateAudience RPC.
1476
+ # @!attribute [rw] parent
1477
+ # @return [::String]
1478
+ # Required. Example format: properties/1234
1479
+ # @!attribute [rw] audience
1480
+ # @return [::Google::Analytics::Admin::V1alpha::Audience]
1481
+ # Required. The audience to create.
1482
+ class CreateAudienceRequest
1483
+ include ::Google::Protobuf::MessageExts
1484
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1485
+ end
1486
+
1487
+ # Request message for UpdateAudience RPC.
1488
+ # @!attribute [rw] audience
1489
+ # @return [::Google::Analytics::Admin::V1alpha::Audience]
1490
+ # Required. The audience to update.
1491
+ # The audience's `name` field is used to identify the audience to be updated.
1492
+ # @!attribute [rw] update_mask
1493
+ # @return [::Google::Protobuf::FieldMask]
1494
+ # Required. The list of fields to be updated. Field names must be in snake case
1495
+ # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
1496
+ # the entire entity, use one path with the string "*" to match all fields.
1497
+ class UpdateAudienceRequest
1498
+ include ::Google::Protobuf::MessageExts
1499
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1500
+ end
1501
+
1502
+ # Request message for ArchiveAudience RPC.
1503
+ # @!attribute [rw] name
1504
+ # @return [::String]
1505
+ # Required. Example format: properties/1234/audiences/5678
1506
+ class ArchiveAudienceRequest
1507
+ include ::Google::Protobuf::MessageExts
1508
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1509
+ end
1510
+
1511
+ # Request message for GetAttributionSettings RPC.
1512
+ # @!attribute [rw] name
1513
+ # @return [::String]
1514
+ # Required. The name of the attribution settings to retrieve.
1515
+ # Format: properties/\\{property}/attributionSettings
1516
+ class GetAttributionSettingsRequest
1517
+ include ::Google::Protobuf::MessageExts
1518
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1519
+ end
1520
+
1521
+ # Request message for UpdateAttributionSettings RPC
1522
+ # @!attribute [rw] attribution_settings
1523
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
1524
+ # Required. The attribution settings to update.
1525
+ # The `name` field is used to identify the settings to be updated.
1526
+ # @!attribute [rw] update_mask
1527
+ # @return [::Google::Protobuf::FieldMask]
1528
+ # Required. The list of fields to be updated. Field names must be in snake case
1529
+ # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
1530
+ # the entire entity, use one path with the string "*" to match all fields.
1531
+ class UpdateAttributionSettingsRequest
1532
+ include ::Google::Protobuf::MessageExts
1533
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1534
+ end
1321
1535
  end
1322
1536
  end
1323
1537
  end