google-analytics-admin-v1alpha 0.12.0 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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]
@@ -86,9 +195,10 @@ module Google
86
195
  # The account's `name` field is used to identify the account.
87
196
  # @!attribute [rw] update_mask
88
197
  # @return [::Google::Protobuf::FieldMask]
89
- # Required. The list of fields to be updated. Field names must be in snake case
90
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
91
- # the entire entity, use one path with the string "*" to match all fields.
198
+ # Required. The list of fields to be updated. Field names must be in snake
199
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
200
+ # replace the entire entity, use one path with the string "*" to match all
201
+ # fields.
92
202
  class UpdateAccountRequest
93
203
  include ::Google::Protobuf::MessageExts
94
204
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -189,9 +299,10 @@ module Google
189
299
  # updated.
190
300
  # @!attribute [rw] update_mask
191
301
  # @return [::Google::Protobuf::FieldMask]
192
- # Required. The list of fields to be updated. Field names must be in snake case
193
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
194
- # the entire entity, use one path with the string "*" to match all fields.
302
+ # Required. The list of fields to be updated. Field names must be in snake
303
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
304
+ # replace the entire entity, use one path with the string "*" to match all
305
+ # fields.
195
306
  class UpdatePropertyRequest
196
307
  include ::Google::Protobuf::MessageExts
197
308
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -335,8 +446,8 @@ module Google
335
446
  # Required. Example format: accounts/1234
336
447
  # @!attribute [rw] notify_new_user
337
448
  # @return [::Boolean]
338
- # Optional. If set, then email the new user notifying them that they've been granted
339
- # permissions to the resource.
449
+ # Optional. If set, then email the new user notifying them that they've been
450
+ # granted permissions to the resource.
340
451
  # @!attribute [rw] user_link
341
452
  # @return [::Google::Analytics::Admin::V1alpha::UserLink]
342
453
  # Required. The user link to create.
@@ -348,15 +459,15 @@ module Google
348
459
  # Request message for BatchCreateUserLinks RPC.
349
460
  # @!attribute [rw] parent
350
461
  # @return [::String]
351
- # Required. The account or property that all user links in the request are for.
352
- # This field is required. The parent field in the CreateUserLinkRequest
462
+ # Required. The account or property that all user links in the request are
463
+ # for. This field is required. The parent field in the CreateUserLinkRequest
353
464
  # messages must either be empty or match this field.
354
465
  # Example format: accounts/1234
355
466
  # @!attribute [rw] notify_new_users
356
467
  # @return [::Boolean]
357
- # Optional. If set, then email the new users notifying them that they've been granted
358
- # permissions to the resource. Regardless of whether this is set or not,
359
- # notify_new_user field inside each individual request is ignored.
468
+ # Optional. If set, then email the new users notifying them that they've been
469
+ # granted permissions to the resource. Regardless of whether this is set or
470
+ # not, notify_new_user field inside each individual request is ignored.
360
471
  # @!attribute [rw] requests
361
472
  # @return [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest>]
362
473
  # Required. The requests specifying the user links to create.
@@ -472,7 +583,7 @@ module Google
472
583
  # @return [::String]
473
584
  # A page token, received from a previous `ListFirebaseLinks` call.
474
585
  # Provide this to retrieve the subsequent page.
475
- # When paginating, all other parameters provided to `ListProperties` must
586
+ # When paginating, all other parameters provided to `ListFirebaseLinks` must
476
587
  # match the call that provided the page token.
477
588
  class ListFirebaseLinksRequest
478
589
  include ::Google::Protobuf::MessageExts
@@ -524,9 +635,10 @@ module Google
524
635
  # The GoogleAdsLink to update
525
636
  # @!attribute [rw] update_mask
526
637
  # @return [::Google::Protobuf::FieldMask]
527
- # Required. The list of fields to be updated. Field names must be in snake case
528
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
529
- # the entire entity, use one path with the string "*" to match all fields.
638
+ # Required. The list of fields to be updated. Field names must be in snake
639
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
640
+ # replace the entire entity, use one path with the string "*" to match all
641
+ # fields.
530
642
  class UpdateGoogleAdsLinkRequest
