google-analytics-admin-v1alpha 0.13.0 → 0.14.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 +60 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1186 -247
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +34 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +25 -1
- 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 +27 -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 +237 -55
- 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 +164 -63
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- metadata +9 -5
@@ -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
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
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 (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.
|
201
202
|
class UpdateAccountRequest
|
202
203
|
include ::Google::Protobuf::MessageExts
|
203
204
|
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,105 @@ 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 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
|
1535
1717
|
end
|
1536
1718
|
end
|
1537
1719
|
end
|
@@ -41,8 +41,8 @@ module Google
|
|
41
41
|
# Required. Immutable. The dimension name or metric name to filter.
|
42
42
|
# @!attribute [rw] at_any_point_in_time
|
43
43
|
# @return [::Boolean]
|
44
|
-
# Optional. Indicates whether this filter needs dynamic evaluation or not. If
|
45
|
-
# true, users join the Audience if they ever met the condition (static
|
44
|
+
# Optional. Indicates whether this filter needs dynamic evaluation or not. If
|
45
|
+
# set to true, users join the Audience if they ever met the condition (static
|
46
46
|
# evaluation). If unset or set to false, user evaluation for an Audience is
|
47
47
|
# dynamic; users are added to an Audience when they meet the conditions and
|
48
48
|
# then removed when they no longer meet them.
|
@@ -50,9 +50,9 @@ module Google
|
|
50
50
|
# This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
|
51
51
|
# @!attribute [rw] in_any_n_day_period
|
52
52
|
# @return [::Integer]
|
53
|
-
# Optional. If set, specifies the time window for which to evaluate data in
|
54
|
-
# days. If not set, then audience data is evaluated against
|
55
|
-
# (i.e., infinite time window).
|
53
|
+
# Optional. If set, specifies the time window for which to evaluate data in
|
54
|
+
# number of days. If not set, then audience data is evaluated against
|
55
|
+
# lifetime data (i.e., infinite time window).
|
56
56
|
#
|
57
57
|
# For example, if set to 1 day, only the current day's data is evaluated. The
|
58
58
|
# reference point is the current day when at_any_point_in_time is unset or
|
@@ -98,16 +98,14 @@ module Google
|
|
98
98
|
|
99
99
|
# Full regular expression matches with the string value.
|
100
100
|
FULL_REGEXP = 5
|
101
|
-
|
102
|
-
# Partial regular expression matches with the string value.
|
103
|
-
PARTIAL_REGEXP = 6
|
104
101
|
end
|
105
102
|
end
|
106
103
|
|
107
104
|
# A filter for a string dimension that matches a particular list of options.
|
108
105
|
# @!attribute [rw] values
|
109
106
|
# @return [::Array<::String>]
|
110
|
-
# Required. The list of possible string values to match against. Must be
|
107
|
+
# Required. The list of possible string values to match against. Must be
|
108
|
+
# non-empty.
|
111
109
|
# @!attribute [rw] case_sensitive
|
112
110
|
# @return [::Boolean]
|
113
111
|
# Optional. If true, the match is case-sensitive. If false, the match is
|
@@ -151,14 +149,8 @@ module Google
|
|
151
149
|
# Less than.
|
152
150
|
LESS_THAN = 2
|
153
151
|
|
154
|
-
# Less than or equal.
|
155
|
-
LESS_THAN_OR_EQUAL = 3
|
156
|
-
|
157
152
|
# Greater than.
|
158
153
|
GREATER_THAN = 4
|
159
|
-
|
160
|
-
# Greater than or equal.
|
161
|
-
GREATER_THAN_OR_EQUAL = 5
|
162
154
|
end
|
163
155
|
end
|
164
156
|
|
@@ -184,8 +176,8 @@ module Google
|
|
184
176
|
# Required. Immutable. The name of the event to match against.
|
185
177
|
# @!attribute [rw] event_parameter_filter_expression
|
186
178
|
# @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
|
187
|
-
# Optional. If specified, this filter matches events that match both the
|
188
|
-
# event name and the parameter filter expressions. AudienceEventFilter
|
179
|
+
# Optional. If specified, this filter matches events that match both the
|
180
|
+
# single event name and the parameter filter expressions. AudienceEventFilter
|
189
181
|
# inside the parameter filter expression cannot be set (i.e., nested
|
190
182
|
# event filters are not supported). This should be a single and_group of
|
191
183
|
# dimension_or_metric_filter or not_expression; ANDs of ORs are not
|
@@ -240,7 +232,8 @@ module Google
|
|
240
232
|
# Required. Immutable. Specifies the scope for this filter.
|
241
233
|
# @!attribute [rw] filter_expression
|
242
234
|
# @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
|
243
|
-
# Required. Immutable. A logical expression of Audience dimension, metric, or
|
235
|
+
# Required. Immutable. A logical expression of Audience dimension, metric, or
|
236
|
+
# event filters.
|
244
237
|
class AudienceSimpleFilter
|
245
238
|
include ::Google::Protobuf::MessageExts
|
246
239
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -256,8 +249,8 @@ module Google
|
|
256
249
|
# Optional. Defines the time period in which the whole sequence must occur.
|
257
250
|
# @!attribute [rw] sequence_steps
|
258
251
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceSequenceFilter::AudienceSequenceStep>]
|
259
|
-
# Required. An ordered sequence of steps. A user must complete each step in
|
260
|
-
# join the sequence filter.
|
252
|
+
# Required. An ordered sequence of steps. A user must complete each step in
|
253
|
+
# order to join the sequence filter.
|
261
254
|
class AudienceSequenceFilter
|
262
255
|
include ::Google::Protobuf::MessageExts
|
263
256
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -269,21 +262,21 @@ module Google
|
|
269
262
|
# Required. Immutable. Specifies the scope for this step.
|
270
263
|
# @!attribute [rw] immediately_follows
|
271
264
|
# @return [::Boolean]
|
272
|
-
# Optional. If true, the event satisfying this step must be the very next
|
273
|
-
# after the event satisfying the last step. If unset or false, this
|
265
|
+
# Optional. If true, the event satisfying this step must be the very next
|
266
|
+
# event after the event satisfying the last step. If unset or false, this
|
274
267
|
# step indirectly follows the prior step; for example, there may be
|
275
268
|
# events between the prior step and this step. It is ignored for the
|
276
269
|
# first step.
|
277
270
|
# @!attribute [rw] constraint_duration
|
278
271
|
# @return [::Google::Protobuf::Duration]
|
279
|
-
# Optional. When set, this step must be satisfied within the
|
280
|
-
# the previous step (i.e., t[i] - t[i-1] <=
|
281
|
-
# set, there is no duration requirement (the
|
282
|
-
# unlimited). It is ignored for the first step.
|
272
|
+
# Optional. When set, this step must be satisfied within the
|
273
|
+
# constraint_duration of the previous step (i.e., t[i] - t[i-1] <=
|
274
|
+
# constraint_duration). If not set, there is no duration requirement (the
|
275
|
+
# duration is effectively unlimited). It is ignored for the first step.
|
283
276
|
# @!attribute [rw] filter_expression
|
284
277
|
# @return [::Google::Analytics::Admin::V1alpha::AudienceFilterExpression]
|
285
|
-
# Required. Immutable. A logical expression of Audience dimension, metric,
|
286
|
-
# each step.
|
278
|
+
# Required. Immutable. A logical expression of Audience dimension, metric,
|
279
|
+
# or event filters in each step.
|
287
280
|
class AudienceSequenceStep
|
288
281
|
include ::Google::Protobuf::MessageExts
|
289
282
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -359,25 +352,25 @@ module Google
|
|
359
352
|
# Required. The description of the Audience.
|
360
353
|
# @!attribute [rw] membership_duration_days
|
361
354
|
# @return [::Integer]
|
362
|
-
# Required. Immutable. The duration a user should stay in an Audience. It
|
363
|
-
# than 540 days.
|
355
|
+
# Required. Immutable. The duration a user should stay in an Audience. It
|
356
|
+
# cannot be set to more than 540 days.
|
364
357
|
# @!attribute [r] ads_personalization_enabled
|
365
358
|
# @return [::Boolean]
|
366
|
-
# Output only. It is automatically set by GA to false if this is an NPA
|
367
|
-
# excluded from ads personalization.
|
359
|
+
# Output only. It is automatically set by GA to false if this is an NPA
|
360
|
+
# Audience and is excluded from ads personalization.
|
368
361
|
# @!attribute [rw] event_trigger
|
369
362
|
# @return [::Google::Analytics::Admin::V1alpha::AudienceEventTrigger]
|
370
|
-
# Optional. Specifies an event to log when a user joins the Audience. If not
|
371
|
-
# event is logged when a user joins the Audience.
|
363
|
+
# Optional. Specifies an event to log when a user joins the Audience. If not
|
364
|
+
# set, no event is logged when a user joins the Audience.
|
372
365
|
# @!attribute [rw] exclusion_duration_mode
|
373
366
|
# @return [::Google::Analytics::Admin::V1alpha::Audience::AudienceExclusionDurationMode]
|
374
|
-
# Immutable. Specifies how long an exclusion lasts for users that meet the
|
375
|
-
# filter. It is applied to all EXCLUDE filter clauses and is
|
376
|
-
# there is no EXCLUDE filter clause in the Audience.
|
367
|
+
# Immutable. Specifies how long an exclusion lasts for users that meet the
|
368
|
+
# exclusion filter. It is applied to all EXCLUDE filter clauses and is
|
369
|
+
# ignored when there is no EXCLUDE filter clause in the Audience.
|
377
370
|
# @!attribute [rw] filter_clauses
|
378
371
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterClause>]
|
379
|
-
# Required. Immutable.
|
380
|
-
# together.
|
372
|
+
# Required. Immutable. Unordered list. Filter clauses that define the
|
373
|
+
# Audience. All clauses will be AND’ed together.
|
381
374
|
class Audience
|
382
375
|
include ::Google::Protobuf::MessageExts
|
383
376
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|