google-analytics-admin-v1alpha 0.16.0 → 0.18.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/README.md +2 -2
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +68 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1266 -210
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +34 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/client.rb +848 -17
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +682 -27
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +32 -0
- data/lib/google/analytics/admin/v1alpha/channel_group_pb.rb +74 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +25 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +217 -11
- data/proto_docs/google/analytics/admin/v1alpha/channel_group.rb +158 -0
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +93 -6
- data/proto_docs/google/api/client.rb +67 -4
- metadata +4 -2
@@ -318,6 +318,16 @@ module Google
|
|
318
318
|
rpc :UpdateExpandedDataSet, ::Google::Analytics::Admin::V1alpha::UpdateExpandedDataSetRequest, ::Google::Analytics::Admin::V1alpha::ExpandedDataSet
|
319
319
|
# Deletes a ExpandedDataSet on a property.
|
320
320
|
rpc :DeleteExpandedDataSet, ::Google::Analytics::Admin::V1alpha::DeleteExpandedDataSetRequest, ::Google::Protobuf::Empty
|
321
|
+
# Lookup for a single ChannelGroup.
|
322
|
+
rpc :GetChannelGroup, ::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest, ::Google::Analytics::Admin::V1alpha::ChannelGroup
|
323
|
+
# Lists ChannelGroups on a property.
|
324
|
+
rpc :ListChannelGroups, ::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest, ::Google::Analytics::Admin::V1alpha::ListChannelGroupsResponse
|
325
|
+
# Creates a ChannelGroup.
|
326
|
+
rpc :CreateChannelGroup, ::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest, ::Google::Analytics::Admin::V1alpha::ChannelGroup
|
327
|
+
# Updates a ChannelGroup.
|
328
|
+
rpc :UpdateChannelGroup, ::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest, ::Google::Analytics::Admin::V1alpha::ChannelGroup
|
329
|
+
# Deletes a ChannelGroup on a property.
|
330
|
+
rpc :DeleteChannelGroup, ::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest, ::Google::Protobuf::Empty
|
321
331
|
# Sets the opt out status for the automated GA4 setup process for a UA
|
322
332
|
# property.
|
323
333
|
# Note: this has no effect on GA4 property.
|
@@ -330,6 +340,28 @@ module Google
|
|
330
340
|
rpc :GetBigQueryLink, ::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest, ::Google::Analytics::Admin::V1alpha::BigQueryLink
|
331
341
|
# Lists BigQuery Links on a property.
|
332
342
|
rpc :ListBigQueryLinks, ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest, ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksResponse
|
343
|
+
# Returns the enhanced measurement settings for this data stream.
|
344
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
345
|
+
# take effect.
|
346
|
+
rpc :GetEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
|
347
|
+
# Updates the enhanced measurement settings for this data stream.
|
348
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
349
|
+
# take effect.
|
350
|
+
rpc :UpdateEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
|
351
|
+
# Creates a connected site tag for a Universal Analytics property. You can
|
352
|
+
# create a maximum of 20 connected site tags per property.
|
353
|
+
# Note: This API cannot be used on GA4 properties.
|
354
|
+
rpc :CreateConnectedSiteTag, ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest, ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse
|
355
|
+
# Deletes a connected site tag for a Universal Analytics property.
|
356
|
+
# Note: this has no effect on GA4 properties.
|
357
|
+
rpc :DeleteConnectedSiteTag, ::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest, ::Google::Protobuf::Empty
|
358
|
+
# Lists the connected site tags for a Universal Analytics property. A maximum
|
359
|
+
# of 20 connected site tags will be returned. Note: this has no effect on GA4
|
360
|
+
# property.
|
361
|
+
rpc :ListConnectedSiteTags, ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest, ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse
|
362
|
+
# Given a specified UA property, looks up the GA4 property connected to it.
|
363
|
+
# Note: this cannot be used with GA4 properties.
|
364
|
+
rpc :FetchConnectedGa4Property, ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest, ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse
|
333
365
|
end
|
334
366
|
|
335
367
|
Stub = Service.rpc_stub_class
|
@@ -0,0 +1,74 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/analytics/admin/v1alpha/channel_group.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/api/field_behavior_pb'
|
7
|
+
require 'google/api/resource_pb'
|
8
|
+
|
9
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
|
+
add_file("google/analytics/admin/v1alpha/channel_group.proto", :syntax => :proto3) do
|
11
|
+
add_message "google.analytics.admin.v1alpha.ChannelGroupFilter" do
|
12
|
+
optional :field_name, :string, 1
|
13
|
+
oneof :value_filter do
|
14
|
+
optional :string_filter, :message, 2, "google.analytics.admin.v1alpha.ChannelGroupFilter.StringFilter"
|
15
|
+
optional :in_list_filter, :message, 3, "google.analytics.admin.v1alpha.ChannelGroupFilter.InListFilter"
|
16
|
+
end
|
17
|
+
end
|
18
|
+
add_message "google.analytics.admin.v1alpha.ChannelGroupFilter.StringFilter" do
|
19
|
+
optional :match_type, :enum, 1, "google.analytics.admin.v1alpha.ChannelGroupFilter.StringFilter.MatchType"
|
20
|
+
optional :value, :string, 2
|
21
|
+
end
|
22
|
+
add_enum "google.analytics.admin.v1alpha.ChannelGroupFilter.StringFilter.MatchType" do
|
23
|
+
value :MATCH_TYPE_UNSPECIFIED, 0
|
24
|
+
value :EXACT, 1
|
25
|
+
value :BEGINS_WITH, 2
|
26
|
+
value :ENDS_WITH, 3
|
27
|
+
value :CONTAINS, 4
|
28
|
+
value :FULL_REGEXP, 5
|
29
|
+
value :PARTIAL_REGEXP, 6
|
30
|
+
end
|
31
|
+
add_message "google.analytics.admin.v1alpha.ChannelGroupFilter.InListFilter" do
|
32
|
+
repeated :values, :string, 1
|
33
|
+
end
|
34
|
+
add_message "google.analytics.admin.v1alpha.ChannelGroupFilterExpression" do
|
35
|
+
oneof :expr do
|
36
|
+
optional :and_group, :message, 1, "google.analytics.admin.v1alpha.ChannelGroupFilterExpressionList"
|
37
|
+
optional :or_group, :message, 2, "google.analytics.admin.v1alpha.ChannelGroupFilterExpressionList"
|
38
|
+
optional :not_expression, :message, 3, "google.analytics.admin.v1alpha.ChannelGroupFilterExpression"
|
39
|
+
optional :filter, :message, 4, "google.analytics.admin.v1alpha.ChannelGroupFilter"
|
40
|
+
end
|
41
|
+
end
|
42
|
+
add_message "google.analytics.admin.v1alpha.ChannelGroupFilterExpressionList" do
|
43
|
+
repeated :filter_expressions, :message, 1, "google.analytics.admin.v1alpha.ChannelGroupFilterExpression"
|
44
|
+
end
|
45
|
+
add_message "google.analytics.admin.v1alpha.GroupingRule" do
|
46
|
+
optional :display_name, :string, 1
|
47
|
+
optional :expression, :message, 2, "google.analytics.admin.v1alpha.ChannelGroupFilterExpression"
|
48
|
+
end
|
49
|
+
add_message "google.analytics.admin.v1alpha.ChannelGroup" do
|
50
|
+
optional :name, :string, 1
|
51
|
+
optional :display_name, :string, 2
|
52
|
+
optional :description, :string, 3
|
53
|
+
repeated :grouping_rule, :message, 4, "google.analytics.admin.v1alpha.GroupingRule"
|
54
|
+
optional :system_defined, :bool, 5
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
module Google
|
60
|
+
module Analytics
|
61
|
+
module Admin
|
62
|
+
module V1alpha
|
63
|
+
ChannelGroupFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChannelGroupFilter").msgclass
|
64
|
+
ChannelGroupFilter::StringFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChannelGroupFilter.StringFilter").msgclass
|
65
|
+
ChannelGroupFilter::StringFilter::MatchType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChannelGroupFilter.StringFilter.MatchType").enummodule
|
66
|
+
ChannelGroupFilter::InListFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChannelGroupFilter.InListFilter").msgclass
|
67
|
+
ChannelGroupFilterExpression = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChannelGroupFilterExpression").msgclass
|
68
|
+
ChannelGroupFilterExpressionList = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChannelGroupFilterExpressionList").msgclass
|
69
|
+
GroupingRule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GroupingRule").msgclass
|
70
|
+
ChannelGroup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChannelGroup").msgclass
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
@@ -3,6 +3,7 @@
|
|
3
3
|
|
4
4
|
require 'google/protobuf'
|
5
5
|
|
6
|
+
require 'google/analytics/admin/v1alpha/channel_group_pb'
|
6
7
|
require 'google/analytics/admin/v1alpha/expanded_data_set_pb'
|
7
8
|
require 'google/api/field_behavior_pb'
|
8
9
|
require 'google/api/resource_pb'
|
@@ -151,7 +152,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
151
152
|
optional :data_stream, :message, 18, "google.analytics.admin.v1alpha.DataStream"
|
152
153
|
optional :attribution_settings, :message, 20, "google.analytics.admin.v1alpha.AttributionSettings"
|
153
154
|
optional :expanded_data_set, :message, 21, "google.analytics.admin.v1alpha.ExpandedDataSet"
|
155
|
+
optional :channel_group, :message, 22, "google.analytics.admin.v1alpha.ChannelGroup"
|
154
156
|
optional :bigquery_link, :message, 23, "google.analytics.admin.v1alpha.BigQueryLink"
|
157
|
+
optional :enhanced_measurement_settings, :message, 24, "google.analytics.admin.v1alpha.EnhancedMeasurementSettings"
|
155
158
|
end
|
156
159
|
end
|
157
160
|
add_message "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink" do
|
@@ -210,6 +213,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
210
213
|
value :DIMENSION_SCOPE_UNSPECIFIED, 0
|
211
214
|
value :EVENT, 1
|
212
215
|
value :USER, 2
|
216
|
+
value :ITEM, 3
|
213
217
|
end
|
214
218
|
add_message "google.analytics.admin.v1alpha.CustomMetric" do
|
215
219
|
optional :name, :string, 1
|
@@ -295,10 +299,28 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
295
299
|
optional :create_time, :message, 3, "google.protobuf.Timestamp"
|
296
300
|
optional :daily_export_enabled, :bool, 4
|
297
301
|
optional :streaming_export_enabled, :bool, 5
|
302
|
+
optional :intraday_export_enabled, :bool, 9
|
298
303
|
optional :include_advertising_id, :bool, 6
|
299
304
|
repeated :export_streams, :string, 7
|
300
305
|
repeated :excluded_events, :string, 8
|
301
306
|
end
|
307
|
+
add_message "google.analytics.admin.v1alpha.EnhancedMeasurementSettings" do
|
308
|
+
optional :name, :string, 1
|
309
|
+
optional :stream_enabled, :bool, 2
|
310
|
+
optional :scrolls_enabled, :bool, 3
|
311
|
+
optional :outbound_clicks_enabled, :bool, 4
|
312
|
+
optional :site_search_enabled, :bool, 5
|
313
|
+
optional :video_engagement_enabled, :bool, 6
|
314
|
+
optional :file_downloads_enabled, :bool, 7
|
315
|
+
optional :page_changes_enabled, :bool, 8
|
316
|
+
optional :form_interactions_enabled, :bool, 9
|
317
|
+
optional :search_query_parameter, :string, 10
|
318
|
+
optional :uri_query_parameter, :string, 11
|
319
|
+
end
|
320
|
+
add_message "google.analytics.admin.v1alpha.ConnectedSiteTag" do
|
321
|
+
optional :display_name, :string, 1
|
322
|
+
optional :tag_id, :string, 2
|
323
|
+
end
|
302
324
|
add_enum "google.analytics.admin.v1alpha.IndustryCategory" do
|
303
325
|
value :INDUSTRY_CATEGORY_UNSPECIFIED, 0
|
304
326
|
value :AUTOMOTIVE, 1
|
@@ -364,6 +386,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
364
386
|
value :ATTRIBUTION_SETTINGS, 20
|
365
387
|
value :EXPANDED_DATA_SET, 21
|
366
388
|
value :CHANNEL_GROUP, 22
|
389
|
+
value :ENHANCED_MEASUREMENT_SETTINGS, 24
|
367
390
|
end
|
368
391
|
add_enum "google.analytics.admin.v1alpha.GoogleSignalsState" do
|
369
392
|
value :GOOGLE_SIGNALS_STATE_UNSPECIFIED, 0
|
@@ -441,6 +464,8 @@ module Google
|
|
441
464
|
AttributionSettings::ReportingAttributionModel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AttributionSettings.ReportingAttributionModel").enummodule
|
442
465
|
AccessBinding = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AccessBinding").msgclass
|
443
466
|
BigQueryLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.BigQueryLink").msgclass
|
467
|
+
EnhancedMeasurementSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.EnhancedMeasurementSettings").msgclass
|
468
|
+
ConnectedSiteTag = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ConnectedSiteTag").msgclass
|
444
469
|
IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
|
445
470
|
ServiceLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ServiceLevel").enummodule
|
446
471
|
ActorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ActorType").enummodule
|
@@ -24,9 +24,14 @@ module Google
|
|
24
24
|
# The request for a Data Access Record Report.
|
25
25
|
# @!attribute [rw] entity
|
26
26
|
# @return [::String]
|
27
|
-
# The Data Access Report
|
28
|
-
#
|
29
|
-
#
|
27
|
+
# The Data Access Report supports requesting at the property level or account
|
28
|
+
# level. If requested at the account level, Data Access Reports include all
|
29
|
+
# access for all properties under that account.
|
30
|
+
#
|
31
|
+
# To request at the property level, entity should be for example
|
32
|
+
# 'properties/123' if "123" is your GA4 property ID. To request at the
|
33
|
+
# account level, entity should be for example 'accounts/1234' if "1234" is
|
34
|
+
# your GA4 Account ID.
|
30
35
|
# @!attribute [rw] dimensions
|
31
36
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension>]
|
32
37
|
# The dimensions requested and displayed in the response. Requests are
|
@@ -92,7 +97,8 @@ module Google
|
|
92
97
|
# @!attribute [rw] return_entity_quota
|
93
98
|
# @return [::Boolean]
|
94
99
|
# Toggles whether to return the current state of this Analytics Property's
|
95
|
-
# quota. Quota is returned in [AccessQuota](#AccessQuota).
|
100
|
+
# quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level
|
101
|
+
# requests, this field must be false.
|
96
102
|
class RunAccessReportRequest
|
97
103
|
include ::Google::Protobuf::MessageExts
|
98
104
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -124,7 +130,8 @@ module Google
|
|
124
130
|
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
125
131
|
# @!attribute [rw] quota
|
126
132
|
# @return [::Google::Analytics::Admin::V1alpha::AccessQuota]
|
127
|
-
# The quota state for this Analytics property including this request.
|
133
|
+
# The quota state for this Analytics property including this request. This
|
134
|
+
# field doesn't work with account-level requests.
|
128
135
|
class RunAccessReportResponse
|
129
136
|
include ::Google::Protobuf::MessageExts
|
130
137
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -211,7 +218,7 @@ module Google
|
|
211
218
|
# @!attribute [rw] redirect_uri
|
212
219
|
# @return [::String]
|
213
220
|
# Redirect URI where the user will be sent after accepting Terms of Service.
|
214
|
-
# Must be configured in
|
221
|
+
# Must be configured in Cloud Console as a Redirect URI.
|
215
222
|
class ProvisionAccountTicketRequest
|
216
223
|
include ::Google::Protobuf::MessageExts
|
217
224
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1755,8 +1762,9 @@ module Google
|
|
1755
1762
|
# @!attribute [rw] parent
|
1756
1763
|
# @return [::String]
|
1757
1764
|
# Required. The account or property that owns the access bindings. The parent
|
1758
|
-
#
|
1759
|
-
# match this field.
|
1765
|
+
# of all provided AccessBinding in UpdateAccessBindingRequest messages must
|
1766
|
+
# match this field.
|
1767
|
+
# Formats:
|
1760
1768
|
# - accounts/\\{account}
|
1761
1769
|
# - properties/\\{property}
|
1762
1770
|
# @!attribute [rw] requests
|
@@ -1792,8 +1800,8 @@ module Google
|
|
1792
1800
|
# @!attribute [rw] parent
|
1793
1801
|
# @return [::String]
|
1794
1802
|
# Required. The account or property that owns the access bindings. The parent
|
1795
|
-
#
|
1796
|
-
# match this field. Formats:
|
1803
|
+
# of all provided values for the 'names' field in DeleteAccessBindingRequest
|
1804
|
+
# messages must match this field. Formats:
|
1797
1805
|
# - accounts/\\{account}
|
1798
1806
|
# - properties/\\{property}
|
1799
1807
|
# @!attribute [rw] requests
|
@@ -1846,7 +1854,7 @@ module Google
|
|
1846
1854
|
# Request message for GetExpandedDataSet RPC.
|
1847
1855
|
# @!attribute [rw] name
|
1848
1856
|
# @return [::String]
|
1849
|
-
# Required. The name of the
|
1857
|
+
# Required. The name of the ExpandedDataSet to get.
|
1850
1858
|
# Example format: properties/1234/expandedDataSets/5678
|
1851
1859
|
class GetExpandedDataSetRequest
|
1852
1860
|
include ::Google::Protobuf::MessageExts
|
@@ -1888,6 +1896,92 @@ module Google
|
|
1888
1896
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1889
1897
|
end
|
1890
1898
|
|
1899
|
+
# Request message for CreateChannelGroup RPC.
|
1900
|
+
# @!attribute [rw] parent
|
1901
|
+
# @return [::String]
|
1902
|
+
# Required. The property for which to create a ChannelGroup.
|
1903
|
+
# Example format: properties/1234
|
1904
|
+
# @!attribute [rw] channel_group
|
1905
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
1906
|
+
# Required. The ChannelGroup to create.
|
1907
|
+
class CreateChannelGroupRequest
|
1908
|
+
include ::Google::Protobuf::MessageExts
|
1909
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1910
|
+
end
|
1911
|
+
|
1912
|
+
# Request message for UpdateChannelGroup RPC.
|
1913
|
+
# @!attribute [rw] channel_group
|
1914
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
1915
|
+
# Required. The ChannelGroup to update.
|
1916
|
+
# The resource's `name` field is used to identify the ChannelGroup to be
|
1917
|
+
# updated.
|
1918
|
+
# @!attribute [rw] update_mask
|
1919
|
+
# @return [::Google::Protobuf::FieldMask]
|
1920
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
1921
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
1922
|
+
# replace the entire entity, use one path with the string "*" to match all
|
1923
|
+
# fields.
|
1924
|
+
class UpdateChannelGroupRequest
|
1925
|
+
include ::Google::Protobuf::MessageExts
|
1926
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1927
|
+
end
|
1928
|
+
|
1929
|
+
# Request message for DeleteChannelGroup RPC.
|
1930
|
+
# @!attribute [rw] name
|
1931
|
+
# @return [::String]
|
1932
|
+
# Required. The ChannelGroup to delete.
|
1933
|
+
# Example format: properties/1234/channelGroups/5678
|
1934
|
+
class DeleteChannelGroupRequest
|
1935
|
+
include ::Google::Protobuf::MessageExts
|
1936
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1937
|
+
end
|
1938
|
+
|
1939
|
+
# Request message for GetChannelGroup RPC.
|
1940
|
+
# @!attribute [rw] name
|
1941
|
+
# @return [::String]
|
1942
|
+
# Required. The ChannelGroup to get.
|
1943
|
+
# Example format: properties/1234/channelGroups/5678
|
1944
|
+
class GetChannelGroupRequest
|
1945
|
+
include ::Google::Protobuf::MessageExts
|
1946
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1947
|
+
end
|
1948
|
+
|
1949
|
+
# Request message for ListChannelGroups RPC.
|
1950
|
+
# @!attribute [rw] parent
|
1951
|
+
# @return [::String]
|
1952
|
+
# Required. The property for which to list ChannelGroups.
|
1953
|
+
# Example format: properties/1234
|
1954
|
+
# @!attribute [rw] page_size
|
1955
|
+
# @return [::Integer]
|
1956
|
+
# The maximum number of resources to return.
|
1957
|
+
# If unspecified, at most 50 resources will be returned.
|
1958
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
1959
|
+
# @!attribute [rw] page_token
|
1960
|
+
# @return [::String]
|
1961
|
+
# A page token, received from a previous `ListChannelGroups` call. Provide
|
1962
|
+
# this to retrieve the subsequent page.
|
1963
|
+
#
|
1964
|
+
# When paginating, all other parameters provided to `ListChannelGroups`
|
1965
|
+
# must match the call that provided the page token.
|
1966
|
+
class ListChannelGroupsRequest
|
1967
|
+
include ::Google::Protobuf::MessageExts
|
1968
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1969
|
+
end
|
1970
|
+
|
1971
|
+
# Response message for ListChannelGroups RPC.
|
1972
|
+
# @!attribute [rw] channel_groups
|
1973
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
1974
|
+
# List of ChannelGroup. These will be ordered stably, but in an arbitrary
|
1975
|
+
# order.
|
1976
|
+
# @!attribute [rw] next_page_token
|
1977
|
+
# @return [::String]
|
1978
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1979
|
+
# If this field is omitted, there are no subsequent pages.
|
1980
|
+
class ListChannelGroupsResponse
|
1981
|
+
include ::Google::Protobuf::MessageExts
|
1982
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1983
|
+
end
|
1984
|
+
|
1891
1985
|
# Request for setting the opt out status for the automated GA4 setup process.
|
1892
1986
|
# @!attribute [rw] property
|
1893
1987
|
# @return [::String]
|
@@ -1978,6 +2072,118 @@ module Google
|
|
1978
2072
|
include ::Google::Protobuf::MessageExts
|
1979
2073
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1980
2074
|
end
|
2075
|
+
|
2076
|
+
# Request message for GetEnhancedMeasurementSettings RPC.
|
2077
|
+
# @!attribute [rw] name
|
2078
|
+
# @return [::String]
|
2079
|
+
# Required. The name of the settings to lookup.
|
2080
|
+
# Format:
|
2081
|
+
# properties/\\{property}/dataStreams/\\{data_stream}/enhancedMeasurementSettings
|
2082
|
+
# Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
2083
|
+
class GetEnhancedMeasurementSettingsRequest
|
2084
|
+
include ::Google::Protobuf::MessageExts
|
2085
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2086
|
+
end
|
2087
|
+
|
2088
|
+
# Request message for UpdateEnhancedMeasurementSettings RPC.
|
2089
|
+
# @!attribute [rw] enhanced_measurement_settings
|
2090
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
2091
|
+
# Required. The settings to update.
|
2092
|
+
# The `name` field is used to identify the settings to be updated.
|
2093
|
+
# @!attribute [rw] update_mask
|
2094
|
+
# @return [::Google::Protobuf::FieldMask]
|
2095
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
2096
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
2097
|
+
# replace the entire entity, use one path with the string "*" to match all
|
2098
|
+
# fields.
|
2099
|
+
class UpdateEnhancedMeasurementSettingsRequest
|
2100
|
+
include ::Google::Protobuf::MessageExts
|
2101
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2102
|
+
end
|
2103
|
+
|
2104
|
+
# Request message for CreateConnectedSiteTag RPC.
|
2105
|
+
# @!attribute [rw] property
|
2106
|
+
# @return [::String]
|
2107
|
+
# The Universal Analytics property to create connected site tags for.
|
2108
|
+
# This API does not support GA4 properties.
|
2109
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
2110
|
+
# Example: properties/1234
|
2111
|
+
# @!attribute [rw] connected_site_tag
|
2112
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConnectedSiteTag]
|
2113
|
+
# Required. The tag to add to the Universal Analytics property
|
2114
|
+
class CreateConnectedSiteTagRequest
|
2115
|
+
include ::Google::Protobuf::MessageExts
|
2116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2117
|
+
end
|
2118
|
+
|
2119
|
+
# Response message for CreateConnectedSiteTag RPC.
|
2120
|
+
class CreateConnectedSiteTagResponse
|
2121
|
+
include ::Google::Protobuf::MessageExts
|
2122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2123
|
+
end
|
2124
|
+
|
2125
|
+
# Request message for DeleteConnectedSiteTag RPC.
|
2126
|
+
# @!attribute [rw] property
|
2127
|
+
# @return [::String]
|
2128
|
+
# The Universal Analytics property to delete connected site tags for.
|
2129
|
+
# This API does not support GA4 properties.
|
2130
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
2131
|
+
# Example: properties/1234
|
2132
|
+
# @!attribute [rw] tag_id
|
2133
|
+
# @return [::String]
|
2134
|
+
# Tag ID to forward events to. Also known as the Measurement ID, or the
|
2135
|
+
# "G-ID" (For example: G-12345).
|
2136
|
+
class DeleteConnectedSiteTagRequest
|
2137
|
+
include ::Google::Protobuf::MessageExts
|
2138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2139
|
+
end
|
2140
|
+
|
2141
|
+
# Request message for ListConnectedSiteTags RPC.
|
2142
|
+
# @!attribute [rw] property
|
2143
|
+
# @return [::String]
|
2144
|
+
# The Universal Analytics property to fetch connected site tags for.
|
2145
|
+
# This does not work on GA4 properties. A maximum of 20 connected site tags
|
2146
|
+
# will be returned.
|
2147
|
+
# Example Format: `properties/1234`
|
2148
|
+
class ListConnectedSiteTagsRequest
|
2149
|
+
include ::Google::Protobuf::MessageExts
|
2150
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2151
|
+
end
|
2152
|
+
|
2153
|
+
# Response message for ListConnectedSiteTags RPC.
|
2154
|
+
# @!attribute [rw] connected_site_tags
|
2155
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ConnectedSiteTag>]
|
2156
|
+
# The site tags for the Universal Analytics property. A maximum of 20
|
2157
|
+
# connected site tags will be returned.
|
2158
|
+
class ListConnectedSiteTagsResponse
|
2159
|
+
include ::Google::Protobuf::MessageExts
|
2160
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2161
|
+
end
|
2162
|
+
|
2163
|
+
# Request for looking up GA4 property connected to a UA property.
|
2164
|
+
# @!attribute [rw] property
|
2165
|
+
# @return [::String]
|
2166
|
+
# Required. The UA property for which to look up the connected GA4 property.
|
2167
|
+
# Note this request uses the
|
2168
|
+
# internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
2169
|
+
# Format: properties/\\{internal_web_property_id}
|
2170
|
+
# Example: properties/1234
|
2171
|
+
class FetchConnectedGa4PropertyRequest
|
2172
|
+
include ::Google::Protobuf::MessageExts
|
2173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2174
|
+
end
|
2175
|
+
|
2176
|
+
# Response for looking up GA4 property connected to a UA property.
|
2177
|
+
# @!attribute [rw] property
|
2178
|
+
# @return [::String]
|
2179
|
+
# The GA4 property connected to the UA property. An empty string is returned
|
2180
|
+
# when there is no connected GA4 property.
|
2181
|
+
# Format: properties/\\{property_id}
|
2182
|
+
# Example: properties/1234
|
2183
|
+
class FetchConnectedGa4PropertyResponse
|
2184
|
+
include ::Google::Protobuf::MessageExts
|
2185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2186
|
+
end
|
1981
2187
|
end
|
1982
2188
|
end
|
1983
2189
|
end
|
@@ -0,0 +1,158 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Analytics
|
22
|
+
module Admin
|
23
|
+
module V1alpha
|
24
|
+
# A specific filter for a single dimension.
|
25
|
+
# @!attribute [rw] string_filter
|
26
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter::StringFilter]
|
27
|
+
# A filter for a string-type dimension that matches a particular pattern.
|
28
|
+
# @!attribute [rw] in_list_filter
|
29
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter::InListFilter]
|
30
|
+
# A filter for a string dimension that matches a particular list of
|
31
|
+
# options.
|
32
|
+
# @!attribute [rw] field_name
|
33
|
+
# @return [::String]
|
34
|
+
# Required. Immutable. The dimension name to filter.
|
35
|
+
class ChannelGroupFilter
|
36
|
+
include ::Google::Protobuf::MessageExts
|
37
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
38
|
+
|
39
|
+
# Filter where the field value is a String. The match is case insensitive.
|
40
|
+
# @!attribute [rw] match_type
|
41
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter::StringFilter::MatchType]
|
42
|
+
# Required. The match type for the string filter.
|
43
|
+
# @!attribute [rw] value
|
44
|
+
# @return [::String]
|
45
|
+
# Required. The string value to be matched against.
|
46
|
+
class StringFilter
|
47
|
+
include ::Google::Protobuf::MessageExts
|
48
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
49
|
+
|
50
|
+
# How the filter will be used to determine a match.
|
51
|
+
module MatchType
|
52
|
+
# Default match type.
|
53
|
+
MATCH_TYPE_UNSPECIFIED = 0
|
54
|
+
|
55
|
+
# Exact match of the string value.
|
56
|
+
EXACT = 1
|
57
|
+
|
58
|
+
# Begins with the string value.
|
59
|
+
BEGINS_WITH = 2
|
60
|
+
|
61
|
+
# Ends with the string value.
|
62
|
+
ENDS_WITH = 3
|
63
|
+
|
64
|
+
# Contains the string value.
|
65
|
+
CONTAINS = 4
|
66
|
+
|
67
|
+
# Full regular expression match with the string value.
|
68
|
+
FULL_REGEXP = 5
|
69
|
+
|
70
|
+
# Partial regular expression match with the string value.
|
71
|
+
PARTIAL_REGEXP = 6
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
# A filter for a string dimension that matches a particular list of options.
|
76
|
+
# The match is case insensitive.
|
77
|
+
# @!attribute [rw] values
|
78
|
+
# @return [::Array<::String>]
|
79
|
+
# Required. The list of possible string values to match against. Must be
|
80
|
+
# non-empty.
|
81
|
+
class InListFilter
|
82
|
+
include ::Google::Protobuf::MessageExts
|
83
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# A logical expression of Channel Group dimension filters.
|
88
|
+
# @!attribute [rw] and_group
|
89
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpressionList]
|
90
|
+
# A list of expressions to be AND’ed together. It can only contain
|
91
|
+
# ChannelGroupFilterExpressions with or_group. This must be set for the
|
92
|
+
# top level ChannelGroupFilterExpression.
|
93
|
+
# @!attribute [rw] or_group
|
94
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpressionList]
|
95
|
+
# A list of expressions to OR’ed together. It cannot contain
|
96
|
+
# ChannelGroupFilterExpressions with and_group or or_group.
|
97
|
+
# @!attribute [rw] not_expression
|
98
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpression]
|
99
|
+
# A filter expression to be NOT'ed (that is inverted, complemented). It
|
100
|
+
# can only include a dimension_or_metric_filter. This cannot be set on the
|
101
|
+
# top level ChannelGroupFilterExpression.
|
102
|
+
# @!attribute [rw] filter
|
103
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilter]
|
104
|
+
# A filter on a single dimension. This cannot be set on the top
|
105
|
+
# level ChannelGroupFilterExpression.
|
106
|
+
class ChannelGroupFilterExpression
|
107
|
+
include ::Google::Protobuf::MessageExts
|
108
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
109
|
+
end
|
110
|
+
|
111
|
+
# A list of Channel Group filter expressions.
|
112
|
+
# @!attribute [rw] filter_expressions
|
113
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpression>]
|
114
|
+
# A list of Channel Group filter expressions.
|
115
|
+
class ChannelGroupFilterExpressionList
|
116
|
+
include ::Google::Protobuf::MessageExts
|
117
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
118
|
+
end
|
119
|
+
|
120
|
+
# The rules that govern how traffic is grouped into one channel.
|
121
|
+
# @!attribute [rw] display_name
|
122
|
+
# @return [::String]
|
123
|
+
# Required. Customer defined display name for the channel.
|
124
|
+
# @!attribute [rw] expression
|
125
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroupFilterExpression]
|
126
|
+
# Required. The Filter Expression that defines the Grouping Rule.
|
127
|
+
class GroupingRule
|
128
|
+
include ::Google::Protobuf::MessageExts
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
130
|
+
end
|
131
|
+
|
132
|
+
# A resource message representing a Channel Group.
|
133
|
+
# @!attribute [r] name
|
134
|
+
# @return [::String]
|
135
|
+
# Output only. The resource name for this Channel Group resource.
|
136
|
+
# Format: properties/\\{property}/channelGroups/\\{channel_group}
|
137
|
+
# @!attribute [rw] display_name
|
138
|
+
# @return [::String]
|
139
|
+
# Required. The display name of the Channel Group. Max length of 80
|
140
|
+
# characters.
|
141
|
+
# @!attribute [rw] description
|
142
|
+
# @return [::String]
|
143
|
+
# The description of the Channel Group. Max length of 256 characters.
|
144
|
+
# @!attribute [rw] grouping_rule
|
145
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::GroupingRule>]
|
146
|
+
# Required. The grouping rules of channels. Maximum number of rules is 25.
|
147
|
+
# @!attribute [r] system_defined
|
148
|
+
# @return [::Boolean]
|
149
|
+
# Output only. Default Channel Group defined by Google, which cannot be
|
150
|
+
# updated.
|
151
|
+
class ChannelGroup
|
152
|
+
include ::Google::Protobuf::MessageExts
|
153
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
154
|
+
end
|
155
|
+
end
|
156
|
+
end
|
157
|
+
end
|
158
|
+
end
|
@@ -91,7 +91,7 @@ module Google
|
|
91
91
|
# ExpandedDataSetFilterExpression.
|
92
92
|
# @!attribute [rw] not_expression
|
93
93
|
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
|
94
|
-
# A filter expression to be NOT'ed (
|
94
|
+
# A filter expression to be NOT'ed (that is, inverted, complemented). It
|
95
95
|
# must include a dimension_filter. This cannot be set on the
|
96
96
|
# top level ExpandedDataSetFilterExpression.
|
97
97
|
# @!attribute [rw] filter
|
@@ -141,7 +141,7 @@ module Google
|
|
141
141
|
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
|
142
142
|
# Immutable. A logical expression of ExpandedDataSet filters applied to
|
143
143
|
# dimension included in the ExpandedDataSet. This filter is used to reduce
|
144
|
-
# the number of rows and thus the
|
144
|
+
# the number of rows and thus the chance of encountering `other` row.
|
145
145
|
# @!attribute [r] data_collection_start_time
|
146
146
|
# @return [::Google::Protobuf::Timestamp]
|
147
147
|
# Output only. Time when expanded data set began (or will begin) collecing
|