531
643
  include ::Google::Protobuf::MessageExts
532
644
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -623,8 +735,8 @@ module Google
623
735
  # Required. The property for which to acknowledge user data collection.
624
736
  # @!attribute [rw] acknowledgement
625
737
  # @return [::String]
626
- # Required. An acknowledgement that the caller of this method understands the terms
627
- # of user data collection.
738
+ # Required. An acknowledgement that the caller of this method understands the
739
+ # terms of user data collection.
628
740
  #
629
741
  # This field must contain the exact value:
630
742
  # "I acknowledge that I have the necessary privacy disclosures and rights
@@ -645,22 +757,24 @@ module Google
645
757
  # Request message for SearchChangeHistoryEvents RPC.
646
758
  # @!attribute [rw] account
647
759
  # @return [::String]
648
- # Required. The account resource for which to return change history resources.
760
+ # Required. The account resource for which to return change history
761
+ # resources.
649
762
  # @!attribute [rw] property
650
763
  # @return [::String]
651
764
  # Optional. Resource name for a child property. If set, only return changes
652
765
  # made to this property or its child resources.
653
766
  # @!attribute [rw] resource_type
654
767
  # @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
655
- # Optional. If set, only return changes if they are for a resource that matches at
656
- # least one of these types.
768
+ # Optional. If set, only return changes if they are for a resource that
769
+ # matches at least one of these types.
657
770
  # @!attribute [rw] action
658
771
  # @return [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
659
- # Optional. If set, only return changes that match one or more of these types of
660
- # actions.
772
+ # Optional. If set, only return changes that match one or more of these types
773
+ # of actions.
661
774
  # @!attribute [rw] actor_email
662
775
  # @return [::Array<::String>]
663
- # Optional. If set, only return changes if they are made by a user in this list.
776
+ # Optional. If set, only return changes if they are made by a user in this
777
+ # list.
664
778
  # @!attribute [rw] earliest_change_time
665
779
  # @return [::Google::Protobuf::Timestamp]
666
780
  # Optional. If set, only return changes made after this time (inclusive).
@@ -675,10 +789,11 @@ module Google
675
789
  # The maximum value is 200 (higher values will be coerced to the maximum).
676
790
  # @!attribute [rw] page_token
677
791
  # @return [::String]
678
- # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
679
- # Provide this to retrieve the subsequent page. When paginating, all other
680
- # parameters provided to `SearchChangeHistoryEvents` must match the call that
681
- # provided the page token.
792
+ # Optional. A page token, received from a previous
793
+ # `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent
794
+ # page. When paginating, all other parameters provided to
795
+ # `SearchChangeHistoryEvents` must match the call that provided the page
796
+ # token.
682
797
  class SearchChangeHistoryEventsRequest
683
798
  include ::Google::Protobuf::MessageExts
684
799
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -796,9 +911,10 @@ module Google
796
911
  # The `name` field is used to identify the settings to be updated.
797
912
  # @!attribute [rw] update_mask
798
913
  # @return [::Google::Protobuf::FieldMask]
799
- # Required. The list of fields to be updated. Field names must be in snake case
800
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
801
- # the entire entity, use one path with the string "*" to match all fields.
914
+ # Required. The list of fields to be updated. Field names must be in snake
915
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
916
+ # replace the entire entity, use one path with the string "*" to match all
917
+ # fields.
802
918
  class UpdateGoogleSignalsSettingsRequest
803
919
  include ::Google::Protobuf::MessageExts
804
920
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -810,8 +926,8 @@ module Google
810
926
  # Required. The conversion event to create.
811
927
  # @!attribute [rw] parent
812
928
  # @return [::String]
813
- # Required. The resource name of the parent property where this conversion event will
814
- # be created. Format: properties/123
929
+ # Required. The resource name of the parent property where this conversion
930
+ # event will be created. Format: properties/123
815
931
  class CreateConversionEventRequest
816
932
  include ::Google::Protobuf::MessageExts
