google-analytics-admin-v1alpha 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +1 -1
- data/lib/google/analytics/admin/v1alpha/access_report_pb.rb +1 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +150 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +2631 -352
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +90 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +60 -2
- data/lib/google/analytics/admin/v1alpha/audience_pb.rb +0 -3
- data/lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb +69 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +35 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/lib/google/analytics/admin/v1alpha.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/access_report.rb +8 -2
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +503 -57
- data/proto_docs/google/analytics/admin/v1alpha/audience.rb +32 -39
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +156 -0
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +197 -63
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- metadata +11 -7
@@ -44,7 +44,7 @@ module Google
|
|
44
44
|
# to 2 date ranges.
|
45
45
|
# @!attribute [rw] dimension_filter
|
46
46
|
# @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression]
|
47
|
-
# Dimension filters
|
47
|
+
# Dimension filters let you restrict report response to specific
|
48
48
|
# dimension values which match the filter. For example, filtering on access
|
49
49
|
# records of a single user. To learn more, see [Fundamentals of Dimension
|
50
50
|
# Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
|
@@ -195,9 +195,10 @@ module Google
|
|
195
195
|
# The account's `name` field is used to identify the account.
|
196
196
|
# @!attribute [rw] update_mask
|
197
197
|
# @return [::Google::Protobuf::FieldMask]
|
198
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
199
|
-
# (
|
200
|
-
# the entire entity, use one path with the string "*" to match all
|
198
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
199
|
+
# case (for example, "field_to_update"). Omitted fields will not be updated.
|
200
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
201
|
+
# fields.
|
201
202
|
class UpdateAccountRequest
|
202
203
|
include ::Google::Protobuf::MessageExts
|
203
204
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -210,7 +211,7 @@ module Google
|
|
210
211
|
# @!attribute [rw] redirect_uri
|
211
212
|
# @return [::String]
|
212
213
|
# Redirect URI where the user will be sent after accepting Terms of Service.
|
213
|
-
# Must be configured in Developers Console as a Redirect URI
|
214
|
+
# Must be configured in Developers Console as a Redirect URI.
|
214
215
|
class ProvisionAccountTicketRequest
|
215
216
|
include ::Google::Protobuf::MessageExts
|
216
217
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -298,9 +299,10 @@ module Google
|
|
298
299
|
# updated.
|
299
300
|
# @!attribute [rw] update_mask
|
300
301
|
# @return [::Google::Protobuf::FieldMask]
|
301
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
302
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
303
|
-
# the entire entity, use one path with the string "*" to match all
|
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.
|
304
306
|
class UpdatePropertyRequest
|
305
307
|
include ::Google::Protobuf::MessageExts
|
306
308
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -444,8 +446,8 @@ module Google
|
|
444
446
|
# Required. Example format: accounts/1234
|
445
447
|
# @!attribute [rw] notify_new_user
|
446
448
|
# @return [::Boolean]
|
447
|
-
# Optional. If set, then email the new user notifying them that they've been
|
448
|
-
# 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.
|
449
451
|
# @!attribute [rw] user_link
|
450
452
|
# @return [::Google::Analytics::Admin::V1alpha::UserLink]
|
451
453
|
# Required. The user link to create.
|
@@ -457,15 +459,15 @@ module Google
|
|
457
459
|
# Request message for BatchCreateUserLinks RPC.
|
458
460
|
# @!attribute [rw] parent
|
459
461
|
# @return [::String]
|
460
|
-
# Required. The account or property that all user links in the request are
|
461
|
-
# 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
|
462
464
|
# messages must either be empty or match this field.
|
463
465
|
# Example format: accounts/1234
|
464
466
|
# @!attribute [rw] notify_new_users
|
465
467
|
# @return [::Boolean]
|
466
|
-
# Optional. If set, then email the new users notifying them that they've been
|
467
|
-
# permissions to the resource. Regardless of whether this is set or
|
468
|
-
# 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.
|
469
471
|
# @!attribute [rw] requests
|
470
472
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest>]
|
471
473
|
# Required. The requests specifying the user links to create.
|
@@ -581,7 +583,7 @@ module Google
|
|
581
583
|
# @return [::String]
|
582
584
|
# A page token, received from a previous `ListFirebaseLinks` call.
|
583
585
|
# Provide this to retrieve the subsequent page.
|
584
|
-
# When paginating, all other parameters provided to `
|
586
|
+
# When paginating, all other parameters provided to `ListFirebaseLinks` must
|
585
587
|
# match the call that provided the page token.
|
586
588
|
class ListFirebaseLinksRequest
|
587
589
|
include ::Google::Protobuf::MessageExts
|
@@ -633,9 +635,10 @@ module Google
|
|
633
635
|
# The GoogleAdsLink to update
|
634
636
|
# @!attribute [rw] update_mask
|
635
637
|
# @return [::Google::Protobuf::FieldMask]
|
636
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
637
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
638
|
-
# the entire entity, use one path with the string "*" to match all
|
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.
|
639
642
|
class UpdateGoogleAdsLinkRequest
|
640
643
|
include ::Google::Protobuf::MessageExts
|
641
644
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -732,8 +735,8 @@ module Google
|
|
732
735
|
# Required. The property for which to acknowledge user data collection.
|
733
736
|
# @!attribute [rw] acknowledgement
|
734
737
|
# @return [::String]
|
735
|
-
# Required. An acknowledgement that the caller of this method understands the
|
736
|
-
# of user data collection.
|
738
|
+
# Required. An acknowledgement that the caller of this method understands the
|
739
|
+
# terms of user data collection.
|
737
740
|
#
|
738
741
|
# This field must contain the exact value:
|
739
742
|
# "I acknowledge that I have the necessary privacy disclosures and rights
|
@@ -754,22 +757,24 @@ module Google
|
|
754
757
|
# Request message for SearchChangeHistoryEvents RPC.
|
755
758
|
# @!attribute [rw] account
|
756
759
|
# @return [::String]
|
757
|
-
# Required. The account resource for which to return change history
|
760
|
+
# Required. The account resource for which to return change history
|
761
|
+
# resources.
|
758
762
|
# @!attribute [rw] property
|
759
763
|
# @return [::String]
|
760
764
|
# Optional. Resource name for a child property. If set, only return changes
|
761
765
|
# made to this property or its child resources.
|
762
766
|
# @!attribute [rw] resource_type
|
763
767
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
|
764
|
-
# Optional. If set, only return changes if they are for a resource that
|
765
|
-
# 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.
|
766
770
|
# @!attribute [rw] action
|
767
771
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
|
768
|
-
# Optional. If set, only return changes that match one or more of these types
|
769
|
-
# actions.
|
772
|
+
# Optional. If set, only return changes that match one or more of these types
|
773
|
+
# of actions.
|
770
774
|
# @!attribute [rw] actor_email
|
771
775
|
# @return [::Array<::String>]
|
772
|
-
# Optional. If set, only return changes if they are made by a user in this
|
776
|
+
# Optional. If set, only return changes if they are made by a user in this
|
777
|
+
# list.
|
773
778
|
# @!attribute [rw] earliest_change_time
|
774
779
|
# @return [::Google::Protobuf::Timestamp]
|
775
780
|
# Optional. If set, only return changes made after this time (inclusive).
|
@@ -784,10 +789,11 @@ module Google
|
|
784
789
|
# The maximum value is 200 (higher values will be coerced to the maximum).
|
785
790
|
# @!attribute [rw] page_token
|
786
791
|
# @return [::String]
|
787
|
-
# Optional. A page token, received from a previous
|
788
|
-
# Provide this to retrieve the subsequent
|
789
|
-
#
|
790
|
-
# provided the page
|
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.
|
791
797
|
class SearchChangeHistoryEventsRequest
|
792
798
|
include ::Google::Protobuf::MessageExts
|
793
799
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -905,9 +911,10 @@ module Google
|
|
905
911
|
# The `name` field is used to identify the settings to be updated.
|
906
912
|
# @!attribute [rw] update_mask
|
907
913
|
# @return [::Google::Protobuf::FieldMask]
|
908
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
909
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
910
|
-
# the entire entity, use one path with the string "*" to match all
|
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.
|
911
918
|
class UpdateGoogleSignalsSettingsRequest
|
912
919
|
include ::Google::Protobuf::MessageExts
|
913
920
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -919,8 +926,8 @@ module Google
|
|
919
926
|
# Required. The conversion event to create.
|
920
927
|
# @!attribute [rw] parent
|
921
928
|
# @return [::String]
|
922
|
-
# Required. The resource name of the parent property where this conversion
|
923
|
-
# 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
|
924
931
|
class CreateConversionEventRequest
|
925
932
|
include ::Google::Protobuf::MessageExts
|
926
933
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1055,9 +1062,9 @@ module Google
|
|
1055
1062
|
# The DisplayVideo360AdvertiserLink to update
|
1056
1063
|
# @!attribute [rw] update_mask
|
1057
1064
|
# @return [::Google::Protobuf::FieldMask]
|
1058
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
1059
|
-
# To replace the entire entity, use one path with the string "*" to
|
1060
|
-
# 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.
|
1061
1068
|
class UpdateDisplayVideo360AdvertiserLinkRequest
|
1062
1069
|
include ::Google::Protobuf::MessageExts
|
1063
1070
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1161,6 +1168,87 @@ module Google
|
|
1161
1168
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1162
1169
|
end
|
1163
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
|
+
|
1164
1252
|
# Request message for CreateCustomDimension RPC.
|
1165
1253
|
# @!attribute [rw] parent
|
1166
1254
|
# @return [::String]
|
@@ -1179,9 +1267,9 @@ module Google
|
|
1179
1267
|
# The CustomDimension to update
|
1180
1268
|
# @!attribute [rw] update_mask
|
1181
1269
|
# @return [::Google::Protobuf::FieldMask]
|
1182
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
1183
|
-
# To replace the entire entity, use one path with the string "*" to
|
1184
|
-
# 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.
|
1185
1273
|
class UpdateCustomDimensionRequest
|
1186
1274
|
include ::Google::Protobuf::MessageExts
|
1187
1275
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1259,9 +1347,9 @@ module Google
|
|
1259
1347
|
# The CustomMetric to update
|
1260
1348
|
# @!attribute [rw] update_mask
|
1261
1349
|
# @return [::Google::Protobuf::FieldMask]
|
1262
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
1263
|
-
# To replace the entire entity, use one path with the string "*" to
|
1264
|
-
# 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.
|
1265
1353
|
class UpdateCustomMetricRequest
|
1266
1354
|
include ::Google::Protobuf::MessageExts
|
1267
1355
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1340,9 +1428,10 @@ module Google
|
|
1340
1428
|
# The `name` field is used to identify the settings to be updated.
|
1341
1429
|
# @!attribute [rw] update_mask
|
1342
1430
|
# @return [::Google::Protobuf::FieldMask]
|
1343
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
1344
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
1345
|
-
# the entire entity, use one path with the string "*" to match all
|
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.
|
1346
1435
|
class UpdateDataRetentionSettingsRequest
|
1347
1436
|
include ::Google::Protobuf::MessageExts
|
1348
1437
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1376,9 +1465,9 @@ module Google
|
|
1376
1465
|
# The DataStream to update
|
1377
1466
|
# @!attribute [rw] update_mask
|
1378
1467
|
# @return [::Google::Protobuf::FieldMask]
|
1379
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
1380
|
-
# To replace the entire entity, use one path with the string "*" to
|
1381
|
-
# 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.
|
1382
1471
|
class UpdateDataStreamRequest
|
1383
1472
|
include ::Google::Protobuf::MessageExts
|
1384
1473
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1491,9 +1580,10 @@ module Google
|
|
1491
1580
|
# The audience's `name` field is used to identify the audience to be updated.
|
1492
1581
|
# @!attribute [rw] update_mask
|
1493
1582
|
# @return [::Google::Protobuf::FieldMask]
|
1494
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
1495
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
1496
|
-
# the entire entity, use one path with the string "*" to match all
|
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.
|
1497
1587
|
class UpdateAudienceRequest
|
1498
1588
|
include ::Google::Protobuf::MessageExts
|
1499
1589
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1525,13 +1615,369 @@ module Google
|
|
1525
1615
|
# The `name` field is used to identify the settings to be updated.
|
1526
1616
|
# @!attribute [rw] update_mask
|
1527
1617
|
# @return [::Google::Protobuf::FieldMask]
|
1528
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
1529
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
1530
|
-
# the entire entity, use one path with the string "*" to match all
|
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.
|
1531
1622
|
class UpdateAttributionSettingsRequest
|
1532
1623
|
include ::Google::Protobuf::MessageExts
|
1533
1624
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1534
1625
|
end
|
1626
|
+
|
1627
|
+
# Request message for GetAccessBinding RPC.
|
1628
|
+
# @!attribute [rw] name
|
1629
|
+
# @return [::String]
|
1630
|
+
# Required. The name of the access binding to retrieve.
|
1631
|
+
# Formats:
|
1632
|
+
# - accounts/\\{account}/accessBindings/\\{accessBinding}
|
1633
|
+
# - properties/\\{property}/accessBindings/\\{accessBinding}
|
1634
|
+
class GetAccessBindingRequest
|
1635
|
+
include ::Google::Protobuf::MessageExts
|
1636
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# Request message for BatchGetAccessBindings RPC.
|
1640
|
+
# @!attribute [rw] parent
|
1641
|
+
# @return [::String]
|
1642
|
+
# Required. The account or property that owns the access bindings. The parent
|
1643
|
+
# of all provided values for the 'names' field must match this field.
|
1644
|
+
# Formats:
|
1645
|
+
# - accounts/\\{account}
|
1646
|
+
# - properties/\\{property}
|
1647
|
+
# @!attribute [rw] names
|
1648
|
+
# @return [::Array<::String>]
|
1649
|
+
# Required. The names of the access bindings to retrieve.
|
1650
|
+
# A maximum of 1000 access bindings can be retrieved in a batch.
|
1651
|
+
# Formats:
|
1652
|
+
# - accounts/\\{account}/accessBindings/\\{accessBinding}
|
1653
|
+
# - properties/\\{property}/accessBindings/\\{accessBinding}
|
1654
|
+
class BatchGetAccessBindingsRequest
|
1655
|
+
include ::Google::Protobuf::MessageExts
|
1656
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1657
|
+
end
|
1658
|
+
|
1659
|
+
# Response message for BatchGetAccessBindings RPC.
|
1660
|
+
# @!attribute [rw] access_bindings
|
1661
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::AccessBinding>]
|
1662
|
+
# The requested access bindings.
|
1663
|
+
class BatchGetAccessBindingsResponse
|
1664
|
+
include ::Google::Protobuf::MessageExts
|
1665
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1666
|
+
end
|
1667
|
+
|
1668
|
+
# Request message for ListAccessBindings RPC.
|
1669
|
+
# @!attribute [rw] parent
|
1670
|
+
# @return [::String]
|
1671
|
+
# Required. Formats:
|
1672
|
+
# - accounts/\\{account}
|
1673
|
+
# - properties/\\{property}
|
1674
|
+
# @!attribute [rw] page_size
|
1675
|
+
# @return [::Integer]
|
1676
|
+
# The maximum number of access bindings to return.
|
1677
|
+
# The service may return fewer than this value.
|
1678
|
+
# If unspecified, at most 200 access bindings will be returned.
|
1679
|
+
# The maximum value is 500; values above 500 will be coerced to 500.
|
1680
|
+
# @!attribute [rw] page_token
|
1681
|
+
# @return [::String]
|
1682
|
+
# A page token, received from a previous `ListAccessBindings` call.
|
1683
|
+
# Provide this to retrieve the subsequent page.
|
1684
|
+
# When paginating, all other parameters provided to `ListAccessBindings` must
|
1685
|
+
# match the call that provided the page token.
|
1686
|
+
class ListAccessBindingsRequest
|
1687
|
+
include ::Google::Protobuf::MessageExts
|
1688
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1689
|
+
end
|
1690
|
+
|
1691
|
+
# Response message for ListAccessBindings RPC.
|
1692
|
+
# @!attribute [rw] access_bindings
|
1693
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::AccessBinding>]
|
1694
|
+
# List of AccessBindings. These will be ordered stably, but in an arbitrary
|
1695
|
+
# order.
|
1696
|
+
# @!attribute [rw] next_page_token
|
1697
|
+
# @return [::String]
|
1698
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1699
|
+
# If this field is omitted, there are no subsequent pages.
|
1700
|
+
class ListAccessBindingsResponse
|
1701
|
+
include ::Google::Protobuf::MessageExts
|
1702
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1703
|
+
end
|
1704
|
+
|
1705
|
+
# Request message for CreateAccessBinding RPC.
|
1706
|
+
# @!attribute [rw] parent
|
1707
|
+
# @return [::String]
|
1708
|
+
# Required. Formats:
|
1709
|
+
# - accounts/\\{account}
|
1710
|
+
# - properties/\\{property}
|
1711
|
+
# @!attribute [rw] access_binding
|
1712
|
+
# @return [::Google::Analytics::Admin::V1alpha::AccessBinding]
|
1713
|
+
# Required. The access binding to create.
|
1714
|
+
class CreateAccessBindingRequest
|
1715
|
+
include ::Google::Protobuf::MessageExts
|
1716
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1717
|
+
end
|
1718
|
+
|
1719
|
+
# Request message for BatchCreateAccessBindings RPC.
|
1720
|
+
# @!attribute [rw] parent
|
1721
|
+
# @return [::String]
|
1722
|
+
# Required. The account or property that owns the access bindings. The parent
|
1723
|
+
# field in the CreateAccessBindingRequest messages must either be empty or
|
1724
|
+
# match this field. Formats:
|
1725
|
+
# - accounts/\\{account}
|
1726
|
+
# - properties/\\{property}
|
1727
|
+
# @!attribute [rw] requests
|
1728
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest>]
|
1729
|
+
# Required. The requests specifying the access bindings to create.
|
1730
|
+
# A maximum of 1000 access bindings can be created in a batch.
|
1731
|
+
class BatchCreateAccessBindingsRequest
|
1732
|
+
include ::Google::Protobuf::MessageExts
|
1733
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1734
|
+
end
|
1735
|
+
|
1736
|
+
# Response message for BatchCreateAccessBindings RPC.
|
1737
|
+
# @!attribute [rw] access_bindings
|
1738
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::AccessBinding>]
|
1739
|
+
# The access bindings created.
|
1740
|
+
class BatchCreateAccessBindingsResponse
|
1741
|
+
include ::Google::Protobuf::MessageExts
|
1742
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1743
|
+
end
|
1744
|
+
|
1745
|
+
# Request message for UpdateAccessBinding RPC.
|
1746
|
+
# @!attribute [rw] access_binding
|
1747
|
+
# @return [::Google::Analytics::Admin::V1alpha::AccessBinding]
|
1748
|
+
# Required. The access binding to update.
|
1749
|
+
class UpdateAccessBindingRequest
|
1750
|
+
include ::Google::Protobuf::MessageExts
|
1751
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1752
|
+
end
|
1753
|
+
|
1754
|
+
# Request message for BatchUpdateAccessBindings RPC.
|
1755
|
+
# @!attribute [rw] parent
|
1756
|
+
# @return [::String]
|
1757
|
+
# Required. The account or property that owns the access bindings. The parent
|
1758
|
+
# field in the UpdateAccessBindingRequest messages must either be empty or
|
1759
|
+
# match this field. Formats:
|
1760
|
+
# - accounts/\\{account}
|
1761
|
+
# - properties/\\{property}
|
1762
|
+
# @!attribute [rw] requests
|
1763
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest>]
|
1764
|
+
# Required. The requests specifying the access bindings to update.
|
1765
|
+
# A maximum of 1000 access bindings can be updated in a batch.
|
1766
|
+
class BatchUpdateAccessBindingsRequest
|
1767
|
+
include ::Google::Protobuf::MessageExts
|
1768
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1769
|
+
end
|
1770
|
+
|
1771
|
+
# Response message for BatchUpdateAccessBindings RPC.
|
1772
|
+
# @!attribute [rw] access_bindings
|
1773
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::AccessBinding>]
|
1774
|
+
# The access bindings updated.
|
1775
|
+
class BatchUpdateAccessBindingsResponse
|
1776
|
+
include ::Google::Protobuf::MessageExts
|
1777
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1778
|
+
end
|
1779
|
+
|
1780
|
+
# Request message for DeleteAccessBinding RPC.
|
1781
|
+
# @!attribute [rw] name
|
1782
|
+
# @return [::String]
|
1783
|
+
# Required. Formats:
|
1784
|
+
# - accounts/\\{account}/accessBindings/\\{accessBinding}
|
1785
|
+
# - properties/\\{property}/accessBindings/\\{accessBinding}
|
1786
|
+
class DeleteAccessBindingRequest
|
1787
|
+
include ::Google::Protobuf::MessageExts
|
1788
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1789
|
+
end
|
1790
|
+
|
1791
|
+
# Request message for BatchDeleteAccessBindings RPC.
|
1792
|
+
# @!attribute [rw] parent
|
1793
|
+
# @return [::String]
|
1794
|
+
# Required. The account or property that owns the access bindings. The parent
|
1795
|
+
# field in the DeleteAccessBindingRequest messages must either be empty or
|
1796
|
+
# match this field. Formats:
|
1797
|
+
# - accounts/\\{account}
|
1798
|
+
# - properties/\\{property}
|
1799
|
+
# @!attribute [rw] requests
|
1800
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest>]
|
1801
|
+
# Required. The requests specifying the access bindings to delete.
|
1802
|
+
# A maximum of 1000 access bindings can be deleted in a batch.
|
1803
|
+
class BatchDeleteAccessBindingsRequest
|
1804
|
+
include ::Google::Protobuf::MessageExts
|
1805
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1806
|
+
end
|
1807
|
+
|
1808
|
+
# Request message for CreateExpandedDataSet RPC.
|
1809
|
+
# @!attribute [rw] parent
|
1810
|
+
# @return [::String]
|
1811
|
+
# Required. Example format: properties/1234
|
1812
|
+
# @!attribute [rw] expanded_data_set
|
1813
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
|
1814
|
+
# Required. The ExpandedDataSet to create.
|
1815
|
+
class CreateExpandedDataSetRequest
|
1816
|
+
include ::Google::Protobuf::MessageExts
|
1817
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1818
|
+
end
|
1819
|
+
|
1820
|
+
# Request message for UpdateExpandedDataSet RPC.
|
1821
|
+
# @!attribute [rw] expanded_data_set
|
1822
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
|
1823
|
+
# Required. The ExpandedDataSet to update.
|
1824
|
+
# The resource's `name` field is used to identify the ExpandedDataSet to be
|
1825
|
+
# updated.
|
1826
|
+
# @!attribute [rw] update_mask
|
1827
|
+
# @return [::Google::Protobuf::FieldMask]
|
1828
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
1829
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
1830
|
+
# replace the entire entity, use one path with the string "*" to match all
|
1831
|
+
# fields.
|
1832
|
+
class UpdateExpandedDataSetRequest
|
1833
|
+
include ::Google::Protobuf::MessageExts
|
1834
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1835
|
+
end
|
1836
|
+
|
1837
|
+
# Request message for DeleteExpandedDataSet RPC.
|
1838
|
+
# @!attribute [rw] name
|
1839
|
+
# @return [::String]
|
1840
|
+
# Required. Example format: properties/1234/expandedDataSets/5678
|
1841
|
+
class DeleteExpandedDataSetRequest
|
1842
|
+
include ::Google::Protobuf::MessageExts
|
1843
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1844
|
+
end
|
1845
|
+
|
1846
|
+
# Request message for GetExpandedDataSet RPC.
|
1847
|
+
# @!attribute [rw] name
|
1848
|
+
# @return [::String]
|
1849
|
+
# Required. The name of the Audience to get.
|
1850
|
+
# Example format: properties/1234/expandedDataSets/5678
|
1851
|
+
class GetExpandedDataSetRequest
|
1852
|
+
include ::Google::Protobuf::MessageExts
|
1853
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1854
|
+
end
|
1855
|
+
|
1856
|
+
# Request message for ListExpandedDataSets RPC.
|
1857
|
+
# @!attribute [rw] parent
|
1858
|
+
# @return [::String]
|
1859
|
+
# Required. Example format: properties/1234
|
1860
|
+
# @!attribute [rw] page_size
|
1861
|
+
# @return [::Integer]
|
1862
|
+
# The maximum number of resources to return.
|
1863
|
+
# If unspecified, at most 50 resources will be returned.
|
1864
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
1865
|
+
# @!attribute [rw] page_token
|
1866
|
+
# @return [::String]
|
1867
|
+
# A page token, received from a previous `ListExpandedDataSets` call. Provide
|
1868
|
+
# this to retrieve the subsequent page.
|
1869
|
+
#
|
1870
|
+
# When paginating, all other parameters provided to `ListExpandedDataSet`
|
1871
|
+
# must match the call that provided the page token.
|
1872
|
+
class ListExpandedDataSetsRequest
|
1873
|
+
include ::Google::Protobuf::MessageExts
|
1874
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1875
|
+
end
|
1876
|
+
|
1877
|
+
# Response message for ListExpandedDataSets RPC.
|
1878
|
+
# @!attribute [rw] expanded_data_sets
|
1879
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>]
|
1880
|
+
# List of ExpandedDataSet. These will be ordered stably, but in an arbitrary
|
1881
|
+
# order.
|
1882
|
+
# @!attribute [rw] next_page_token
|
1883
|
+
# @return [::String]
|
1884
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1885
|
+
# If this field is omitted, there are no subsequent pages.
|
1886
|
+
class ListExpandedDataSetsResponse
|
1887
|
+
include ::Google::Protobuf::MessageExts
|
1888
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1889
|
+
end
|
1890
|
+
|
1891
|
+
# Request for setting the opt out status for the automated GA4 setup process.
|
1892
|
+
# @!attribute [rw] property
|
1893
|
+
# @return [::String]
|
1894
|
+
# Required. The UA property to set the opt out status. Note this request uses
|
1895
|
+
# the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
1896
|
+
# Format: properties/\\{internalWebPropertyId}
|
1897
|
+
# Example: properties/1234
|
1898
|
+
# @!attribute [rw] opt_out
|
1899
|
+
# @return [::Boolean]
|
1900
|
+
# The status to set.
|
1901
|
+
class SetAutomatedGa4ConfigurationOptOutRequest
|
1902
|
+
include ::Google::Protobuf::MessageExts
|
1903
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1904
|
+
end
|
1905
|
+
|
1906
|
+
# Response message for setting the opt out status for the automated GA4 setup
|
1907
|
+
# process.
|
1908
|
+
class SetAutomatedGa4ConfigurationOptOutResponse
|
1909
|
+
include ::Google::Protobuf::MessageExts
|
1910
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1911
|
+
end
|
1912
|
+
|
1913
|
+
# Request for fetching the opt out status for the automated GA4 setup process.
|
1914
|
+
# @!attribute [rw] property
|
1915
|
+
# @return [::String]
|
1916
|
+
# Required. The UA property to get the opt out status. Note this request uses
|
1917
|
+
# the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
1918
|
+
# Format: properties/\\{internalWebPropertyId}
|
1919
|
+
# Example: properties/1234
|
1920
|
+
class FetchAutomatedGa4ConfigurationOptOutRequest
|
1921
|
+
include ::Google::Protobuf::MessageExts
|
1922
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1923
|
+
end
|
1924
|
+
|
1925
|
+
# Response message for fetching the opt out status for the automated GA4 setup
|
1926
|
+
# process.
|
1927
|
+
# @!attribute [rw] opt_out
|
1928
|
+
# @return [::Boolean]
|
1929
|
+
# The opt out status for the UA property.
|
1930
|
+
class FetchAutomatedGa4ConfigurationOptOutResponse
|
1931
|
+
include ::Google::Protobuf::MessageExts
|
1932
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1933
|
+
end
|
1934
|
+
|
1935
|
+
# Request message for GetBigQueryLink RPC.
|
1936
|
+
# @!attribute [rw] name
|
1937
|
+
# @return [::String]
|
1938
|
+
# Required. The name of the BigQuery link to lookup.
|
1939
|
+
# Format: properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id}
|
1940
|
+
# Example: properties/123/bigQueryLinks/456
|
1941
|
+
class GetBigQueryLinkRequest
|
1942
|
+
include ::Google::Protobuf::MessageExts
|
1943
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1944
|
+
end
|
1945
|
+
|
1946
|
+
# Request message for ListBigQueryLinks RPC.
|
1947
|
+
# @!attribute [rw] parent
|
1948
|
+
# @return [::String]
|
1949
|
+
# Required. The name of the property to list BigQuery links under.
|
1950
|
+
# Format: properties/\\{property_id}
|
1951
|
+
# Example: properties/1234
|
1952
|
+
# @!attribute [rw] page_size
|
1953
|
+
# @return [::Integer]
|
1954
|
+
# The maximum number of resources to return. The service may return
|
1955
|
+
# fewer than this value, even if there are additional pages.
|
1956
|
+
# If unspecified, at most 50 resources will be returned.
|
1957
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
1958
|
+
# @!attribute [rw] page_token
|
1959
|
+
# @return [::String]
|
1960
|
+
# A page token, received from a previous `ListBigQueryLinks` call.
|
1961
|
+
# Provide this to retrieve the subsequent page.
|
1962
|
+
# When paginating, all other parameters provided to `ListBigQueryLinks` must
|
1963
|
+
# match the call that provided the page token.
|
1964
|
+
class ListBigQueryLinksRequest
|
1965
|
+
include ::Google::Protobuf::MessageExts
|
1966
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1967
|
+
end
|
1968
|
+
|
1969
|
+
# Response message for ListBigQueryLinks RPC
|
1970
|
+
# @!attribute [rw] bigquery_links
|
1971
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
|
1972
|
+
# List of BigQueryLinks.
|
1973
|
+
# @!attribute [rw] next_page_token
|
1974
|
+
# @return [::String]
|
1975
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1976
|
+
# If this field is omitted, there are no subsequent pages.
|
1977
|
+
class ListBigQueryLinksResponse
|
1978
|
+
include ::Google::Protobuf::MessageExts
|
1979
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1980
|
+
end
|
1535
1981
|
end
|
1536
1982
|
end
|
1537
1983
|
end
|