google-analytics-admin-v1alpha 0.9.1 → 0.10.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/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +37 -9
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +633 -244
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +15 -15
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +15 -8
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +39 -15
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +105 -27
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +127 -73
- data/proto_docs/google/api/resource.rb +10 -71
- metadata +3 -3
@@ -129,54 +129,54 @@ module Google
|
|
129
129
|
end
|
130
130
|
|
131
131
|
##
|
132
|
-
# Create a fully-qualified
|
132
|
+
# Create a fully-qualified DataStream resource string.
|
133
133
|
#
|
134
134
|
# The resource will be in the following format:
|
135
135
|
#
|
136
|
-
# `properties/{property}/
|
136
|
+
# `properties/{property}/dataStreams/{data_stream}`
|
137
137
|
#
|
138
138
|
# @param property [String]
|
139
|
-
# @param
|
139
|
+
# @param data_stream [String]
|
140
140
|
#
|
141
141
|
# @return [::String]
|
142
|
-
def
|
142
|
+
def data_stream_path property:, data_stream:
|
143
143
|
raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
|
144
144
|
|
145
|
-
"properties/#{property}/
|
145
|
+
"properties/#{property}/dataStreams/#{data_stream}"
|
146
146
|
end
|
147
147
|
|
148
148
|
##
|
149
|
-
# Create a fully-qualified
|
149
|
+
# Create a fully-qualified DisplayVideo360AdvertiserLink resource string.
|
150
150
|
#
|
151
151
|
# The resource will be in the following format:
|
152
152
|
#
|
153
|
-
# `properties/{property}/
|
153
|
+
# `properties/{property}/displayVideo360AdvertiserLinks/{display_video_360_advertiser_link}`
|
154
154
|
#
|
155
155
|
# @param property [String]
|
156
|
-
# @param
|
156
|
+
# @param display_video_360_advertiser_link [String]
|
157
157
|
#
|
158
158
|
# @return [::String]
|
159
|
-
def
|
159
|
+
def display_video360_advertiser_link_path property:, display_video_360_advertiser_link:
|
160
160
|
raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
|
161
161
|
|
162
|
-
"properties/#{property}/
|
162
|
+
"properties/#{property}/displayVideo360AdvertiserLinks/#{display_video_360_advertiser_link}"
|
163
163
|
end
|
164
164
|
|
165
165
|
##
|
166
|
-
# Create a fully-qualified
|
166
|
+
# Create a fully-qualified DisplayVideo360AdvertiserLinkProposal resource string.
|
167
167
|
#
|
168
168
|
# The resource will be in the following format:
|
169
169
|
#
|
170
|
-
# `properties/{property}/
|
170
|
+
# `properties/{property}/displayVideo360AdvertiserLinkProposals/{display_video_360_advertiser_link_proposal}`
|
171
171
|
#
|
172
172
|
# @param property [String]
|
173
|
-
# @param
|
173
|
+
# @param display_video_360_advertiser_link_proposal [String]
|
174
174
|
#
|
175
175
|
# @return [::String]
|
176
|
-
def
|
176
|
+
def display_video360_advertiser_link_proposal_path property:, display_video_360_advertiser_link_proposal:
|
177
177
|
raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
|
178
178
|
|
179
|
-
"properties/#{property}/
|
179
|
+
"properties/#{property}/displayVideo360AdvertiserLinkProposals/#{display_video_360_advertiser_link_proposal}"
|
180
180
|
end
|
181
181
|
|
182
182
|
##
|
@@ -154,14 +154,6 @@ module Google
|
|
154
154
|
# Android app streams will be excluded if the caller does not have access.
|
155
155
|
# Returns an empty list if no relevant android app streams are found.
|
156
156
|
rpc :ListAndroidAppDataStreams, ::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsResponse
|
157
|
-
# Returns the singleton enhanced measurement settings for this web stream.
|
158
|
-
# Note that the stream must enable enhanced measurement for these settings to
|
159
|
-
# take effect.
|
160
|
-
rpc :GetEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
|
161
|
-
# Updates the singleton enhanced measurement settings for this web stream.
|
162
|
-
# Note that the stream must enable enhanced measurement for these settings to
|
163
|
-
# take effect.
|
164
|
-
rpc :UpdateEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
|
165
157
|
# Creates a FirebaseLink.
|
166
158
|
#
|
167
159
|
# Properties can have at most one FirebaseLink.
|
@@ -196,6 +188,11 @@ module Google
|
|
196
188
|
rpc :DeleteMeasurementProtocolSecret, ::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest, ::Google::Protobuf::Empty
|
197
189
|
# Updates a measurement protocol secret.
|
198
190
|
rpc :UpdateMeasurementProtocolSecret, ::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest, ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
|
191
|
+
# Acknowledges the terms of user data collection for the specified property.
|
192
|
+
#
|
193
|
+
# This acknowledgement must be completed (either in the Google Analytics UI
|
194
|
+
# or via this API) before MeasurementProtocolSecret resources may be created.
|
195
|
+
rpc :AcknowledgeUserDataCollection, ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionRequest, ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse
|
199
196
|
# Searches through all changes to an account or its children given the
|
200
197
|
# specified set of filters.
|
201
198
|
rpc :SearchChangeHistoryEvents, ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest, ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsResponse
|
@@ -270,6 +267,16 @@ module Google
|
|
270
267
|
rpc :GetDataRetentionSettings, ::Google::Analytics::Admin::V1alpha::GetDataRetentionSettingsRequest, ::Google::Analytics::Admin::V1alpha::DataRetentionSettings
|
271
268
|
# Updates the singleton data retention settings for this property.
|
272
269
|
rpc :UpdateDataRetentionSettings, ::Google::Analytics::Admin::V1alpha::UpdateDataRetentionSettingsRequest, ::Google::Analytics::Admin::V1alpha::DataRetentionSettings
|
270
|
+
# Creates a DataStream.
|
271
|
+
rpc :CreateDataStream, ::Google::Analytics::Admin::V1alpha::CreateDataStreamRequest, ::Google::Analytics::Admin::V1alpha::DataStream
|
272
|
+
# Deletes a DataStream on a property.
|
273
|
+
rpc :DeleteDataStream, ::Google::Analytics::Admin::V1alpha::DeleteDataStreamRequest, ::Google::Protobuf::Empty
|
274
|
+
# Updates a DataStream on a property.
|
275
|
+
rpc :UpdateDataStream, ::Google::Analytics::Admin::V1alpha::UpdateDataStreamRequest, ::Google::Analytics::Admin::V1alpha::DataStream
|
276
|
+
# Lists DataStreams on a property.
|
277
|
+
rpc :ListDataStreams, ::Google::Analytics::Admin::V1alpha::ListDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListDataStreamsResponse
|
278
|
+
# Lookup for a single DataStream.
|
279
|
+
rpc :GetDataStream, ::Google::Analytics::Admin::V1alpha::GetDataStreamRequest, ::Google::Analytics::Admin::V1alpha::DataStream
|
273
280
|
end
|
274
281
|
|
275
282
|
Stub = Service.rpc_stub_class
|
@@ -29,6 +29,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
29
29
|
optional :service_level, :enum, 10, "google.analytics.admin.v1alpha.ServiceLevel"
|
30
30
|
optional :delete_time, :message, 11, "google.protobuf.Timestamp"
|
31
31
|
optional :expire_time, :message, 12, "google.protobuf.Timestamp"
|
32
|
+
optional :account, :string, 13
|
32
33
|
end
|
33
34
|
add_message "google.analytics.admin.v1alpha.AndroidAppDataStream" do
|
34
35
|
optional :name, :string, 1
|
@@ -55,6 +56,37 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
55
56
|
optional :default_uri, :string, 6
|
56
57
|
optional :display_name, :string, 7
|
57
58
|
end
|
59
|
+
add_message "google.analytics.admin.v1alpha.DataStream" do
|
60
|
+
optional :name, :string, 1
|
61
|
+
optional :type, :enum, 2, "google.analytics.admin.v1alpha.DataStream.DataStreamType"
|
62
|
+
optional :display_name, :string, 3
|
63
|
+
optional :create_time, :message, 4, "google.protobuf.Timestamp"
|
64
|
+
optional :update_time, :message, 5, "google.protobuf.Timestamp"
|
65
|
+
oneof :stream_data do
|
66
|
+
optional :web_stream_data, :message, 6, "google.analytics.admin.v1alpha.DataStream.WebStreamData"
|
67
|
+
optional :android_app_stream_data, :message, 7, "google.analytics.admin.v1alpha.DataStream.AndroidAppStreamData"
|
68
|
+
optional :ios_app_stream_data, :message, 8, "google.analytics.admin.v1alpha.DataStream.IosAppStreamData"
|
69
|
+
end
|
70
|
+
end
|
71
|
+
add_message "google.analytics.admin.v1alpha.DataStream.WebStreamData" do
|
72
|
+
optional :measurement_id, :string, 1
|
73
|
+
optional :firebase_app_id, :string, 2
|
74
|
+
optional :default_uri, :string, 3
|
75
|
+
end
|
76
|
+
add_message "google.analytics.admin.v1alpha.DataStream.AndroidAppStreamData" do
|
77
|
+
optional :firebase_app_id, :string, 1
|
78
|
+
optional :package_name, :string, 2
|
79
|
+
end
|
80
|
+
add_message "google.analytics.admin.v1alpha.DataStream.IosAppStreamData" do
|
81
|
+
optional :firebase_app_id, :string, 1
|
82
|
+
optional :bundle_id, :string, 2
|
83
|
+
end
|
84
|
+
add_enum "google.analytics.admin.v1alpha.DataStream.DataStreamType" do
|
85
|
+
value :DATA_STREAM_TYPE_UNSPECIFIED, 0
|
86
|
+
value :WEB_DATA_STREAM, 1
|
87
|
+
value :ANDROID_APP_DATA_STREAM, 2
|
88
|
+
value :IOS_APP_DATA_STREAM, 3
|
89
|
+
end
|
58
90
|
add_message "google.analytics.admin.v1alpha.UserLink" do
|
59
91
|
optional :name, :string, 1
|
60
92
|
optional :email_address, :string, 2
|
@@ -66,20 +98,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
66
98
|
repeated :direct_roles, :string, 3
|
67
99
|
repeated :effective_roles, :string, 4
|
68
100
|
end
|
69
|
-
add_message "google.analytics.admin.v1alpha.EnhancedMeasurementSettings" do
|
70
|
-
optional :name, :string, 1
|
71
|
-
optional :stream_enabled, :bool, 2
|
72
|
-
optional :page_views_enabled, :bool, 3
|
73
|
-
optional :scrolls_enabled, :bool, 4
|
74
|
-
optional :outbound_clicks_enabled, :bool, 5
|
75
|
-
optional :site_search_enabled, :bool, 7
|
76
|
-
optional :video_engagement_enabled, :bool, 9
|
77
|
-
optional :file_downloads_enabled, :bool, 10
|
78
|
-
optional :page_loads_enabled, :bool, 12
|
79
|
-
optional :page_changes_enabled, :bool, 13
|
80
|
-
optional :search_query_parameter, :string, 16
|
81
|
-
optional :uri_query_parameter, :string, 17
|
82
|
-
end
|
83
101
|
add_message "google.analytics.admin.v1alpha.FirebaseLink" do
|
84
102
|
optional :name, :string, 1
|
85
103
|
optional :project, :string, 2
|
@@ -301,6 +319,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
301
319
|
value :CUSTOM_DIMENSION, 11
|
302
320
|
value :CUSTOM_METRIC, 12
|
303
321
|
value :DATA_RETENTION_SETTINGS, 13
|
322
|
+
value :DISPLAY_VIDEO_360_ADVERTISER_LINK, 14
|
323
|
+
value :DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL, 15
|
304
324
|
end
|
305
325
|
add_enum "google.analytics.admin.v1alpha.GoogleSignalsState" do
|
306
326
|
value :GOOGLE_SIGNALS_STATE_UNSPECIFIED, 0
|
@@ -338,9 +358,13 @@ module Google
|
|
338
358
|
AndroidAppDataStream = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AndroidAppDataStream").msgclass
|
339
359
|
IosAppDataStream = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IosAppDataStream").msgclass
|
340
360
|
WebDataStream = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.WebDataStream").msgclass
|
361
|
+
DataStream = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataStream").msgclass
|
362
|
+
DataStream::WebStreamData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataStream.WebStreamData").msgclass
|
363
|
+
DataStream::AndroidAppStreamData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataStream.AndroidAppStreamData").msgclass
|
364
|
+
DataStream::IosAppStreamData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataStream.IosAppStreamData").msgclass
|
365
|
+
DataStream::DataStreamType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataStream.DataStreamType").enummodule
|
341
366
|
UserLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UserLink").msgclass
|
342
367
|
AuditUserLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AuditUserLink").msgclass
|
343
|
-
EnhancedMeasurementSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.EnhancedMeasurementSettings").msgclass
|
344
368
|
FirebaseLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.FirebaseLink").msgclass
|
345
369
|
GlobalSiteTag = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GlobalSiteTag").msgclass
|
346
370
|
GoogleAdsLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GoogleAdsLink").msgclass
|
@@ -662,33 +662,6 @@ module Google
|
|
662
662
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
663
663
|
end
|
664
664
|
|
665
|
-
# Request message for GetEnhancedMeasurementSettings RPC.
|
666
|
-
# @!attribute [rw] name
|
667
|
-
# @return [::String]
|
668
|
-
# Required. The name of the settings to lookup.
|
669
|
-
# Format:
|
670
|
-
# properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
|
671
|
-
# Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
672
|
-
class GetEnhancedMeasurementSettingsRequest
|
673
|
-
include ::Google::Protobuf::MessageExts
|
674
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
675
|
-
end
|
676
|
-
|
677
|
-
# Request message for UpdateEnhancedMeasurementSettings RPC.
|
678
|
-
# @!attribute [rw] enhanced_measurement_settings
|
679
|
-
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
680
|
-
# Required. The settings to update.
|
681
|
-
# The `name` field is used to identify the settings to be updated.
|
682
|
-
# @!attribute [rw] update_mask
|
683
|
-
# @return [::Google::Protobuf::FieldMask]
|
684
|
-
# Required. The list of fields to be updated. Field names must be in snake case
|
685
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To replace
|
686
|
-
# the entire entity, use one path with the string "*" to match all fields.
|
687
|
-
class UpdateEnhancedMeasurementSettingsRequest
|
688
|
-
include ::Google::Protobuf::MessageExts
|
689
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
690
|
-
end
|
691
|
-
|
692
665
|
# Request message for CreateFirebaseLink RPC
|
693
666
|
# @!attribute [rw] parent
|
694
667
|
# @return [::String]
|
@@ -872,6 +845,31 @@ module Google
|
|
872
845
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
873
846
|
end
|
874
847
|
|
848
|
+
# Request message for AcknowledgeUserDataCollection RPC.
|
849
|
+
# @!attribute [rw] property
|
850
|
+
# @return [::String]
|
851
|
+
# Required. The property for which to acknowledge user data collection.
|
852
|
+
# @!attribute [rw] acknowledgement
|
853
|
+
# @return [::String]
|
854
|
+
# Required. An acknowledgement that the caller of this method understands the terms
|
855
|
+
# of user data collection.
|
856
|
+
#
|
857
|
+
# This field must contain the exact value:
|
858
|
+
# "I acknowledge that I have the necessary privacy disclosures and rights
|
859
|
+
# from my end users for the collection and processing of their data,
|
860
|
+
# including the association of such data with the visitation information
|
861
|
+
# Google Analytics collects from my site and/or app property."
|
862
|
+
class AcknowledgeUserDataCollectionRequest
|
863
|
+
include ::Google::Protobuf::MessageExts
|
864
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
865
|
+
end
|
866
|
+
|
867
|
+
# Response message for AcknowledgeUserDataCollection RPC.
|
868
|
+
class AcknowledgeUserDataCollectionResponse
|
869
|
+
include ::Google::Protobuf::MessageExts
|
870
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
871
|
+
end
|
872
|
+
|
875
873
|
# Request message for SearchChangeHistoryEvents RPC.
|
876
874
|
# @!attribute [rw] account
|
877
875
|
# @return [::String]
|
@@ -1476,6 +1474,86 @@ module Google
|
|
1476
1474
|
include ::Google::Protobuf::MessageExts
|
1477
1475
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1478
1476
|
end
|
1477
|
+
|
1478
|
+
# Request message for CreateDataStream RPC.
|
1479
|
+
# @!attribute [rw] parent
|
1480
|
+
# @return [::String]
|
1481
|
+
# Required. Example format: properties/1234
|
1482
|
+
# @!attribute [rw] data_stream
|
1483
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream]
|
1484
|
+
# Required. The DataStream to create.
|
1485
|
+
class CreateDataStreamRequest
|
1486
|
+
include ::Google::Protobuf::MessageExts
|
1487
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1488
|
+
end
|
1489
|
+
|
1490
|
+
# Request message for DeleteDataStream RPC.
|
1491
|
+
# @!attribute [rw] name
|
1492
|
+
# @return [::String]
|
1493
|
+
# Required. The name of the DataStream to delete.
|
1494
|
+
# Example format: properties/1234/dataStreams/5678
|
1495
|
+
class DeleteDataStreamRequest
|
1496
|
+
include ::Google::Protobuf::MessageExts
|
1497
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1498
|
+
end
|
1499
|
+
|
1500
|
+
# Request message for UpdateDataStream RPC.
|
1501
|
+
# @!attribute [rw] data_stream
|
1502
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream]
|
1503
|
+
# The DataStream to update
|
1504
|
+
# @!attribute [rw] update_mask
|
1505
|
+
# @return [::Google::Protobuf::FieldMask]
|
1506
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
1507
|
+
# To replace the entire entity, use one path with the string "*" to match
|
1508
|
+
# all fields.
|
1509
|
+
class UpdateDataStreamRequest
|
1510
|
+
include ::Google::Protobuf::MessageExts
|
1511
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1512
|
+
end
|
1513
|
+
|
1514
|
+
# Request message for ListDataStreams RPC.
|
1515
|
+
# @!attribute [rw] parent
|
1516
|
+
# @return [::String]
|
1517
|
+
# Required. Example format: properties/1234
|
1518
|
+
# @!attribute [rw] page_size
|
1519
|
+
# @return [::Integer]
|
1520
|
+
# The maximum number of resources to return.
|
1521
|
+
# If unspecified, at most 50 resources will be returned.
|
1522
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
1523
|
+
# @!attribute [rw] page_token
|
1524
|
+
# @return [::String]
|
1525
|
+
# A page token, received from a previous `ListDataStreams` call.
|
1526
|
+
# Provide this to retrieve the subsequent page.
|
1527
|
+
#
|
1528
|
+
# When paginating, all other parameters provided to `ListDataStreams` must
|
1529
|
+
# match the call that provided the page token.
|
1530
|
+
class ListDataStreamsRequest
|
1531
|
+
include ::Google::Protobuf::MessageExts
|
1532
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1533
|
+
end
|
1534
|
+
|
1535
|
+
# Response message for ListDataStreams RPC.
|
1536
|
+
# @!attribute [rw] data_streams
|
1537
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::DataStream>]
|
1538
|
+
# List of DataStreams.
|
1539
|
+
# @!attribute [rw] next_page_token
|
1540
|
+
# @return [::String]
|
1541
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1542
|
+
# If this field is omitted, there are no subsequent pages.
|
1543
|
+
class ListDataStreamsResponse
|
1544
|
+
include ::Google::Protobuf::MessageExts
|
1545
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1546
|
+
end
|
1547
|
+
|
1548
|
+
# Request message for GetDataStream RPC.
|
1549
|
+
# @!attribute [rw] name
|
1550
|
+
# @return [::String]
|
1551
|
+
# Required. The name of the DataStream to get.
|
1552
|
+
# Example format: properties/1234/dataStreams/5678
|
1553
|
+
class GetDataStreamRequest
|
1554
|
+
include ::Google::Protobuf::MessageExts
|
1555
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1556
|
+
end
|
1479
1557
|
end
|
1480
1558
|
end
|
1481
1559
|
end
|
@@ -106,6 +106,11 @@ module Google
|
|
106
106
|
# Output only. If set, the time at which this trashed property will be permanently
|
107
107
|
# deleted. If not set, then this property is not currently in the trash can
|
108
108
|
# and is not slated to be deleted.
|
109
|
+
# @!attribute [rw] account
|
110
|
+
# @return [::String]
|
111
|
+
# Immutable. The resource name of the parent account
|
112
|
+
# Format: accounts/\\{account_id}
|
113
|
+
# Example: "accounts/123"
|
109
114
|
class Property
|
110
115
|
include ::Google::Protobuf::MessageExts
|
111
116
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -199,12 +204,112 @@ module Google
|
|
199
204
|
# @return [::String]
|
200
205
|
# Required. Human-readable display name for the Data Stream.
|
201
206
|
#
|
202
|
-
# The max allowed display name length is
|
207
|
+
# The max allowed display name length is 255 UTF-16 code units.
|
203
208
|
class WebDataStream
|
204
209
|
include ::Google::Protobuf::MessageExts
|
205
210
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
206
211
|
end
|
207
212
|
|
213
|
+
# A resource message representing a data stream.
|
214
|
+
# @!attribute [rw] web_stream_data
|
215
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream::WebStreamData]
|
216
|
+
# Data specific to web streams. Must be populated if type is
|
217
|
+
# WEB_DATA_STREAM.
|
218
|
+
# @!attribute [rw] android_app_stream_data
|
219
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream::AndroidAppStreamData]
|
220
|
+
# Data specific to Android app streams. Must be populated if type is
|
221
|
+
# ANDROID_APP_DATA_STREAM.
|
222
|
+
# @!attribute [rw] ios_app_stream_data
|
223
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream::IosAppStreamData]
|
224
|
+
# Data specific to iOS app streams. Must be populated if type is
|
225
|
+
# IOS_APP_DATA_STREAM.
|
226
|
+
# @!attribute [r] name
|
227
|
+
# @return [::String]
|
228
|
+
# Output only. Resource name of this Data Stream.
|
229
|
+
# Format: properties/\\{property_id}/dataStreams/\\{stream_id}
|
230
|
+
# Example: "properties/1000/dataStreams/2000"
|
231
|
+
# @!attribute [rw] type
|
232
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream::DataStreamType]
|
233
|
+
# Required. Immutable. The type of this DataStream resource.
|
234
|
+
# @!attribute [rw] display_name
|
235
|
+
# @return [::String]
|
236
|
+
# Human-readable display name for the Data Stream.
|
237
|
+
#
|
238
|
+
# Required for web data streams.
|
239
|
+
#
|
240
|
+
# The max allowed display name length is 255 UTF-16 code units.
|
241
|
+
# @!attribute [r] create_time
|
242
|
+
# @return [::Google::Protobuf::Timestamp]
|
243
|
+
# Output only. Time when this stream was originally created.
|
244
|
+
# @!attribute [r] update_time
|
245
|
+
# @return [::Google::Protobuf::Timestamp]
|
246
|
+
# Output only. Time when stream payload fields were last updated.
|
247
|
+
class DataStream
|
248
|
+
include ::Google::Protobuf::MessageExts
|
249
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
250
|
+
|
251
|
+
# Data specific to web streams.
|
252
|
+
# @!attribute [r] measurement_id
|
253
|
+
# @return [::String]
|
254
|
+
# Output only. Analytics "Measurement ID", without the "G-" prefix.
|
255
|
+
# Example: "G-1A2BCD345E" would just be "1A2BCD345E"
|
256
|
+
# @!attribute [r] firebase_app_id
|
257
|
+
# @return [::String]
|
258
|
+
# Output only. ID of the corresponding web app in Firebase, if any.
|
259
|
+
# This ID can change if the web app is deleted and recreated.
|
260
|
+
# @!attribute [rw] default_uri
|
261
|
+
# @return [::String]
|
262
|
+
# Immutable. Domain name of the web app being measured, or empty.
|
263
|
+
# Example: "http://www.google.com", "https://www.google.com"
|
264
|
+
class WebStreamData
|
265
|
+
include ::Google::Protobuf::MessageExts
|
266
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
267
|
+
end
|
268
|
+
|
269
|
+
# Data specific to Android app streams.
|
270
|
+
# @!attribute [r] firebase_app_id
|
271
|
+
# @return [::String]
|
272
|
+
# Output only. ID of the corresponding Android app in Firebase, if any.
|
273
|
+
# This ID can change if the Android app is deleted and recreated.
|
274
|
+
# @!attribute [rw] package_name
|
275
|
+
# @return [::String]
|
276
|
+
# Immutable. The package name for the app being measured.
|
277
|
+
# Example: "com.example.myandroidapp"
|
278
|
+
class AndroidAppStreamData
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
|
283
|
+
# Data specific to iOS app streams.
|
284
|
+
# @!attribute [r] firebase_app_id
|
285
|
+
# @return [::String]
|
286
|
+
# Output only. ID of the corresponding iOS app in Firebase, if any.
|
287
|
+
# This ID can change if the iOS app is deleted and recreated.
|
288
|
+
# @!attribute [rw] bundle_id
|
289
|
+
# @return [::String]
|
290
|
+
# Required. Immutable. The Apple App Store Bundle ID for the app
|
291
|
+
# Example: "com.example.myiosapp"
|
292
|
+
class IosAppStreamData
|
293
|
+
include ::Google::Protobuf::MessageExts
|
294
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
295
|
+
end
|
296
|
+
|
297
|
+
# The type of the data stream.
|
298
|
+
module DataStreamType
|
299
|
+
# Type unknown or not specified.
|
300
|
+
DATA_STREAM_TYPE_UNSPECIFIED = 0
|
301
|
+
|
302
|
+
# Web data stream.
|
303
|
+
WEB_DATA_STREAM = 1
|
304
|
+
|
305
|
+
# Android app data stream.
|
306
|
+
ANDROID_APP_DATA_STREAM = 2
|
307
|
+
|
308
|
+
# iOS app data stream.
|
309
|
+
IOS_APP_DATA_STREAM = 3
|
310
|
+
end
|
311
|
+
end
|
312
|
+
|
208
313
|
# A resource message representing a user's permissions on an Account or
|
209
314
|
# Property resource.
|
210
315
|
# @!attribute [r] name
|
@@ -218,10 +323,12 @@ module Google
|
|
218
323
|
# Roles directly assigned to this user for this account or property.
|
219
324
|
#
|
220
325
|
# Valid values:
|
221
|
-
# predefinedRoles/
|
222
|
-
# predefinedRoles/
|
223
|
-
# predefinedRoles/
|
224
|
-
# predefinedRoles/
|
326
|
+
# predefinedRoles/viewer
|
327
|
+
# predefinedRoles/analyst
|
328
|
+
# predefinedRoles/editor
|
329
|
+
# predefinedRoles/admin
|
330
|
+
# predefinedRoles/no-cost-data
|
331
|
+
# predefinedRoles/no-revenue-data
|
225
332
|
#
|
226
333
|
# Excludes roles that are inherited from a higher-level entity, group,
|
227
334
|
# or organization admin role.
|
@@ -244,7 +351,7 @@ module Google
|
|
244
351
|
# @return [::Array<::String>]
|
245
352
|
# Roles directly assigned to this user for this entity.
|
246
353
|
#
|
247
|
-
# Format: predefinedRoles/
|
354
|
+
# Format: predefinedRoles/viewer
|
248
355
|
#
|
249
356
|
# Excludes roles that are inherited from an account (if this is for a
|
250
357
|
# property), group, or organization admin role.
|
@@ -253,72 +360,13 @@ module Google
|
|
253
360
|
# Union of all permissions a user has at this account or property (includes
|
254
361
|
# direct permissions, group-inherited permissions, etc.).
|
255
362
|
#
|
256
|
-
# Format: predefinedRoles/
|
363
|
+
# Format: predefinedRoles/viewer
|
257
364
|
class AuditUserLink
|
258
365
|
include ::Google::Protobuf::MessageExts
|
259
366
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
260
367
|
end
|
261
368
|
|
262
|
-
#
|
263
|
-
# additional site interactions and content.
|
264
|
-
# @!attribute [r] name
|
265
|
-
# @return [::String]
|
266
|
-
# Output only. Resource name of this Data Stream.
|
267
|
-
# Format:
|
268
|
-
# properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
|
269
|
-
# Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
270
|
-
# @!attribute [rw] stream_enabled
|
271
|
-
# @return [::Boolean]
|
272
|
-
# Indicates whether Enhanced Measurement Settings will be used to
|
273
|
-
# automatically measure interactions and content on this web stream.
|
274
|
-
#
|
275
|
-
# Changing this value does not affect the settings themselves, but determines
|
276
|
-
# whether they are respected.
|
277
|
-
# @!attribute [r] page_views_enabled
|
278
|
-
# @return [::Boolean]
|
279
|
-
# Output only. If enabled, capture a page view event each time a page loads or the
|
280
|
-
# website changes the browser history state.
|
281
|
-
# @!attribute [rw] scrolls_enabled
|
282
|
-
# @return [::Boolean]
|
283
|
-
# If enabled, capture scroll events each time a visitor gets to the bottom of
|
284
|
-
# a page.
|
285
|
-
# @!attribute [rw] outbound_clicks_enabled
|
286
|
-
# @return [::Boolean]
|
287
|
-
# If enabled, capture an outbound click event each time a visitor clicks a
|
288
|
-
# link that leads them away from your domain.
|
289
|
-
# @!attribute [rw] site_search_enabled
|
290
|
-
# @return [::Boolean]
|
291
|
-
# If enabled, capture a view search results event each time a visitor
|
292
|
-
# performs a search on your site (based on a query parameter).
|
293
|
-
# @!attribute [rw] video_engagement_enabled
|
294
|
-
# @return [::Boolean]
|
295
|
-
# If enabled, capture video play, progress, and complete events as visitors
|
296
|
-
# view embedded videos on your site.
|
297
|
-
# @!attribute [rw] file_downloads_enabled
|
298
|
-
# @return [::Boolean]
|
299
|
-
# If enabled, capture a file download event each time a link is clicked with
|
300
|
-
# a common document, compressed file, application, video, or audio extension.
|
301
|
-
# @!attribute [r] page_loads_enabled
|
302
|
-
# @return [::Boolean]
|
303
|
-
# Output only. If enabled, capture a page view event each time a page loads.
|
304
|
-
# @!attribute [rw] page_changes_enabled
|
305
|
-
# @return [::Boolean]
|
306
|
-
# If enabled, capture a page view event each time the website changes the
|
307
|
-
# browser history state.
|
308
|
-
# @!attribute [rw] search_query_parameter
|
309
|
-
# @return [::String]
|
310
|
-
# Required. URL query parameters to interpret as site search parameters.
|
311
|
-
# Max length is 1024 characters. Must not be empty.
|
312
|
-
# @!attribute [rw] uri_query_parameter
|
313
|
-
# @return [::String]
|
314
|
-
# Additional URL query parameters.
|
315
|
-
# Max length is 1024 characters.
|
316
|
-
class EnhancedMeasurementSettings
|
317
|
-
include ::Google::Protobuf::MessageExts
|
318
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
319
|
-
end
|
320
|
-
|
321
|
-
# A link between an GA4 property and a Firebase project.
|
369
|
+
# A link between a GA4 property and a Firebase project.
|
322
370
|
# @!attribute [r] name
|
323
371
|
# @return [::String]
|
324
372
|
# Output only. Example format: properties/1234/firebaseLinks/5678
|
@@ -354,7 +402,7 @@ module Google
|
|
354
402
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
355
403
|
end
|
356
404
|
|
357
|
-
# A link between
|
405
|
+
# A link between a GA4 property and a Google Ads account.
|
358
406
|
# @!attribute [r] name
|
359
407
|
# @return [::String]
|
360
408
|
# Output only. Format: properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
|
@@ -441,7 +489,7 @@ module Google
|
|
441
489
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
442
490
|
end
|
443
491
|
|
444
|
-
# A virtual resource representing metadata for
|
492
|
+
# A virtual resource representing metadata for a GA4 property.
|
445
493
|
# @!attribute [rw] property
|
446
494
|
# @return [::String]
|
447
495
|
# Resource name of property referred to by this property summary
|
@@ -449,7 +497,7 @@ module Google
|
|
449
497
|
# Example: "properties/1000"
|
450
498
|
# @!attribute [rw] display_name
|
451
499
|
# @return [::String]
|
452
|
-
# Display name for the property referred to in this
|
500
|
+
# Display name for the property referred to in this property summary.
|
453
501
|
class PropertySummary
|
454
502
|
include ::Google::Protobuf::MessageExts
|
455
503
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -606,7 +654,7 @@ module Google
|
|
606
654
|
# @!attribute [rw] cost_data_sharing_enabled
|
607
655
|
# @return [::Google::Protobuf::BoolValue]
|
608
656
|
# Immutable. Enables the import of cost data from Display & Video 360 into the GA4
|
609
|
-
# property. This can only be enabled if
|
657
|
+
# property. This can only be enabled if campaign_data_sharing_enabled is
|
610
658
|
# enabled. After link creation, this can only be updated from the Display &
|
611
659
|
# Video 360 product.
|
612
660
|
# If this field is not set on create, it will be defaulted to true.
|
@@ -615,7 +663,7 @@ module Google
|
|
615
663
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
616
664
|
end
|
617
665
|
|
618
|
-
# A proposal for a link between
|
666
|
+
# A proposal for a link between a GA4 property and a Display & Video 360
|
619
667
|
# advertiser.
|
620
668
|
#
|
621
669
|
# A proposal is converted to a DisplayVideo360AdvertiserLink once approved.
|
@@ -657,7 +705,7 @@ module Google
|
|
657
705
|
# @!attribute [rw] cost_data_sharing_enabled
|
658
706
|
# @return [::Google::Protobuf::BoolValue]
|
659
707
|
# Immutable. Enables the import of cost data from Display & Video 360.
|
660
|
-
# This can only be enabled if
|
708
|
+
# This can only be enabled if campaign_data_sharing_enabled is enabled.
|
661
709
|
# If this field is not set on create, it will be defaulted to true.
|
662
710
|
class DisplayVideo360AdvertiserLinkProposal
|
663
711
|
include ::Google::Protobuf::MessageExts
|
@@ -1071,6 +1119,12 @@ module Google
|
|
1071
1119
|
|
1072
1120
|
# DataRetentionSettings resource
|
1073
1121
|
DATA_RETENTION_SETTINGS = 13
|
1122
|
+
|
1123
|
+
# DisplayVideo360AdvertiserLink resource
|
1124
|
+
DISPLAY_VIDEO_360_ADVERTISER_LINK = 14
|
1125
|
+
|
1126
|
+
# DisplayVideo360AdvertiserLinkProposal resource
|
1127
|
+
DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15
|
1074
1128
|
end
|
1075
1129
|
|
1076
1130
|
# Status of the Google Signals settings (i.e., whether this feature has been
|