817
933
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -946,9 +1062,9 @@ module Google
946
1062
  # The DisplayVideo360AdvertiserLink to update
947
1063
  # @!attribute [rw] update_mask
948
1064
  # @return [::Google::Protobuf::FieldMask]
949
- # Required. The list of fields to be updated. Omitted fields will not be updated.
950
- # To replace the entire entity, use one path with the string "*" to match
951
- # all fields.
1065
+ # Required. The list of fields to be updated. Omitted fields will not be
1066
+ # updated. To replace the entire entity, use one path with the string "*" to
1067
+ # match all fields.
952
1068
  class UpdateDisplayVideo360AdvertiserLinkRequest
953
1069
  include ::Google::Protobuf::MessageExts
954
1070
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1052,6 +1168,87 @@ module Google
1052
1168
  extend ::Google::Protobuf::MessageExts::ClassMethods
1053
1169
  end
1054
1170
 
1171
+ # Request message for GetSearchAds360Link RPC.
1172
+ # @!attribute [rw] name
1173
+ # @return [::String]
1174
+ # Required. The name of the SearchAds360Link to get.
1175
+ # Example format: properties/1234/SearchAds360Link/5678
1176
+ class GetSearchAds360LinkRequest
1177
+ include ::Google::Protobuf::MessageExts
1178
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1179
+ end
1180
+
1181
+ # Request message for ListSearchAds360Links RPC.
1182
+ # @!attribute [rw] parent
1183
+ # @return [::String]
1184
+ # Required. Example format: properties/1234
1185
+ # @!attribute [rw] page_size
1186
+ # @return [::Integer]
1187
+ # The maximum number of resources to return.
1188
+ # If unspecified, at most 50 resources will be returned.
1189
+ # The maximum value is 200 (higher values will be coerced to the maximum).
1190
+ # @!attribute [rw] page_token
1191
+ # @return [::String]
1192
+ # A page token, received from a previous `ListSearchAds360Links`
1193
+ # call. Provide this to retrieve the subsequent page.
1194
+ #
1195
+ # When paginating, all other parameters provided to
1196
+ # `ListSearchAds360Links` must match the call that provided the
1197
+ # page token.
1198
+ class ListSearchAds360LinksRequest
1199
+ include ::Google::Protobuf::MessageExts
1200
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1201
+ end
1202
+
1203
+ # Response message for ListSearchAds360Links RPC.
1204
+ # @!attribute [rw] search_ads_360_links
1205
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::SearchAds360Link>]
1206
+ # List of SearchAds360Links.
1207
+ # @!attribute [rw] next_page_token
1208
+ # @return [::String]
1209
+ # A token, which can be sent as `page_token` to retrieve the next page.
1210
+ # If this field is omitted, there are no subsequent pages.
1211
+ class ListSearchAds360LinksResponse
1212
+ include ::Google::Protobuf::MessageExts
1213
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1214
+ end
1215
+
1216
+ # Request message for CreateSearchAds360Link RPC.
1217
+ # @!attribute [rw] parent
1218
+ # @return [::String]
1219
+ # Required. Example format: properties/1234
1220
+ # @!attribute [rw] search_ads_360_link
1221
+ # @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
1222
+ # Required. The SearchAds360Link to create.
1223
+ class CreateSearchAds360LinkRequest
1224
+ include ::Google::Protobuf::MessageExts
1225
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1226
+ end
1227
+
1228
+ # Request message for DeleteSearchAds360Link RPC.
1229
+ # @!attribute [rw] name
1230
+ # @return [::String]
1231
+ # Required. The name of the SearchAds360Link to delete.
1232
+ # Example format: properties/1234/SearchAds360Links/5678
1233
+ class DeleteSearchAds360LinkRequest
1234
+ include ::Google::Protobuf::MessageExts
1235
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1236
+ end
1237
+
1238
+ # Request message for UpdateSearchAds360Link RPC.
1239
+ # @!attribute [rw] search_ads_360_link
1240
+ # @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
1241
+ # The SearchAds360Link to update
1242
+ # @!attribute [rw] update_mask
1243
+ # @return [::Google::Protobuf::FieldMask]
1244
+ # Required. The list of fields to be updated. Omitted fields will not be
1245
+ # updated. To replace the entire entity, use one path with the string "*" to
1246
+ # match all fields.
1247
+ class UpdateSearchAds360LinkRequest
1248
+ include ::Google::Protobuf::MessageExts
1249
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1250
+ end
1251
+
1055
1252
  # Request message for CreateCustomDimension RPC.
