google-analytics-admin-v1alpha 0.28.1 → 0.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +19 -3
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +3869 -2342
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +50 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/client.rb +3688 -2269
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +859 -26
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +35 -1
- data/lib/google/analytics/admin/v1alpha/audience_pb.rb +3 -1
- data/lib/google/analytics/admin/v1alpha/channel_group_pb.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/event_create_and_edit_pb.rb +2 -1
- data/lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +4 -1
- data/lib/google/analytics/admin/v1alpha/subproperty_event_filter_pb.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +238 -15
- data/proto_docs/google/analytics/admin/v1alpha/audience.rb +3 -0
- data/proto_docs/google/analytics/admin/v1alpha/channel_group.rb +8 -0
- data/proto_docs/google/analytics/admin/v1alpha/event_create_and_edit.rb +39 -0
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +80 -0
- data/proto_docs/google/api/client.rb +18 -10
- data/proto_docs/google/api/resource.rb +7 -2
- metadata +4 -116
@@ -353,7 +353,8 @@ module Google
|
|
353
353
|
# @!attribute [rw] parent
|
354
354
|
# @return [::String]
|
355
355
|
# Required. Format: properties/\\{property_id}
|
356
|
-
#
|
356
|
+
#
|
357
|
+
# Example: `properties/1234`
|
357
358
|
# @!attribute [rw] firebase_link
|
358
359
|
# @return [::Google::Analytics::Admin::V1alpha::FirebaseLink]
|
359
360
|
# Required. The Firebase link to create.
|
@@ -366,7 +367,8 @@ module Google
|
|
366
367
|
# @!attribute [rw] name
|
367
368
|
# @return [::String]
|
368
369
|
# Required. Format: properties/\\{property_id}/firebaseLinks/\\{firebase_link_id}
|
369
|
-
#
|
370
|
+
#
|
371
|
+
# Example: `properties/1234/firebaseLinks/5678`
|
370
372
|
class DeleteFirebaseLinkRequest
|
371
373
|
include ::Google::Protobuf::MessageExts
|
372
374
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -376,7 +378,8 @@ module Google
|
|
376
378
|
# @!attribute [rw] parent
|
377
379
|
# @return [::String]
|
378
380
|
# Required. Format: properties/\\{property_id}
|
379
|
-
#
|
381
|
+
#
|
382
|
+
# Example: `properties/1234`
|
380
383
|
# @!attribute [rw] page_size
|
381
384
|
# @return [::Integer]
|
382
385
|
# The maximum number of resources to return. The service may return
|
@@ -415,7 +418,8 @@ module Google
|
|
415
418
|
# Required. The name of the site tag to lookup.
|
416
419
|
# Note that site tags are singletons and do not have unique IDs.
|
417
420
|
# Format: properties/\\{property_id}/dataStreams/\\{stream_id}/globalSiteTag
|
418
|
-
#
|
421
|
+
#
|
422
|
+
# Example: `properties/123/dataStreams/456/globalSiteTag`
|
419
423
|
class GetGlobalSiteTagRequest
|
420
424
|
include ::Google::Protobuf::MessageExts
|
421
425
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -496,7 +500,8 @@ module Google
|
|
496
500
|
# @return [::String]
|
497
501
|
# Required. The name of the settings to lookup.
|
498
502
|
# Format: accounts/\\{account}/dataSharingSettings
|
499
|
-
#
|
503
|
+
#
|
504
|
+
# Example: `accounts/1000/dataSharingSettings`
|
500
505
|
class GetDataSharingSettingsRequest
|
501
506
|
include ::Google::Protobuf::MessageExts
|
502
507
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -562,13 +567,16 @@ module Google
|
|
562
567
|
# @!attribute [rw] account
|
563
568
|
# @return [::String]
|
564
569
|
# Required. The account resource for which to return change history
|
565
|
-
# resources. Format: accounts/\\{account}
|
570
|
+
# resources. Format: accounts/\\{account}
|
571
|
+
#
|
572
|
+
# Example: `accounts/100`
|
566
573
|
# @!attribute [rw] property
|
567
574
|
# @return [::String]
|
568
575
|
# Optional. Resource name for a child property. If set, only return changes
|
569
576
|
# made to this property or its child resources.
|
570
577
|
# Format: properties/\\{propertyId}
|
571
|
-
#
|
578
|
+
#
|
579
|
+
# Example: `properties/100`
|
572
580
|
# @!attribute [rw] resource_type
|
573
581
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
|
574
582
|
# Optional. If set, only return changes if they are for a resource that
|
@@ -902,6 +910,91 @@ module Google
|
|
902
910
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
903
911
|
end
|
904
912
|
|
913
|
+
# Request message for CreateKeyEvent RPC
|
914
|
+
# @!attribute [rw] key_event
|
915
|
+
# @return [::Google::Analytics::Admin::V1alpha::KeyEvent]
|
916
|
+
# Required. The Key Event to create.
|
917
|
+
# @!attribute [rw] parent
|
918
|
+
# @return [::String]
|
919
|
+
# Required. The resource name of the parent property where this Key Event
|
920
|
+
# will be created. Format: properties/123
|
921
|
+
class CreateKeyEventRequest
|
922
|
+
include ::Google::Protobuf::MessageExts
|
923
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
924
|
+
end
|
925
|
+
|
926
|
+
# Request message for UpdateKeyEvent RPC
|
927
|
+
# @!attribute [rw] key_event
|
928
|
+
# @return [::Google::Analytics::Admin::V1alpha::KeyEvent]
|
929
|
+
# Required. The Key Event to update.
|
930
|
+
# The `name` field is used to identify the settings to be updated.
|
931
|
+
# @!attribute [rw] update_mask
|
932
|
+
# @return [::Google::Protobuf::FieldMask]
|
933
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
934
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
935
|
+
# replace the entire entity, use one path with the string "*" to match all
|
936
|
+
# fields.
|
937
|
+
class UpdateKeyEventRequest
|
938
|
+
include ::Google::Protobuf::MessageExts
|
939
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
940
|
+
end
|
941
|
+
|
942
|
+
# Request message for GetKeyEvent RPC
|
943
|
+
# @!attribute [rw] name
|
944
|
+
# @return [::String]
|
945
|
+
# Required. The resource name of the Key Event to retrieve.
|
946
|
+
# Format: properties/\\{property}/keyEvents/\\{key_event}
|
947
|
+
# Example: "properties/123/keyEvents/456"
|
948
|
+
class GetKeyEventRequest
|
949
|
+
include ::Google::Protobuf::MessageExts
|
950
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
951
|
+
end
|
952
|
+
|
953
|
+
# Request message for DeleteKeyEvent RPC
|
954
|
+
# @!attribute [rw] name
|
955
|
+
# @return [::String]
|
956
|
+
# Required. The resource name of the Key Event to delete.
|
957
|
+
# Format: properties/\\{property}/keyEvents/\\{key_event}
|
958
|
+
# Example: "properties/123/keyEvents/456"
|
959
|
+
class DeleteKeyEventRequest
|
960
|
+
include ::Google::Protobuf::MessageExts
|
961
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
962
|
+
end
|
963
|
+
|
964
|
+
# Request message for ListKeyEvents RPC
|
965
|
+
# @!attribute [rw] parent
|
966
|
+
# @return [::String]
|
967
|
+
# Required. The resource name of the parent property.
|
968
|
+
# Example: 'properties/123'
|
969
|
+
# @!attribute [rw] page_size
|
970
|
+
# @return [::Integer]
|
971
|
+
# The maximum number of resources to return.
|
972
|
+
# If unspecified, at most 50 resources will be returned.
|
973
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
974
|
+
# @!attribute [rw] page_token
|
975
|
+
# @return [::String]
|
976
|
+
# A page token, received from a previous `ListKeyEvents` call.
|
977
|
+
# Provide this to retrieve the subsequent page.
|
978
|
+
# When paginating, all other parameters provided to `ListKeyEvents`
|
979
|
+
# must match the call that provided the page token.
|
980
|
+
class ListKeyEventsRequest
|
981
|
+
include ::Google::Protobuf::MessageExts
|
982
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
983
|
+
end
|
984
|
+
|
985
|
+
# Response message for ListKeyEvents RPC.
|
986
|
+
# @!attribute [rw] key_events
|
987
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::KeyEvent>]
|
988
|
+
# The requested Key Events
|
989
|
+
# @!attribute [rw] next_page_token
|
990
|
+
# @return [::String]
|
991
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
992
|
+
# If this field is omitted, there are no subsequent pages.
|
993
|
+
class ListKeyEventsResponse
|
994
|
+
include ::Google::Protobuf::MessageExts
|
995
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
996
|
+
end
|
997
|
+
|
905
998
|
# Request message for GetDisplayVideo360AdvertiserLink RPC.
|
906
999
|
# @!attribute [rw] name
|
907
1000
|
# @return [::String]
|
@@ -2025,6 +2118,18 @@ module Google
|
|
2025
2118
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2026
2119
|
end
|
2027
2120
|
|
2121
|
+
# Request message for CreateBigQueryLink RPC.
|
2122
|
+
# @!attribute [rw] parent
|
2123
|
+
# @return [::String]
|
2124
|
+
# Required. Example format: properties/1234
|
2125
|
+
# @!attribute [rw] bigquery_link
|
2126
|
+
# @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
2127
|
+
# Required. The BigQueryLink to create.
|
2128
|
+
class CreateBigQueryLinkRequest
|
2129
|
+
include ::Google::Protobuf::MessageExts
|
2130
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2131
|
+
end
|
2132
|
+
|
2028
2133
|
# Request message for GetBigQueryLink RPC.
|
2029
2134
|
# @!attribute [rw] name
|
2030
2135
|
# @return [::String]
|
@@ -2072,6 +2177,32 @@ module Google
|
|
2072
2177
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2073
2178
|
end
|
2074
2179
|
|
2180
|
+
# Request message for UpdateBigQueryLink RPC.
|
2181
|
+
# @!attribute [rw] bigquery_link
|
2182
|
+
# @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
2183
|
+
# Required. The settings to update.
|
2184
|
+
# The `name` field is used to identify the settings to be updated.
|
2185
|
+
# @!attribute [rw] update_mask
|
2186
|
+
# @return [::Google::Protobuf::FieldMask]
|
2187
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
2188
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
2189
|
+
# replace the entire entity, use one path with the string "*" to match all
|
2190
|
+
# fields.
|
2191
|
+
class UpdateBigQueryLinkRequest
|
2192
|
+
include ::Google::Protobuf::MessageExts
|
2193
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2194
|
+
end
|
2195
|
+
|
2196
|
+
# Request message for DeleteBigQueryLink RPC.
|
2197
|
+
# @!attribute [rw] name
|
2198
|
+
# @return [::String]
|
2199
|
+
# Required. The BigQueryLink to delete.
|
2200
|
+
# Example format: properties/1234/bigQueryLinks/5678
|
2201
|
+
class DeleteBigQueryLinkRequest
|
2202
|
+
include ::Google::Protobuf::MessageExts
|
2203
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2204
|
+
end
|
2205
|
+
|
2075
2206
|
# Request message for GetEnhancedMeasurementSettings RPC.
|
2076
2207
|
# @!attribute [rw] name
|
2077
2208
|
# @return [::String]
|
@@ -2368,6 +2499,103 @@ module Google
|
|
2368
2499
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2369
2500
|
end
|
2370
2501
|
|
2502
|
+
# Request message for CreateEventEditRule RPC.
|
2503
|
+
# @!attribute [rw] parent
|
2504
|
+
# @return [::String]
|
2505
|
+
# Required. Example format: properties/123/dataStreams/456
|
2506
|
+
# @!attribute [rw] event_edit_rule
|
2507
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventEditRule]
|
2508
|
+
# Required. The EventEditRule to create.
|
2509
|
+
class CreateEventEditRuleRequest
|
2510
|
+
include ::Google::Protobuf::MessageExts
|
2511
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2512
|
+
end
|
2513
|
+
|
2514
|
+
# Request message for UpdateEventEditRule RPC.
|
2515
|
+
# @!attribute [rw] event_edit_rule
|
2516
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventEditRule]
|
2517
|
+
# Required. The EventEditRule to update.
|
2518
|
+
# The resource's `name` field is used to identify the EventEditRule to be
|
2519
|
+
# updated.
|
2520
|
+
# @!attribute [rw] update_mask
|
2521
|
+
# @return [::Google::Protobuf::FieldMask]
|
2522
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
2523
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
2524
|
+
# replace the entire entity, use one path with the string "*" to match all
|
2525
|
+
# fields.
|
2526
|
+
class UpdateEventEditRuleRequest
|
2527
|
+
include ::Google::Protobuf::MessageExts
|
2528
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2529
|
+
end
|
2530
|
+
|
2531
|
+
# Request message for DeleteEventEditRule RPC.
|
2532
|
+
# @!attribute [rw] name
|
2533
|
+
# @return [::String]
|
2534
|
+
# Required. Example format: properties/123/dataStreams/456/eventEditRules/789
|
2535
|
+
class DeleteEventEditRuleRequest
|
2536
|
+
include ::Google::Protobuf::MessageExts
|
2537
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2538
|
+
end
|
2539
|
+
|
2540
|
+
# Request message for GetEventEditRule RPC.
|
2541
|
+
# @!attribute [rw] name
|
2542
|
+
# @return [::String]
|
2543
|
+
# Required. The name of the EventEditRule to get.
|
2544
|
+
# Example format: properties/123/dataStreams/456/eventEditRules/789
|
2545
|
+
class GetEventEditRuleRequest
|
2546
|
+
include ::Google::Protobuf::MessageExts
|
2547
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2548
|
+
end
|
2549
|
+
|
2550
|
+
# Request message for ListEventEditRules RPC.
|
2551
|
+
# @!attribute [rw] parent
|
2552
|
+
# @return [::String]
|
2553
|
+
# Required. Example format: properties/123/dataStreams/456
|
2554
|
+
# @!attribute [rw] page_size
|
2555
|
+
# @return [::Integer]
|
2556
|
+
# Optional. The maximum number of resources to return.
|
2557
|
+
# If unspecified, at most 50 resources will be returned.
|
2558
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
2559
|
+
# @!attribute [rw] page_token
|
2560
|
+
# @return [::String]
|
2561
|
+
# Optional. A page token, received from a previous `ListEventEditRules` call.
|
2562
|
+
# Provide this to retrieve the subsequent page.
|
2563
|
+
#
|
2564
|
+
# When paginating, all other parameters provided to `ListEventEditRules`
|
2565
|
+
# must match the call that provided the page token.
|
2566
|
+
class ListEventEditRulesRequest
|
2567
|
+
include ::Google::Protobuf::MessageExts
|
2568
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2569
|
+
end
|
2570
|
+
|
2571
|
+
# Response message for ListEventEditRules RPC.
|
2572
|
+
# @!attribute [rw] event_edit_rules
|
2573
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::EventEditRule>]
|
2574
|
+
# List of EventEditRules. These will be ordered stably, but in an arbitrary
|
2575
|
+
# order.
|
2576
|
+
# @!attribute [rw] next_page_token
|
2577
|
+
# @return [::String]
|
2578
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
2579
|
+
# If this field is omitted, there are no subsequent pages.
|
2580
|
+
class ListEventEditRulesResponse
|
2581
|
+
include ::Google::Protobuf::MessageExts
|
2582
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2583
|
+
end
|
2584
|
+
|
2585
|
+
# Request message for ReorderEventEditRules RPC.
|
2586
|
+
# @!attribute [rw] parent
|
2587
|
+
# @return [::String]
|
2588
|
+
# Required. Example format: properties/123/dataStreams/456
|
2589
|
+
# @!attribute [rw] event_edit_rules
|
2590
|
+
# @return [::Array<::String>]
|
2591
|
+
# Required. EventEditRule resource names for the specified data stream, in
|
2592
|
+
# the needed processing order. All EventEditRules for the stream must be
|
2593
|
+
# present in the list.
|
2594
|
+
class ReorderEventEditRulesRequest
|
2595
|
+
include ::Google::Protobuf::MessageExts
|
2596
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2597
|
+
end
|
2598
|
+
|
2371
2599
|
# Request message for CreateRollupProperty RPC.
|
2372
2600
|
# @!attribute [rw] rollup_property
|
2373
2601
|
# @return [::Google::Analytics::Admin::V1alpha::Property]
|
@@ -2466,30 +2694,25 @@ module Google
|
|
2466
2694
|
end
|
2467
2695
|
|
2468
2696
|
# Request message for CreateSubproperty RPC.
|
2469
|
-
# @!attribute [rw] parent
|
2470
|
-
# @return [::String]
|
2471
|
-
# Required. The ordinary property for which to create a subproperty.
|
2472
|
-
# Format: properties/property_id
|
2473
|
-
# Example: properties/123
|
2474
2697
|
# @!attribute [rw] subproperty
|
2475
2698
|
# @return [::Google::Analytics::Admin::V1alpha::Property]
|
2476
2699
|
# Required. The subproperty to create.
|
2477
2700
|
# @!attribute [rw] subproperty_event_filter
|
2478
2701
|
# @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilter]
|
2479
2702
|
# Optional. The subproperty event filter to create on an ordinary property.
|
2480
|
-
class
|
2703
|
+
class ProvisionSubpropertyRequest
|
2481
2704
|
include ::Google::Protobuf::MessageExts
|
2482
2705
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2483
2706
|
end
|
2484
2707
|
|
2485
|
-
# Response message for
|
2708
|
+
# Response message for ProvisionSubproperty RPC.
|
2486
2709
|
# @!attribute [rw] subproperty
|
2487
2710
|
# @return [::Google::Analytics::Admin::V1alpha::Property]
|
2488
2711
|
# The created subproperty.
|
2489
2712
|
# @!attribute [rw] subproperty_event_filter
|
2490
2713
|
# @return [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilter]
|
2491
2714
|
# The created subproperty event filter.
|
2492
|
-
class
|
2715
|
+
class ProvisionSubpropertyResponse
|
2493
2716
|
include ::Google::Protobuf::MessageExts
|
2494
2717
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2495
2718
|
end
|
@@ -376,6 +376,9 @@ module Google
|
|
376
376
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterClause>]
|
377
377
|
# Required. Immutable. Unordered list. Filter clauses that define the
|
378
378
|
# Audience. All clauses will be AND’ed together.
|
379
|
+
# @!attribute [r] create_time
|
380
|
+
# @return [::Google::Protobuf::Timestamp]
|
381
|
+
# Output only. Time when the Audience was created.
|
379
382
|
class Audience
|
380
383
|
include ::Google::Protobuf::MessageExts
|
381
384
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -149,6 +149,14 @@ module Google
|
|
149
149
|
# Output only. If true, then this channel group is the Default Channel Group
|
150
150
|
# predefined by Google Analytics. Display name and grouping rules cannot be
|
151
151
|
# updated for this channel group.
|
152
|
+
# @!attribute [rw] primary
|
153
|
+
# @return [::Boolean]
|
154
|
+
# Optional. If true, this channel group will be used as the default channel
|
155
|
+
# group for reports. Only one channel group can be set as `primary` at any
|
156
|
+
# time. If the `primary` field gets set on a channel group, it will get unset
|
157
|
+
# on the previous primary channel group.
|
158
|
+
#
|
159
|
+
# The Google Analytics predefined channel group is the primary by default.
|
152
160
|
class ChannelGroup
|
153
161
|
include ::Google::Protobuf::MessageExts
|
154
162
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -86,6 +86,45 @@ module Google
|
|
86
86
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
87
87
|
end
|
88
88
|
|
89
|
+
# An Event Edit Rule defines conditions that will trigger the creation of an
|
90
|
+
# entirely new event based upon matched criteria of a source event. Additional
|
91
|
+
# mutations of the parameters from the source event can be defined.
|
92
|
+
#
|
93
|
+
# Unlike Event Create rules, Event Edit Rules are applied in their defined
|
94
|
+
# order.
|
95
|
+
#
|
96
|
+
# Event Edit rules can't be used to modify an event created from an Event
|
97
|
+
# Create rule.
|
98
|
+
# @!attribute [rw] name
|
99
|
+
# @return [::String]
|
100
|
+
# Identifier. Resource name for this EventEditRule resource.
|
101
|
+
# Format:
|
102
|
+
# properties/\\{property}/dataStreams/\\{data_stream}/eventEditRules/\\{event_edit_rule}
|
103
|
+
# @!attribute [rw] display_name
|
104
|
+
# @return [::String]
|
105
|
+
# Required. The display name of this event edit rule. Maximum of 255
|
106
|
+
# characters.
|
107
|
+
# @!attribute [rw] event_conditions
|
108
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::MatchingCondition>]
|
109
|
+
# Required. Conditions on the source event must match for this rule to be
|
110
|
+
# applied. Must have at least one condition, and can have up to 10 max.
|
111
|
+
# @!attribute [rw] parameter_mutations
|
112
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ParameterMutation>]
|
113
|
+
# Required. Parameter mutations define parameter behavior on the new event,
|
114
|
+
# and are applied in order. A maximum of 20 mutations can be applied.
|
115
|
+
# @!attribute [r] processing_order
|
116
|
+
# @return [::Integer]
|
117
|
+
# Output only. The order for which this rule will be processed. Rules with an
|
118
|
+
# order value lower than this will be processed before this rule, rules with
|
119
|
+
# an order value higher than this will be processed after this rule. New
|
120
|
+
# event edit rules will be assigned an order value at the end of the order.
|
121
|
+
#
|
122
|
+
# This value does not apply to event create rules.
|
123
|
+
class EventEditRule
|
124
|
+
include ::Google::Protobuf::MessageExts
|
125
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
126
|
+
end
|
127
|
+
|
89
128
|
# Defines a condition for when an Event Edit or Event Creation rule applies to
|
90
129
|
# an event.
|
91
130
|
# @!attribute [rw] field
|
@@ -43,6 +43,11 @@ module Google
|
|
43
43
|
# @return [::Boolean]
|
44
44
|
# Output only. Indicates whether this Account is soft-deleted or not. Deleted
|
45
45
|
# accounts are excluded from List results unless specifically requested.
|
46
|
+
# @!attribute [r] gmp_organization
|
47
|
+
# @return [::String]
|
48
|
+
# Output only. The URI for a Google Marketing Platform organization resource.
|
49
|
+
# Only set when this account is connected to a GMP organization.
|
50
|
+
# Format: marketingplatformadmin.googleapis.com/organizations/\\{org_id}
|
46
51
|
class Account
|
47
52
|
include ::Google::Protobuf::MessageExts
|
48
53
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -865,6 +870,73 @@ module Google
|
|
865
870
|
end
|
866
871
|
end
|
867
872
|
|
873
|
+
# A key event in a Google Analytics property.
|
874
|
+
# @!attribute [r] name
|
875
|
+
# @return [::String]
|
876
|
+
# Output only. Resource name of this key event.
|
877
|
+
# Format: properties/\\{property}/keyEvents/\\{key_event}
|
878
|
+
# @!attribute [rw] event_name
|
879
|
+
# @return [::String]
|
880
|
+
# Immutable. The event name for this key event.
|
881
|
+
# Examples: 'click', 'purchase'
|
882
|
+
# @!attribute [r] create_time
|
883
|
+
# @return [::Google::Protobuf::Timestamp]
|
884
|
+
# Output only. Time when this key event was created in the property.
|
885
|
+
# @!attribute [r] deletable
|
886
|
+
# @return [::Boolean]
|
887
|
+
# Output only. If set to true, this event can be deleted.
|
888
|
+
# @!attribute [r] custom
|
889
|
+
# @return [::Boolean]
|
890
|
+
# Output only. If set to true, this key event refers to a custom event. If
|
891
|
+
# set to false, this key event refers to a default event in GA. Default
|
892
|
+
# events typically have special meaning in GA. Default events are usually
|
893
|
+
# created for you by the GA system, but in some cases can be created by
|
894
|
+
# property admins. Custom events count towards the maximum number of
|
895
|
+
# custom key events that may be created per property.
|
896
|
+
# @!attribute [rw] counting_method
|
897
|
+
# @return [::Google::Analytics::Admin::V1alpha::KeyEvent::CountingMethod]
|
898
|
+
# Required. The method by which Key Events will be counted across multiple
|
899
|
+
# events within a session.
|
900
|
+
# @!attribute [rw] default_value
|
901
|
+
# @return [::Google::Analytics::Admin::V1alpha::KeyEvent::DefaultValue]
|
902
|
+
# Optional. Defines a default value/currency for a key event.
|
903
|
+
class KeyEvent
|
904
|
+
include ::Google::Protobuf::MessageExts
|
905
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
906
|
+
|
907
|
+
# Defines a default value/currency for a key event.
|
908
|
+
# @!attribute [rw] numeric_value
|
909
|
+
# @return [::Float]
|
910
|
+
# Required. This will be used to populate the "value" parameter for all
|
911
|
+
# occurrences of this Key Event (specified by event_name) where that
|
912
|
+
# parameter is unset.
|
913
|
+
# @!attribute [rw] currency_code
|
914
|
+
# @return [::String]
|
915
|
+
# Required. When an occurrence of this Key Event (specified by event_name)
|
916
|
+
# has no set currency this currency will be applied as the default. Must be
|
917
|
+
# in ISO 4217 currency code format.
|
918
|
+
#
|
919
|
+
# See https://en.wikipedia.org/wiki/ISO_4217 for more information.
|
920
|
+
class DefaultValue
|
921
|
+
include ::Google::Protobuf::MessageExts
|
922
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
923
|
+
end
|
924
|
+
|
925
|
+
# The method by which Key Events will be counted across multiple events
|
926
|
+
# within a session.
|
927
|
+
module CountingMethod
|
928
|
+
# Counting method not specified.
|
929
|
+
COUNTING_METHOD_UNSPECIFIED = 0
|
930
|
+
|
931
|
+
# Each Event instance is considered a Key Event.
|
932
|
+
ONCE_PER_EVENT = 1
|
933
|
+
|
934
|
+
# An Event instance is considered a Key Event at most once per session per
|
935
|
+
# user.
|
936
|
+
ONCE_PER_SESSION = 2
|
937
|
+
end
|
938
|
+
end
|
939
|
+
|
868
940
|
# Settings values for Google Signals. This is a singleton resource.
|
869
941
|
# @!attribute [r] name
|
870
942
|
# @return [::String]
|
@@ -1358,6 +1430,11 @@ module Google
|
|
1358
1430
|
# @!attribute [rw] excluded_events
|
1359
1431
|
# @return [::Array<::String>]
|
1360
1432
|
# The list of event names that will be excluded from exports.
|
1433
|
+
# @!attribute [rw] dataset_location
|
1434
|
+
# @return [::String]
|
1435
|
+
# Required. Immutable. The geographic location where the created BigQuery
|
1436
|
+
# dataset should reside. See https://cloud.google.com/bigquery/docs/locations
|
1437
|
+
# for supported locations.
|
1361
1438
|
class BigQueryLink
|
1362
1439
|
include ::Google::Protobuf::MessageExts
|
1363
1440
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1680,6 +1757,9 @@ module Google
|
|
1680
1757
|
# ChannelGroup resource
|
1681
1758
|
CHANNEL_GROUP = 22
|
1682
1759
|
|
1760
|
+
# BigQuery link resource
|
1761
|
+
BIGQUERY_LINK = 23
|
1762
|
+
|
1683
1763
|
# EnhancedMeasurementSettings resource
|
1684
1764
|
ENHANCED_MEASUREMENT_SETTINGS = 24
|
1685
1765
|
|
@@ -118,6 +118,10 @@ module Google
|
|
118
118
|
# @return [::String]
|
119
119
|
# Optional link to proto reference documentation. Example:
|
120
120
|
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
121
|
+
# @!attribute [rw] rest_reference_documentation_uri
|
122
|
+
# @return [::String]
|
123
|
+
# Optional link to REST reference documentation. Example:
|
124
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rest
|
121
125
|
class Publishing
|
122
126
|
include ::Google::Protobuf::MessageExts
|
123
127
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -286,6 +290,13 @@ module Google
|
|
286
290
|
# @return [::String]
|
287
291
|
# The fully qualified name of the method, for which the options below apply.
|
288
292
|
# This is used to find the method to apply the options.
|
293
|
+
#
|
294
|
+
# Example:
|
295
|
+
#
|
296
|
+
# publishing:
|
297
|
+
# method_settings:
|
298
|
+
# - selector: google.storage.control.v2.StorageControl.CreateFolder
|
299
|
+
# # method settings for CreateFolder...
|
289
300
|
# @!attribute [rw] long_running
|
290
301
|
# @return [::Google::Api::MethodSettings::LongRunning]
|
291
302
|
# Describes settings to use for long-running operations when generating
|
@@ -294,17 +305,14 @@ module Google
|
|
294
305
|
#
|
295
306
|
# Example of a YAML configuration::
|
296
307
|
#
|
297
|
-
#
|
298
|
-
#
|
308
|
+
# publishing:
|
309
|
+
# method_settings:
|
299
310
|
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
300
311
|
# long_running:
|
301
|
-
# initial_poll_delay:
|
302
|
-
# seconds: 60 # 1 minute
|
312
|
+
# initial_poll_delay: 60s # 1 minute
|
303
313
|
# poll_delay_multiplier: 1.5
|
304
|
-
# max_poll_delay:
|
305
|
-
#
|
306
|
-
# total_poll_timeout:
|
307
|
-
# seconds: 54000 # 90 minutes
|
314
|
+
# max_poll_delay: 360s # 6 minutes
|
315
|
+
# total_poll_timeout: 54000s # 90 minutes
|
308
316
|
# @!attribute [rw] auto_populated_fields
|
309
317
|
# @return [::Array<::String>]
|
310
318
|
# List of top-level fields of the request message, that should be
|
@@ -313,8 +321,8 @@ module Google
|
|
313
321
|
#
|
314
322
|
# Example of a YAML configuration:
|
315
323
|
#
|
316
|
-
#
|
317
|
-
#
|
324
|
+
# publishing:
|
325
|
+
# method_settings:
|
318
326
|
# - selector: google.example.v1.ExampleService.CreateExample
|
319
327
|
# auto_populated_fields:
|
320
328
|
# - request_id
|
@@ -124,8 +124,13 @@ module Google
|
|
124
124
|
# @return [::String]
|
125
125
|
# The plural name used in the resource name and permission names, such as
|
126
126
|
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
127
|
-
# name of 'cloudresourcemanager.googleapis.com/projects.get'.
|
128
|
-
#
|
127
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
|
128
|
+
# to this is for Nested Collections that have stuttering names, as defined
|
129
|
+
# in [AIP-122](https://google.aip.dev/122#nested-collections), where the
|
130
|
+
# collection ID in the resource name pattern does not necessarily directly
|
131
|
+
# match the `plural` value.
|
132
|
+
#
|
133
|
+
# It is the same concept of the `plural` field in k8s CRD spec
|
129
134
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
130
135
|
#
|
131
136
|
# Note: The plural form is required even for singleton resources. See
|