google-analytics-admin-v1alpha 0.13.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +1 -1
- data/lib/google/analytics/admin/v1alpha/access_report_pb.rb +1 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +60 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1186 -247
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +34 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +25 -1
- data/lib/google/analytics/admin/v1alpha/audience_pb.rb +0 -3
- data/lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb +69 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +27 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/lib/google/analytics/admin/v1alpha.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/access_report.rb +8 -2
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +237 -55
- data/proto_docs/google/analytics/admin/v1alpha/audience.rb +32 -39
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +156 -0
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +164 -63
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- metadata +9 -5
|
@@ -0,0 +1,156 @@
|
|
|
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::ExpandedDataSetFilter::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::ExpandedDataSetFilter::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. The dimension name to filter.
|
|
35
|
+
class ExpandedDataSetFilter
|
|
36
|
+
include ::Google::Protobuf::MessageExts
|
|
37
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
38
|
+
|
|
39
|
+
# A filter for a string-type dimension that matches a particular pattern.
|
|
40
|
+
# @!attribute [rw] match_type
|
|
41
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter::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
|
+
# @!attribute [rw] case_sensitive
|
|
47
|
+
# @return [::Boolean]
|
|
48
|
+
# Optional. If true, the match is case-sensitive. If false, the match is
|
|
49
|
+
# case-insensitive.
|
|
50
|
+
# Must be true when match_type is EXACT.
|
|
51
|
+
# Must be false when match_type is CONTAINS.
|
|
52
|
+
class StringFilter
|
|
53
|
+
include ::Google::Protobuf::MessageExts
|
|
54
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
55
|
+
|
|
56
|
+
# The match type for the string filter.
|
|
57
|
+
module MatchType
|
|
58
|
+
# Unspecified
|
|
59
|
+
MATCH_TYPE_UNSPECIFIED = 0
|
|
60
|
+
|
|
61
|
+
# Exact match of the string value.
|
|
62
|
+
EXACT = 1
|
|
63
|
+
|
|
64
|
+
# Contains the string value.
|
|
65
|
+
CONTAINS = 2
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# A filter for a string dimension that matches a particular list of options.
|
|
70
|
+
# @!attribute [rw] values
|
|
71
|
+
# @return [::Array<::String>]
|
|
72
|
+
# Required. The list of possible string values to match against. Must be
|
|
73
|
+
# non-empty.
|
|
74
|
+
# @!attribute [rw] case_sensitive
|
|
75
|
+
# @return [::Boolean]
|
|
76
|
+
# Optional. If true, the match is case-sensitive. If false, the match is
|
|
77
|
+
# case-insensitive.
|
|
78
|
+
# Must be true.
|
|
79
|
+
class InListFilter
|
|
80
|
+
include ::Google::Protobuf::MessageExts
|
|
81
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# A logical expression of EnhancedDataSet dimension filters.
|
|
86
|
+
# @!attribute [rw] and_group
|
|
87
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpressionList]
|
|
88
|
+
# A list of expressions to be AND’ed together. It must contain a
|
|
89
|
+
# ExpandedDataSetFilterExpression with either not_expression or
|
|
90
|
+
# dimension_filter. This must be set for the top level
|
|
91
|
+
# ExpandedDataSetFilterExpression.
|
|
92
|
+
# @!attribute [rw] not_expression
|
|
93
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
|
|
94
|
+
# A filter expression to be NOT'ed (i.e., inverted, complemented). It
|
|
95
|
+
# must include a dimension_filter. This cannot be set on the
|
|
96
|
+
# top level ExpandedDataSetFilterExpression.
|
|
97
|
+
# @!attribute [rw] filter
|
|
98
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilter]
|
|
99
|
+
# A filter on a single dimension. This cannot be set on the top
|
|
100
|
+
# level ExpandedDataSetFilterExpression.
|
|
101
|
+
class ExpandedDataSetFilterExpression
|
|
102
|
+
include ::Google::Protobuf::MessageExts
|
|
103
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# A list of ExpandedDataSet filter expressions.
|
|
107
|
+
# @!attribute [rw] filter_expressions
|
|
108
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression>]
|
|
109
|
+
# A list of ExpandedDataSet filter expressions.
|
|
110
|
+
class ExpandedDataSetFilterExpressionList
|
|
111
|
+
include ::Google::Protobuf::MessageExts
|
|
112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# A resource message representing a GA4 ExpandedDataSet.
|
|
116
|
+
# @!attribute [r] name
|
|
117
|
+
# @return [::String]
|
|
118
|
+
# Output only. The resource name for this ExpandedDataSet resource.
|
|
119
|
+
# Format: properties/\\{property_id}/expandedDataSets/\\{expanded_data_set}
|
|
120
|
+
# @!attribute [rw] display_name
|
|
121
|
+
# @return [::String]
|
|
122
|
+
# Required. The display name of the ExpandedDataSet.
|
|
123
|
+
# Max 200 chars.
|
|
124
|
+
# @!attribute [rw] description
|
|
125
|
+
# @return [::String]
|
|
126
|
+
# Optional. The description of the ExpandedDataSet.
|
|
127
|
+
# Max 50 chars.
|
|
128
|
+
# @!attribute [rw] dimension_names
|
|
129
|
+
# @return [::Array<::String>]
|
|
130
|
+
# Immutable. The list of dimensions included in the ExpandedDataSet.
|
|
131
|
+
# See the [API
|
|
132
|
+
# Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
|
|
133
|
+
# for the list of dimension names.
|
|
134
|
+
# @!attribute [rw] metric_names
|
|
135
|
+
# @return [::Array<::String>]
|
|
136
|
+
# Immutable. The list of metrics included in the ExpandedDataSet.
|
|
137
|
+
# See the [API
|
|
138
|
+
# Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
|
|
139
|
+
# for the list of dimension names.
|
|
140
|
+
# @!attribute [rw] dimension_filter_expression
|
|
141
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSetFilterExpression]
|
|
142
|
+
# Immutable. A logical expression of ExpandedDataSet filters applied to
|
|
143
|
+
# dimension included in the ExpandedDataSet. This filter is used to reduce
|
|
144
|
+
# the number of rows and thus the change of encountering `other row`.
|
|
145
|
+
# @!attribute [r] data_collection_start_time
|
|
146
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
147
|
+
# Output only. Time when expanded data set began (or will begin) collecing
|
|
148
|
+
# data.
|
|
149
|
+
class ExpandedDataSet
|
|
150
|
+
include ::Google::Protobuf::MessageExts
|
|
151
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
152
|
+
end
|
|
153
|
+
end
|
|
154
|
+
end
|
|
155
|
+
end
|
|
156
|
+
end
|
|
@@ -56,10 +56,10 @@ module Google
|
|
|
56
56
|
# Example: "properties/1000"
|
|
57
57
|
# @!attribute [rw] property_type
|
|
58
58
|
# @return [::Google::Analytics::Admin::V1alpha::PropertyType]
|
|
59
|
-
# Immutable. The property type for this Property resource. When creating a
|
|
60
|
-
# the type is "PROPERTY_TYPE_UNSPECIFIED", then
|
|
61
|
-
# implied. "SUBPROPERTY" and "ROLLUP_PROPERTY"
|
|
62
|
-
# via Google Analytics Admin API.
|
|
59
|
+
# Immutable. The property type for this Property resource. When creating a
|
|
60
|
+
# property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then
|
|
61
|
+
# "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY"
|
|
62
|
+
# types cannot yet be created via Google Analytics Admin API.
|
|
63
63
|
# @!attribute [r] create_time
|
|
64
64
|
# @return [::Google::Protobuf::Timestamp]
|
|
65
65
|
# Output only. Time when the entity was originally created.
|
|
@@ -84,9 +84,9 @@ module Google
|
|
|
84
84
|
# Example: AUTOMOTIVE, FOOD_AND_DRINK
|
|
85
85
|
# @!attribute [rw] time_zone
|
|
86
86
|
# @return [::String]
|
|
87
|
-
# Required. Reporting Time Zone, used as the day boundary for reports,
|
|
88
|
-
# where the data originates. If the time zone honors DST,
|
|
89
|
-
# automatically adjust for the changes.
|
|
87
|
+
# Required. Reporting Time Zone, used as the day boundary for reports,
|
|
88
|
+
# regardless of where the data originates. If the time zone honors DST,
|
|
89
|
+
# Analytics will automatically adjust for the changes.
|
|
90
90
|
#
|
|
91
91
|
# NOTE: Changing the time zone only affects data going forward, and is not
|
|
92
92
|
# applied retroactively.
|
|
@@ -102,16 +102,17 @@ module Google
|
|
|
102
102
|
# Examples: "USD", "EUR", "JPY"
|
|
103
103
|
# @!attribute [r] service_level
|
|
104
104
|
# @return [::Google::Analytics::Admin::V1alpha::ServiceLevel]
|
|
105
|
-
# Output only. The Google Analytics service level that applies to this
|
|
105
|
+
# Output only. The Google Analytics service level that applies to this
|
|
106
|
+
# property.
|
|
106
107
|
# @!attribute [r] delete_time
|
|
107
108
|
# @return [::Google::Protobuf::Timestamp]
|
|
108
|
-
# Output only. If set, the time at which this property was trashed. If not
|
|
109
|
-
# property is not currently in the trash can.
|
|
109
|
+
# Output only. If set, the time at which this property was trashed. If not
|
|
110
|
+
# set, then this property is not currently in the trash can.
|
|
110
111
|
# @!attribute [r] expire_time
|
|
111
112
|
# @return [::Google::Protobuf::Timestamp]
|
|
112
|
-
# Output only. If set, the time at which this trashed property will be
|
|
113
|
-
# deleted. If not set, then this property is not currently in the
|
|
114
|
-
# and is not slated to be deleted.
|
|
113
|
+
# Output only. If set, the time at which this trashed property will be
|
|
114
|
+
# permanently deleted. If not set, then this property is not currently in the
|
|
115
|
+
# trash can and is not slated to be deleted.
|
|
115
116
|
# @!attribute [rw] account
|
|
116
117
|
# @return [::String]
|
|
117
118
|
# Immutable. The resource name of the parent account
|
|
@@ -284,9 +285,9 @@ module Google
|
|
|
284
285
|
# Output only. Example format: properties/1234/firebaseLinks/5678
|
|
285
286
|
# @!attribute [rw] project
|
|
286
287
|
# @return [::String]
|
|
287
|
-
# Immutable. Firebase project resource name. When creating a FirebaseLink,
|
|
288
|
-
# provide this resource name using either a project number or project
|
|
289
|
-
# Once this resource has been created, returned FirebaseLinks will always
|
|
288
|
+
# Immutable. Firebase project resource name. When creating a FirebaseLink,
|
|
289
|
+
# you may provide this resource name using either a project number or project
|
|
290
|
+
# ID. Once this resource has been created, returned FirebaseLinks will always
|
|
290
291
|
# have a project_name that contains a project number.
|
|
291
292
|
#
|
|
292
293
|
# Format: 'projects/\\{project number}'
|
|
@@ -308,8 +309,8 @@ module Google
|
|
|
308
309
|
# Example: "properties/123/dataStreams/456/globalSiteTag"
|
|
309
310
|
# @!attribute [rw] snippet
|
|
310
311
|
# @return [::String]
|
|
311
|
-
# Immutable. JavaScript code snippet to be pasted as the first item into the
|
|
312
|
-
# every webpage to measure.
|
|
312
|
+
# Immutable. JavaScript code snippet to be pasted as the first item into the
|
|
313
|
+
# head tag of every webpage to measure.
|
|
313
314
|
class GlobalSiteTag
|
|
314
315
|
include ::Google::Protobuf::MessageExts
|
|
315
316
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -318,7 +319,8 @@ module Google
|
|
|
318
319
|
# A link between a GA4 property and a Google Ads account.
|
|
319
320
|
# @!attribute [r] name
|
|
320
321
|
# @return [::String]
|
|
321
|
-
# Output only. Format:
|
|
322
|
+
# Output only. Format:
|
|
323
|
+
# properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
|
|
322
324
|
#
|
|
323
325
|
# Note: googleAdsLinkId is not the Google Ads customer ID.
|
|
324
326
|
# @!attribute [rw] customer_id
|
|
@@ -429,17 +431,16 @@ module Google
|
|
|
429
431
|
# A secret value used for sending hits to Measurement Protocol.
|
|
430
432
|
# @!attribute [r] name
|
|
431
433
|
# @return [::String]
|
|
432
|
-
# Output only. Resource name of this secret. This secret may be a child of
|
|
433
|
-
# stream.
|
|
434
|
-
# Format:
|
|
434
|
+
# Output only. Resource name of this secret. This secret may be a child of
|
|
435
|
+
# any type of stream. Format:
|
|
435
436
|
# properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
|
436
437
|
# @!attribute [rw] display_name
|
|
437
438
|
# @return [::String]
|
|
438
439
|
# Required. Human-readable display name for this secret.
|
|
439
440
|
# @!attribute [r] secret_value
|
|
440
441
|
# @return [::String]
|
|
441
|
-
# Output only. The measurement protocol secret value. Pass this value to the
|
|
442
|
-
# field of the Measurement Protocol API when sending hits to this
|
|
442
|
+
# Output only. The measurement protocol secret value. Pass this value to the
|
|
443
|
+
# api_secret field of the Measurement Protocol API when sending hits to this
|
|
443
444
|
# secret's parent property.
|
|
444
445
|
class MeasurementProtocolSecret
|
|
445
446
|
include ::Google::Protobuf::MessageExts
|
|
@@ -536,12 +537,21 @@ module Google
|
|
|
536
537
|
# @!attribute [rw] data_retention_settings
|
|
537
538
|
# @return [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
|
|
538
539
|
# A snapshot of a data retention settings resource in change history.
|
|
540
|
+
# @!attribute [rw] search_ads_360_link
|
|
541
|
+
# @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
|
542
|
+
# A snapshot of a SearchAds360Link resource in change history.
|
|
539
543
|
# @!attribute [rw] data_stream
|
|
540
544
|
# @return [::Google::Analytics::Admin::V1alpha::DataStream]
|
|
541
545
|
# A snapshot of a DataStream resource in change history.
|
|
542
546
|
# @!attribute [rw] attribution_settings
|
|
543
547
|
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
|
|
544
548
|
# A snapshot of AttributionSettings resource in change history.
|
|
549
|
+
# @!attribute [rw] expanded_data_set
|
|
550
|
+
# @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
|
|
551
|
+
# A snapshot of an ExpandedDataSet resource in change history.
|
|
552
|
+
# @!attribute [rw] bigquery_link
|
|
553
|
+
# @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
|
554
|
+
# A snapshot of a BigQuery link resource in change history.
|
|
545
555
|
class ChangeHistoryResource
|
|
546
556
|
include ::Google::Protobuf::MessageExts
|
|
547
557
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -551,8 +561,9 @@ module Google
|
|
|
551
561
|
# A link between a GA4 property and a Display & Video 360 advertiser.
|
|
552
562
|
# @!attribute [r] name
|
|
553
563
|
# @return [::String]
|
|
554
|
-
# Output only. The resource name for this DisplayVideo360AdvertiserLink
|
|
555
|
-
# Format:
|
|
564
|
+
# Output only. The resource name for this DisplayVideo360AdvertiserLink
|
|
565
|
+
# resource. Format:
|
|
566
|
+
# properties/\\{propertyId}/displayVideo360AdvertiserLinks/\\{linkId}
|
|
556
567
|
#
|
|
557
568
|
# Note: linkId is not the Display & Video 360 Advertiser ID
|
|
558
569
|
# @!attribute [rw] advertiser_id
|
|
@@ -567,17 +578,17 @@ module Google
|
|
|
567
578
|
# If this field is not set on create/update, it will be defaulted to true.
|
|
568
579
|
# @!attribute [rw] campaign_data_sharing_enabled
|
|
569
580
|
# @return [::Google::Protobuf::BoolValue]
|
|
570
|
-
# Immutable. Enables the import of campaign data from Display & Video 360
|
|
571
|
-
# property. After link creation, this can only be updated from
|
|
572
|
-
# Video 360 product.
|
|
573
|
-
#
|
|
581
|
+
# Immutable. Enables the import of campaign data from Display & Video 360
|
|
582
|
+
# into the GA4 property. After link creation, this can only be updated from
|
|
583
|
+
# the Display & Video 360 product. If this field is not set on create, it
|
|
584
|
+
# will be defaulted to true.
|
|
574
585
|
# @!attribute [rw] cost_data_sharing_enabled
|
|
575
586
|
# @return [::Google::Protobuf::BoolValue]
|
|
576
|
-
# Immutable. Enables the import of cost data from Display & Video 360 into
|
|
577
|
-
# property. This can only be enabled if campaign_data_sharing_enabled
|
|
578
|
-
# enabled. After link creation, this can only be updated from the Display
|
|
579
|
-
# Video 360 product.
|
|
580
|
-
#
|
|
587
|
+
# Immutable. Enables the import of cost data from Display & Video 360 into
|
|
588
|
+
# the GA4 property. This can only be enabled if campaign_data_sharing_enabled
|
|
589
|
+
# is enabled. After link creation, this can only be updated from the Display
|
|
590
|
+
# & Video 360 product. If this field is not set on create, it will be
|
|
591
|
+
# defaulted to true.
|
|
581
592
|
class DisplayVideo360AdvertiserLink
|
|
582
593
|
include ::Google::Protobuf::MessageExts
|
|
583
594
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -591,8 +602,8 @@ module Google
|
|
|
591
602
|
# admins approve outbound proposals.
|
|
592
603
|
# @!attribute [r] name
|
|
593
604
|
# @return [::String]
|
|
594
|
-
# Output only. The resource name for this
|
|
595
|
-
# Format:
|
|
605
|
+
# Output only. The resource name for this
|
|
606
|
+
# DisplayVideo360AdvertiserLinkProposal resource. Format:
|
|
596
607
|
# properties/\\{propertyId}/displayVideo360AdvertiserLinkProposals/\\{proposalId}
|
|
597
608
|
#
|
|
598
609
|
# Note: proposalId is not the Display & Video 360 Advertiser ID
|
|
@@ -608,12 +619,12 @@ module Google
|
|
|
608
619
|
# Only populated for proposals that originated from Display & Video 360.
|
|
609
620
|
# @!attribute [rw] validation_email
|
|
610
621
|
# @return [::String]
|
|
611
|
-
# Input only. On a proposal being sent to Display & Video 360, this field
|
|
612
|
-
# the email address of an admin on the target advertiser. This
|
|
613
|
-
# verify that the Google Analytics admin is aware of at least one
|
|
614
|
-
# the Display & Video 360 Advertiser. This does not restrict
|
|
615
|
-
# proposal to a single user. Any admin on the Display & Video
|
|
616
|
-
# may approve the proposal.
|
|
622
|
+
# Input only. On a proposal being sent to Display & Video 360, this field
|
|
623
|
+
# must be set to the email address of an admin on the target advertiser. This
|
|
624
|
+
# is used to verify that the Google Analytics admin is aware of at least one
|
|
625
|
+
# admin on the Display & Video 360 Advertiser. This does not restrict
|
|
626
|
+
# approval of the proposal to a single user. Any admin on the Display & Video
|
|
627
|
+
# 360 Advertiser may approve the proposal.
|
|
617
628
|
# @!attribute [rw] ads_personalization_enabled
|
|
618
629
|
# @return [::Google::Protobuf::BoolValue]
|
|
619
630
|
# Immutable. Enables personalized advertising features with this integration.
|
|
@@ -632,6 +643,47 @@ module Google
|
|
|
632
643
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
633
644
|
end
|
|
634
645
|
|
|
646
|
+
# A link between a GA4 property and a Search Ads 360 entity.
|
|
647
|
+
# @!attribute [r] name
|
|
648
|
+
# @return [::String]
|
|
649
|
+
# Output only. The resource name for this SearchAds360Link resource.
|
|
650
|
+
# Format: properties/\\{propertyId}/searchAds360Links/\\{linkId}
|
|
651
|
+
#
|
|
652
|
+
# Note: linkId is not the Search Ads 360 advertiser ID
|
|
653
|
+
# @!attribute [rw] advertiser_id
|
|
654
|
+
# @return [::String]
|
|
655
|
+
# Immutable. This field represents the Advertiser ID of the Search Ads 360
|
|
656
|
+
# Advertiser. that has been linked.
|
|
657
|
+
# @!attribute [rw] campaign_data_sharing_enabled
|
|
658
|
+
# @return [::Google::Protobuf::BoolValue]
|
|
659
|
+
# Immutable. Enables the import of campaign data from Search Ads 360 into the
|
|
660
|
+
# GA4 property. After link creation, this can only be updated from the Search
|
|
661
|
+
# Ads 360 product.
|
|
662
|
+
# If this field is not set on create, it will be defaulted to true.
|
|
663
|
+
# @!attribute [rw] cost_data_sharing_enabled
|
|
664
|
+
# @return [::Google::Protobuf::BoolValue]
|
|
665
|
+
# Immutable. Enables the import of cost data from Search Ads 360 to the GA4
|
|
666
|
+
# property. This can only be enabled if campaign_data_sharing_enabled is
|
|
667
|
+
# enabled. After link creation, this can only be updated from
|
|
668
|
+
# the Search Ads 360 product.
|
|
669
|
+
# If this field is not set on create, it will be defaulted to true.
|
|
670
|
+
# @!attribute [r] advertiser_display_name
|
|
671
|
+
# @return [::String]
|
|
672
|
+
# Output only. The display name of the Search Ads 360 Advertiser.
|
|
673
|
+
# Allows users to easily identify the linked resource.
|
|
674
|
+
# @!attribute [rw] ads_personalization_enabled
|
|
675
|
+
# @return [::Google::Protobuf::BoolValue]
|
|
676
|
+
# Enables personalized advertising features with this integration.
|
|
677
|
+
# If this field is not set on create, it will be defaulted to true.
|
|
678
|
+
# @!attribute [rw] site_stats_sharing_enabled
|
|
679
|
+
# @return [::Google::Protobuf::BoolValue]
|
|
680
|
+
# Enables export of site stats with this integration.
|
|
681
|
+
# If this field is not set on create, it will be defaulted to true.
|
|
682
|
+
class SearchAds360Link
|
|
683
|
+
include ::Google::Protobuf::MessageExts
|
|
684
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
685
|
+
end
|
|
686
|
+
|
|
635
687
|
# Status information for a link proposal.
|
|
636
688
|
# @!attribute [r] link_proposal_initiating_product
|
|
637
689
|
# @return [::Google::Analytics::Admin::V1alpha::LinkProposalInitiatingProduct]
|
|
@@ -661,14 +713,15 @@ module Google
|
|
|
661
713
|
# Output only. Time when this conversion event was created in the property.
|
|
662
714
|
# @!attribute [r] deletable
|
|
663
715
|
# @return [::Boolean]
|
|
664
|
-
# Output only. If set, this event can currently be deleted via
|
|
716
|
+
# Output only. If set, this event can currently be deleted via
|
|
717
|
+
# DeleteConversionEvent.
|
|
665
718
|
# @!attribute [r] custom
|
|
666
719
|
# @return [::Boolean]
|
|
667
|
-
# Output only. If set to true, this conversion event refers to a custom
|
|
668
|
-
# false, this conversion event refers to a default event in
|
|
669
|
-
# events typically have special meaning in GA. Default events are
|
|
670
|
-
# created for you by the GA system, but in some cases can be created
|
|
671
|
-
# property admins. Custom events count towards the maximum number of
|
|
720
|
+
# Output only. If set to true, this conversion event refers to a custom
|
|
721
|
+
# event. If set to false, this conversion event refers to a default event in
|
|
722
|
+
# GA. Default events typically have special meaning in GA. Default events are
|
|
723
|
+
# usually created for you by the GA system, but in some cases can be created
|
|
724
|
+
# by property admins. Custom events count towards the maximum number of
|
|
672
725
|
# custom conversion events that may be created per property.
|
|
673
726
|
class ConversionEvent
|
|
674
727
|
include ::Google::Protobuf::MessageExts
|
|
@@ -710,21 +763,22 @@ module Google
|
|
|
710
763
|
# characters for event-scoped dimensions.
|
|
711
764
|
# @!attribute [rw] display_name
|
|
712
765
|
# @return [::String]
|
|
713
|
-
# Required. Display name for this custom dimension as shown in the Analytics
|
|
714
|
-
# Max length of 82 characters, alphanumeric plus space and underscore
|
|
766
|
+
# Required. Display name for this custom dimension as shown in the Analytics
|
|
767
|
+
# UI. Max length of 82 characters, alphanumeric plus space and underscore
|
|
715
768
|
# starting with a letter. Legacy system-generated display names may contain
|
|
716
769
|
# square brackets, but updates to this field will never permit square
|
|
717
770
|
# brackets.
|
|
718
771
|
# @!attribute [rw] description
|
|
719
772
|
# @return [::String]
|
|
720
|
-
# Optional. Description for this custom dimension. Max length of 150
|
|
773
|
+
# Optional. Description for this custom dimension. Max length of 150
|
|
774
|
+
# characters.
|
|
721
775
|
# @!attribute [rw] scope
|
|
722
776
|
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope]
|
|
723
777
|
# Required. Immutable. The scope of this dimension.
|
|
724
778
|
# @!attribute [rw] disallow_ads_personalization
|
|
725
779
|
# @return [::Boolean]
|
|
726
|
-
# Optional. If set to true, sets this dimension as NPA and excludes it from
|
|
727
|
-
# personalization.
|
|
780
|
+
# Optional. If set to true, sets this dimension as NPA and excludes it from
|
|
781
|
+
# ads personalization.
|
|
728
782
|
#
|
|
729
783
|
# This is currently only supported by user-scoped custom dimensions.
|
|
730
784
|
class CustomDimension
|
|
@@ -777,9 +831,9 @@ module Google
|
|
|
777
831
|
# Required. Immutable. The scope of this custom metric.
|
|
778
832
|
# @!attribute [rw] restricted_metric_type
|
|
779
833
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::CustomMetric::RestrictedMetricType>]
|
|
780
|
-
# Optional. Types of restricted data that this metric may contain. Required
|
|
781
|
-
# with CURRENCY measurement unit. Must be empty for metrics with
|
|
782
|
-
# non-CURRENCY measurement unit.
|
|
834
|
+
# Optional. Types of restricted data that this metric may contain. Required
|
|
835
|
+
# for metrics with CURRENCY measurement unit. Must be empty for metrics with
|
|
836
|
+
# a non-CURRENCY measurement unit.
|
|
783
837
|
class CustomMetric
|
|
784
838
|
include ::Google::Protobuf::MessageExts
|
|
785
839
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -896,16 +950,16 @@ module Google
|
|
|
896
950
|
# Example: "properties/1000/attributionSettings"
|
|
897
951
|
# @!attribute [rw] acquisition_conversion_event_lookback_window
|
|
898
952
|
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::AcquisitionConversionEventLookbackWindow]
|
|
899
|
-
# Required. The lookback window configuration for acquisition conversion
|
|
900
|
-
# The default window size is 30 days.
|
|
953
|
+
# Required. The lookback window configuration for acquisition conversion
|
|
954
|
+
# events. The default window size is 30 days.
|
|
901
955
|
# @!attribute [rw] other_conversion_event_lookback_window
|
|
902
956
|
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::OtherConversionEventLookbackWindow]
|
|
903
|
-
# Required. The lookback window for all other, non-acquisition conversion
|
|
904
|
-
# The default window size is 90 days.
|
|
957
|
+
# Required. The lookback window for all other, non-acquisition conversion
|
|
958
|
+
# events. The default window size is 90 days.
|
|
905
959
|
# @!attribute [rw] reporting_attribution_model
|
|
906
960
|
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings::ReportingAttributionModel]
|
|
907
|
-
# Required. The reporting attribution model used to calculate conversion
|
|
908
|
-
# property's reports.
|
|
961
|
+
# Required. The reporting attribution model used to calculate conversion
|
|
962
|
+
# credit in this property's reports.
|
|
909
963
|
#
|
|
910
964
|
# Changing the attribution model will apply to both historical and future
|
|
911
965
|
# data. These changes will be reflected in reports with conversion and
|
|
@@ -984,6 +1038,47 @@ module Google
|
|
|
984
1038
|
end
|
|
985
1039
|
end
|
|
986
1040
|
|
|
1041
|
+
# A link between a GA4 Property and BigQuery project.
|
|
1042
|
+
# @!attribute [r] name
|
|
1043
|
+
# @return [::String]
|
|
1044
|
+
# Output only. Resource name of this BigQuery link.
|
|
1045
|
+
# Format: 'properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id}'
|
|
1046
|
+
# Format: 'properties/1234/bigQueryLinks/abc567'
|
|
1047
|
+
# @!attribute [rw] project
|
|
1048
|
+
# @return [::String]
|
|
1049
|
+
# Immutable. The linked Google Cloud project. When creating a BigQueryLink,
|
|
1050
|
+
# you may provide this resource name using either a project number or project
|
|
1051
|
+
# ID. Once this resource has been created, the returned project will always
|
|
1052
|
+
# have a project that contains a project number.
|
|
1053
|
+
# Format: 'projects/\\{project number}'
|
|
1054
|
+
# Example: 'projects/1234'
|
|
1055
|
+
# @!attribute [r] create_time
|
|
1056
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
1057
|
+
# Output only. Time when the link was created.
|
|
1058
|
+
# @!attribute [rw] daily_export_enabled
|
|
1059
|
+
# @return [::Boolean]
|
|
1060
|
+
# If set true, enables daily data export to the linked Google Cloud project.
|
|
1061
|
+
# @!attribute [rw] streaming_export_enabled
|
|
1062
|
+
# @return [::Boolean]
|
|
1063
|
+
# If set true, enables streaming export to the linked Google Cloud project.
|
|
1064
|
+
# @!attribute [rw] include_advertising_id
|
|
1065
|
+
# @return [::Boolean]
|
|
1066
|
+
# If set true, exported data will include advertising identifiers for mobile
|
|
1067
|
+
# app streams.
|
|
1068
|
+
# @!attribute [rw] export_streams
|
|
1069
|
+
# @return [::Array<::String>]
|
|
1070
|
+
# The list of streams under the parent property for which data will be
|
|
1071
|
+
# exported.
|
|
1072
|
+
# Format: properties/\\{property_id}/dataStreams/\\{stream_id}
|
|
1073
|
+
# Example: ['properties/1000/dataStreams/2000']
|
|
1074
|
+
# @!attribute [rw] excluded_events
|
|
1075
|
+
# @return [::Array<::String>]
|
|
1076
|
+
# The list of event names that will be excluded from exports.
|
|
1077
|
+
class BigQueryLink
|
|
1078
|
+
include ::Google::Protobuf::MessageExts
|
|
1079
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1080
|
+
end
|
|
1081
|
+
|
|
987
1082
|
# The category selected for this property, used for industry benchmarking.
|
|
988
1083
|
module IndustryCategory
|
|
989
1084
|
# Industry category unspecified
|
|
@@ -1160,6 +1255,12 @@ module Google
|
|
|
1160
1255
|
|
|
1161
1256
|
# AttributionSettings resource
|
|
1162
1257
|
ATTRIBUTION_SETTINGS = 20
|
|
1258
|
+
|
|
1259
|
+
# ExpandedDataSet resource
|
|
1260
|
+
EXPANDED_DATA_SET = 21
|
|
1261
|
+
|
|
1262
|
+
# ChannelGroup resource
|
|
1263
|
+
CHANNEL_GROUP = 22
|
|
1163
1264
|
end
|
|
1164
1265
|
|
|
1165
1266
|
# Status of the Google Signals settings (i.e., whether this feature has been
|