1056
1253
  # @!attribute [rw] parent
1057
1254
  # @return [::String]
@@ -1070,9 +1267,9 @@ module Google
1070
1267
  # The CustomDimension to update
1071
1268
  # @!attribute [rw] update_mask
1072
1269
  # @return [::Google::Protobuf::FieldMask]
1073
- # Required. The list of fields to be updated. Omitted fields will not be updated.
1074
- # To replace the entire entity, use one path with the string "*" to match
1075
- # all fields.
1270
+ # Required. The list of fields to be updated. Omitted fields will not be
1271
+ # updated. To replace the entire entity, use one path with the string "*" to
1272
+ # match all fields.
1076
1273
  class UpdateCustomDimensionRequest
1077
1274
  include ::Google::Protobuf::MessageExts
1078
1275
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1150,9 +1347,9 @@ module Google
1150
1347
  # The CustomMetric to update
1151
1348
  # @!attribute [rw] update_mask
1152
1349
  # @return [::Google::Protobuf::FieldMask]
1153
- # Required. The list of fields to be updated. Omitted fields will not be updated.
1154
- # To replace the entire entity, use one path with the string "*" to match
1155
- # all fields.
1350
+ # Required. The list of fields to be updated. Omitted fields will not be
1351
+ # updated. To replace the entire entity, use one path with the string "*" to
1352
+ # match all fields.
1156
1353
  class UpdateCustomMetricRequest
1157
1354
  include ::Google::Protobuf::MessageExts
1158
1355
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1231,9 +1428,10 @@ module Google
1231
1428
  # The `name` field is used to identify the settings to be updated.
1232
1429
  # @!attribute [rw] update_mask
1233
1430
  # @return [::Google::Protobuf::FieldMask]
1234
- # Required. The list of fields to be updated. Field names must be in snake case
1235
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
1236
- # the entire entity, use one path with the string "*" to match all fields.
1431
+ # Required. The list of fields to be updated. Field names must be in snake
1432
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
1433
+ # replace the entire entity, use one path with the string "*" to match all
1434
+ # fields.
1237
1435
  class UpdateDataRetentionSettingsRequest
1238
1436
  include ::Google::Protobuf::MessageExts
1239
1437
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1267,9 +1465,9 @@ module Google
1267
1465
  # The DataStream to update
1268
1466
  # @!attribute [rw] update_mask
1269
1467
  # @return [::Google::Protobuf::FieldMask]
1270
- # Required. The list of fields to be updated. Omitted fields will not be updated.
1271
- # To replace the entire entity, use one path with the string "*" to match
1272
- # all fields.
1468
+ # Required. The list of fields to be updated. Omitted fields will not be
1469
+ # updated. To replace the entire entity, use one path with the string "*" to
1470
+ # match all fields.
1273
1471
  class UpdateDataStreamRequest
1274
1472
  include ::Google::Protobuf::MessageExts
1275
1473
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1318,6 +1516,204 @@ module Google
1318
1516
  include ::Google::Protobuf::MessageExts
1319
1517
  extend ::Google::Protobuf::MessageExts::ClassMethods
1320
1518
  end
1519
+
1520
+ # Request message for GetAudience RPC.
1521
+ # @!attribute [rw] name
1522
+ # @return [::String]
1523
+ # Required. The name of the Audience to get.
1524
+ # Example format: properties/1234/audiences/5678
1525
+ class GetAudienceRequest
1526
+ include ::Google::Protobuf::MessageExts
1527
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1528
+ end
1529
+
1530
+ # Request message for ListAudiences RPC.
1531
+ # @!attribute [rw] parent
1532
+ # @return [::String]
1533
+ # Required. Example format: properties/1234
1534
+ # @!attribute [rw] page_size
1535
+ # @return [::Integer]
1536
+ # The maximum number of resources to return.
1537
+ # If unspecified, at most 50 resources will be returned.
1538
+ # The maximum value is 200 (higher values will be coerced to the maximum).
1539
+ # @!attribute [rw] page_token
1540
+ # @return [::String]
1541
+ # A page token, received from a previous `ListAudiences` call. Provide this
1542
+ # to retrieve the subsequent page.
1543
+ #
1544
+ # When paginating, all other parameters provided to `ListAudiences` must
1545
+ # match the call that provided the page token.
1546
+ class ListAudiencesRequest
1547
+ include ::Google::Protobuf::MessageExts
1548
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1549
+ end
1550
+
1551
+ # Response message for ListAudiences RPC.
1552
+ # @!attribute [rw] audiences
1553
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::Audience>]
1554
+ # List of Audiences.
1555
+ # @!attribute [rw] next_page_token
1556
+ # @return [::String]
1557
+ # A token, which can be sent as `page_token` to retrieve the next page.
1558
+ # If this field is omitted, there are no subsequent pages.
1559
+ class ListAudiencesResponse
1560
+ include ::Google::Protobuf::MessageExts
1561
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1562
+ end
1563
+
1564
+ # Request message for CreateAudience RPC.
1565
+ # @!attribute [rw] parent
1566
+ # @return [::String]
1567
+ # Required. Example format: properties/1234
1568
+ # @!attribute [rw] audience
1569
+ # @return [::Google::Analytics::Admin::V1alpha::Audience]
1570
+ # Required. The audience to create.
1571
+ class CreateAudienceRequest
1572
+ include ::Google::Protobuf::MessageExts
1573
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1574
+ end
1575
+
1576
+ # Request message for UpdateAudience RPC.
1577
+ # @!attribute [rw] audience
1578
+ # @return [::Google::Analytics::Admin::V1alpha::Audience]
1579
+ # Required. The audience to update.
1580
+ # The audience's `name` field is used to identify the audience to be updated.
1581
+ # @!attribute [rw] update_mask
1582
+ # @return [::Google::Protobuf::FieldMask]
1583
+ # Required. The list of fields to be updated. Field names must be in snake
1584
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
1585
+ # replace the entire entity, use one path with the string "*" to match all
1586
+ # fields.
1587
+ class UpdateAudienceRequest
1588
+ include ::Google::Protobuf::MessageExts
1589
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1590
+ end
1591
+
1592
+ # Request message for ArchiveAudience RPC.
1593
+ # @!attribute [rw] name
1594
+ # @return [::String]
1595
+ # Required. Example format: properties/1234/audiences/5678
1596
+ class ArchiveAudienceRequest
1597
+ include ::Google::Protobuf::MessageExts
1598
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1599
+ end
1600
+
1601
+ # Request message for GetAttributionSettings RPC.
1602
+ # @!attribute [rw] name
1603
+ # @return [::String]
1604
+ # Required. The name of the attribution settings to retrieve.
1605
+ # Format: properties/\\{property}/attributionSettings
1606
+ class GetAttributionSettingsRequest
1607
+ include ::Google::Protobuf::MessageExts
1608
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1609
+ end
1610
+
1611
+ # Request message for UpdateAttributionSettings RPC
1612
+ # @!attribute [rw] attribution_settings
1613
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
1614
+ # Required. The attribution settings to update.
1615
+ # The `name` field is used to identify the settings to be updated.
1616
+ # @!attribute [rw] update_mask
1617
+ # @return [::Google::Protobuf::FieldMask]
1618
+ # Required. The list of fields to be updated. Field names must be in snake
1619
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
1620
+ # replace the entire entity, use one path with the string "*" to match all
1621
+ # fields.
1622
+ class UpdateAttributionSettingsRequest
1623
+ include ::Google::Protobuf::MessageExts
1624
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1625
+ end
1626
+
1627
+ # Request for setting the opt out status for the automated GA4 setup process.
1628
+ # @!attribute [rw] property
1629
+ # @return [::String]
1630
+ # Required. The UA property to set the opt out status. Note this request uses
1631
+ # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
1632
+ # Format: properties/\\{internalWebPropertyId}
1633
+ # Example: properties/1234
1634
+ # @!attribute [rw] opt_out
1635
+ # @return [::Boolean]
1636
+ # The status to set.
1637
+ class SetAutomatedGa4ConfigurationOptOutRequest
1638
+ include ::Google::Protobuf::MessageExts
1639
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1640
+ end
1641
+
1642
+ # Response message for setting the opt out status for the automated GA4 setup
1643
+ # process.
1644
+ class SetAutomatedGa4ConfigurationOptOutResponse
1645
+ include ::Google::Protobuf::MessageExts
1646
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1647
+ end
1648
+
1649
+ # Request for fetching the opt out status for the automated GA4 setup process.
1650
+ # @!attribute [rw] property
1651
+ # @return [::String]
1652
+ # Required. The UA property to get the opt out status. Note this request uses
1653
+ # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
1654
+ # Format: properties/\\{internalWebPropertyId}
1655
+ # Example: properties/1234
1656
+ class FetchAutomatedGa4ConfigurationOptOutRequest
1657
+ include ::Google::Protobuf::MessageExts
1658
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1659
+ end
1660
+
1661
+ # Response message for fetching the opt out status for the automated GA4 setup
1662
+ # process.
1663
+ # @!attribute [rw] opt_out
1664
+ # @return [::Boolean]
1665
+ # The opt out status for the UA property.
1666
+ class FetchAutomatedGa4ConfigurationOptOutResponse
1667
+ include ::Google::Protobuf::MessageExts
1668
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1669
+ end
1670
+
1671
+ # Request message for GetBigQueryLink RPC.
1672
+ # @!attribute [rw] name
1673
+ # @return [::String]
1674
+ # Required. The name of the BigQuery link to lookup.
1675
+ # Format: properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id}
1676
+ # Example: properties/123/bigQueryLinks/456
1677
+ class GetBigQueryLinkRequest
1678
+ include ::Google::Protobuf::MessageExts
1679
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1680
+ end
1681
+
1682
+ # Request message for ListBigQueryLinks RPC.
1683
+ # @!attribute [rw] parent
1684
+ # @return [::String]
1685
+ # Required. The name of the property to list BigQuery links under.
1686
+ # Format: properties/\\{property_id}
1687
+ # Example: properties/1234
1688
+ # @!attribute [rw] page_size
1689
+ # @return [::Integer]
1690
+ # The maximum number of resources to return. The service may return
1691
+ # fewer than this value, even if there are additional pages.
1692
+ # If unspecified, at most 50 resources will be returned.
1693
+ # The maximum value is 200; (higher values will be coerced to the maximum)
1694
+ # @!attribute [rw] page_token
1695
+ # @return [::String]
1696
+ # A page token, received from a previous `ListBigQueryLinks` call.
1697
+ # Provide this to retrieve the subsequent page.
1698
+ # When paginating, all other parameters provided to `ListBigQueryLinks` must
1699
+ # match the call that provided the page token.
1700
+ class ListBigQueryLinksRequest
1701
+ include ::Google::Protobuf::MessageExts
1702
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1703
+ end
1704
+
1705
+ # Response message for ListBigQueryLinks RPC
1706
+ # @!attribute [rw] bigquery_links
1707
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
1708
+ # List of BigQueryLinks.
1709
+ # @!attribute [rw] next_page_token
1710
+ # @return [::String]
1711
+ # A token, which can be sent as `page_token` to retrieve the next page.
1712
+ # If this field is omitted, there are no subsequent pages.
1713
+ class ListBigQueryLinksResponse
1714
+ include ::Google::Protobuf::MessageExts
1715
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1716
+ end
1321
1717
  end
1322
1718
  end
1323
1719
  end