google-analytics-admin-v1alpha 0.2.0 → 0.5.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9524ba9d19b125b0f87367c7559589739cdf90d2453d7a5367ac03a1441af79f
4
- data.tar.gz: d2cfc2374fddfeae773d39bc920b865e72a9a2f70ceae62f1f995ac9d1b3ae21
3
+ metadata.gz: 154bfe2cbb778dff4fce01b1e2b4631ad3f9ec2c5cd9ad4dee19106e2520cf9e
4
+ data.tar.gz: cb6539719dcfbf4d25c5f62932c9ca84341a41cfc2bfc83ea6c82f693933f6d0
5
5
  SHA512:
6
- metadata.gz: 36a824d6c4f1721ba7387ba6a9d7cd5246f39e2a2a51ab44c952cb2d42440cdc2513e5b80713310e9dafb55f53eca6dcfdf1a099087b3874bc76e7d0539a0331
7
- data.tar.gz: 96c221f94ea9ab98738f92b0cca23311879e8208576e1af271cba02e8eee3b2592a65ce0564832120f98960fdb639cd959aeb429c8cdeaba0df3601097ece4f9
6
+ metadata.gz: bce72ad4c9ddfaf75be715b1d0b3ec84517b4ec126df1a7c3263ba60ac6023e2335f075c862040dea181780bb6e715b18033fe26e17e00be61aaff0a00859d66
7
+ data.tar.gz: 58cedbb4468e2b475a8643c962f8749fbe1c6f991ffa2fbb0d33c86c5b0e1392e3851633258ff946c9d7825b732e139a77d58d5f84965426e5a35ec8f0f66ab7
data/README.md CHANGED
@@ -6,6 +6,12 @@ The Analytics Admin API allows for programmatic access to the Google Analytics A
6
6
 
7
7
  https://github.com/googleapis/google-cloud-ruby
8
8
 
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the Google Analytics Admin V1alpha API. Most users should consider using
11
+ the main client gem,
12
+ [google-analytics-admin](https://rubygems.org/gems/google-analytics-admin).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
9
15
  ## Installation
10
16
 
11
17
  ```
@@ -70,3 +76,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
70
76
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
71
77
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
72
78
  about the Ruby support schedule.
79
+
80
+ ## Which client should I use?
81
+
82
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
83
+ client library with a name such as `google-analytics-admin`,
84
+ and lower-level _versioned_ client libraries with names such as
85
+ `google-analytics-admin-v1alpha`.
86
+ _In most cases, you should install the main client._
87
+
88
+ ### What's the difference between the main client and a versioned client?
89
+
90
+ A _versioned client_ provides a basic set of data types and client classes for
91
+ a _single version_ of a specific service. (That is, for a service with multiple
92
+ versions, there might be a separate versioned client for each service version.)
93
+ Most versioned clients are written and maintained by a code generator.
94
+
95
+ The _main client_ is designed to provide you with the _recommended_ client
96
+ interfaces for the service. There will be only one main client for any given
97
+ service, even a service with multiple versions. The main client includes
98
+ factory methods for constructing the client objects we recommend for most
99
+ users. In some cases, those will be classes provided by an underlying versioned
100
+ client; in other cases, they will be handwritten higher-level client objects
101
+ with additional capabilities, convenience methods, or best practices built in.
102
+ Generally, the main client will default to a recommended service version,
103
+ although in some cases you can override this if you need to talk to a specific
104
+ service version.
105
+
106
+ ### Why would I want to use the main client?
107
+
108
+ We recommend that most users install the main client gem for a service. You can
109
+ identify this gem as the one _without_ a version in its name, e.g.
110
+ `google-analytics-admin`.
111
+ The main client is recommended because it will embody the best practices for
112
+ accessing the service, and may also provide more convenient interfaces or
113
+ tighter integration into frameworks and third-party libraries. In addition, the
114
+ documentation and samples published by Google will generally demonstrate use of
115
+ the main client.
116
+
117
+ ### Why would I want to use a versioned client?
118
+
119
+ You can use a versioned client if you are content with a possibly lower-level
120
+ class interface, you explicitly want to avoid features provided by the main
121
+ client, or you want to access a specific service version not be covered by the
122
+ main client. You can identify versioned client gems because the service version
123
+ is part of the name, e.g. `google-analytics-admin-v1alpha`.
124
+
125
+ ### What about the google-apis-<name> clients?
126
+
127
+ Client library gems with names that begin with `google-apis-` are based on an
128
+ older code generation technology. They talk to a REST/JSON backend (whereas
129
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
130
+ not offer the same performance, features, and ease of use provided by more
131
+ modern clients.
132
+
133
+ The `google-apis-` clients have wide coverage across Google services, so you
134
+ might need to use one if there is no modern client available for the service.
135
+ However, if a modern client is available, we generally recommend it over the
136
+ older `google-apis-` clients.
@@ -33,3 +33,6 @@ module Google
33
33
  end
34
34
  end
35
35
  end
36
+
37
+ helper_path = ::File.join __dir__, "v1alpha", "_helpers.rb"
38
+ require "google/analytics/admin/v1alpha/_helpers" if ::File.file? helper_path
@@ -10,6 +10,7 @@ require 'google/api/field_behavior_pb'
10
10
  require 'google/api/resource_pb'
11
11
  require 'google/protobuf/empty_pb'
12
12
  require 'google/protobuf/field_mask_pb'
13
+ require 'google/protobuf/timestamp_pb'
13
14
  Google::Protobuf::DescriptorPool.generated_pool.build do
14
15
  add_file("google/analytics/admin/v1alpha/analytics_admin.proto", :syntax => :proto3) do
15
16
  add_message "google.analytics.admin.v1alpha.GetAccountRequest" do
@@ -208,9 +209,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
208
209
  end
209
210
  add_message "google.analytics.admin.v1alpha.ListFirebaseLinksRequest" do
210
211
  optional :parent, :string, 1
212
+ optional :page_size, :int32, 2
213
+ optional :page_token, :string, 3
211
214
  end
212
215
  add_message "google.analytics.admin.v1alpha.ListFirebaseLinksResponse" do
213
216
  repeated :firebase_links, :message, 1, "google.analytics.admin.v1alpha.FirebaseLink"
217
+ optional :next_page_token, :string, 2
214
218
  end
215
219
  add_message "google.analytics.admin.v1alpha.GetGlobalSiteTagRequest" do
216
220
  optional :name, :string, 1
@@ -31,7 +31,7 @@ module Google
31
31
  module Admin
32
32
  module V1alpha
33
33
  ##
34
- # Service Interface for the Analytics Admin API (App+Web).
34
+ # Service Interface for the Analytics Admin API (GA4).
35
35
  #
36
36
  # To load this service and instantiate a client:
37
37
  #
@@ -27,7 +27,7 @@ module Google
27
27
  ##
28
28
  # Client for the AnalyticsAdminService service.
29
29
  #
30
- # Service Interface for the Analytics Admin API (App+Web).
30
+ # Service Interface for the Analytics Admin API (GA4).
31
31
  #
32
32
  class Client
33
33
  include Paths
@@ -224,7 +224,13 @@ module Google
224
224
 
225
225
  # Create credentials
226
226
  credentials = @config.credentials
227
- credentials ||= Credentials.default scope: @config.scope
227
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
228
+ # but only if the default endpoint does not have a region prefix.
229
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
230
+ @config.endpoint == Client.configure.endpoint &&
231
+ !@config.endpoint.split(".").first.include?("-")
232
+ credentials ||= Credentials.default scope: @config.scope,
233
+ enable_self_signed_jwt: enable_self_signed_jwt
228
234
  if credentials.is_a?(String) || credentials.is_a?(Hash)
229
235
  credentials = Credentials.new credentials, scope: @config.scope
230
236
  end
@@ -244,8 +250,6 @@ module Google
244
250
 
245
251
  ##
246
252
  # Lookup for a single Account.
247
- # Throws "Target not found" if no such account found, or if caller does not
248
- # have permissions to access it.
249
253
  #
250
254
  # @overload get_account(request, options = nil)
251
255
  # Pass arguments to `get_account` via a request object, either of type
@@ -315,7 +319,7 @@ module Google
315
319
  ##
316
320
  # Returns all accounts accessible by the caller.
317
321
  #
318
- # Note that these accounts might not currently have App+Web properties.
322
+ # Note that these accounts might not currently have GA4 properties.
319
323
  # Soft-deleted (ie: "trashed") accounts are excluded by default.
320
324
  # Returns an empty list if no relevant accounts are found.
321
325
  #
@@ -489,7 +493,9 @@ module Google
489
493
  # Required. The account to update.
490
494
  # The account's `name` field is used to identify the account.
491
495
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
492
- # The list of fields to be updated. Omitted fields will not be updated.
496
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
497
+ # To replace the entire entity, use one path with the string "*" to match
498
+ # all fields.
493
499
  #
494
500
  # @yield [response, operation] Access the result along with the RPC operation
495
501
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::Account]
@@ -669,10 +675,7 @@ module Google
669
675
  end
670
676
 
671
677
  ##
672
- # Lookup for a single "App+Web" Property.
673
- #
674
- # Throws "Target not found" if no such property found, if property is not
675
- # of the type "App+Web", or if caller does not have permissions to access it.
678
+ # Lookup for a single "GA4" Property.
676
679
  #
677
680
  # @overload get_property(request, options = nil)
678
681
  # Pass arguments to `get_property` via a request object, either of type
@@ -742,7 +745,7 @@ module Google
742
745
  ##
743
746
  # Returns child Properties under the specified parent Account.
744
747
  #
745
- # Only "App+Web" properties will be returned.
748
+ # Only "GA4" properties will be returned.
746
749
  # Properties will be excluded if the caller does not have access.
747
750
  # Soft-deleted (ie: "trashed") properties are excluded by default.
748
751
  # Returns an empty list if no relevant properties are found.
@@ -769,11 +772,13 @@ module Google
769
772
  # `firebase_project:`(The id or number of the linked firebase project).
770
773
  # Some examples of filters:
771
774
  #
775
+ # ```
772
776
  # | Filter | Description |
773
777
  # |-----------------------------|-------------------------------------------|
774
778
  # | parent:accounts/123 | The account with account id: 123. |
775
779
  # | firebase_project:project-id | The firebase project with id: project-id. |
776
780
  # | firebase_project:123 | The firebase project with number: 123. |
781
+ # ```
777
782
  # @param page_size [::Integer]
778
783
  # The maximum number of resources to return. The service may return
779
784
  # fewer than this value, even if there are additional pages.
@@ -830,7 +835,7 @@ module Google
830
835
  end
831
836
 
832
837
  ##
833
- # Creates an "App+Web" property with the specified location and attributes.
838
+ # Creates an "GA4" property with the specified location and attributes.
834
839
  #
835
840
  # @overload create_property(request, options = nil)
836
841
  # Pass arguments to `create_property` via a request object, either of type
@@ -901,7 +906,7 @@ module Google
901
906
  # will be permanently purged.
902
907
  # https://support.google.com/analytics/answer/6154772
903
908
  #
904
- # Returns an error if the target is not found, or is not an App+Web Property.
909
+ # Returns an error if the target is not found, or is not an GA4 Property.
905
910
  #
906
911
  # @overload delete_property(request, options = nil)
907
912
  # Pass arguments to `delete_property` via a request object, either of type
@@ -991,7 +996,9 @@ module Google
991
996
  # The property's `name` field is used to identify the property to be
992
997
  # updated.
993
998
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
994
- # The list of fields to be updated. Omitted fields will not be updated.
999
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1000
+ # To replace the entire entity, use one path with the string "*" to match
1001
+ # all fields.
995
1002
  #
996
1003
  # @yield [response, operation] Access the result along with the RPC operation
997
1004
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::Property]
@@ -1364,8 +1371,8 @@ module Google
1364
1371
  # @param parent [::String]
1365
1372
  # Required. Example format: accounts/1234
1366
1373
  # @param notify_new_user [::Boolean]
1367
- # Optional. If notify_new_user is set, then email new user that they've been given
1368
- # permissions on the resource.
1374
+ # Optional. If set, then email the new user notifying them that they've been granted
1375
+ # permissions to the resource.
1369
1376
  # @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
1370
1377
  # Required. The user link to create.
1371
1378
  #
@@ -1441,10 +1448,11 @@ module Google
1441
1448
  # messages must either be empty or match this field.
1442
1449
  # Example format: accounts/1234
1443
1450
  # @param notify_new_users [::Boolean]
1444
- # Optional. If notify_new_users is set, then email new users that they've been given
1445
- # permissions on the resource.
1451
+ # Optional. If set, then email the new users notifying them that they've been granted
1452
+ # permissions to the resource. Regardless of whether this is set or not,
1453
+ # notify_new_user field inside each individual request is ignored.
1446
1454
  # @param requests [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash>]
1447
- # The requests specifying the user links to create.
1455
+ # Required. The requests specifying the user links to create.
1448
1456
  # A maximum of 1000 user links can be created in a batch.
1449
1457
  #
1450
1458
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1582,7 +1590,7 @@ module Google
1582
1590
  # empty or match this field.
1583
1591
  # Example format: accounts/1234
1584
1592
  # @param requests [::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash>]
1585
- # The requests specifying the user links to update.
1593
+ # Required. The requests specifying the user links to update.
1586
1594
  # A maximum of 1000 user links can be updated in a batch.
1587
1595
  #
1588
1596
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1720,7 +1728,7 @@ module Google
1720
1728
  # field.
1721
1729
  # Example format: accounts/1234
1722
1730
  # @param requests [::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash>]
1723
- # The requests specifying the user links to update.
1731
+ # Required. The requests specifying the user links to update.
1724
1732
  # A maximum of 1000 user links can be updated in a batch.
1725
1733
  #
1726
1734
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1771,9 +1779,6 @@ module Google
1771
1779
  ##
1772
1780
  # Lookup for a single WebDataStream
1773
1781
  #
1774
- # Throws "Target not found" if no such web data stream found, or if the
1775
- # caller does not have permissions to access it.
1776
- #
1777
1782
  # @overload get_web_data_stream(request, options = nil)
1778
1783
  # Pass arguments to `get_web_data_stream` via a request object, either of type
1779
1784
  # {::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest} or an equivalent Hash.
@@ -1929,7 +1934,9 @@ module Google
1929
1934
  # Required. The web stream to update.
1930
1935
  # The `name` field is used to identify the web stream to be updated.
1931
1936
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1932
- # The list of fields to be updated. Omitted fields will not be updated.
1937
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1938
+ # To replace the entire entity, use one path with the string "*" to match
1939
+ # all fields.
1933
1940
  #
1934
1941
  # @yield [response, operation] Access the result along with the RPC operation
1935
1942
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::WebDataStream]
@@ -2129,9 +2136,6 @@ module Google
2129
2136
  ##
2130
2137
  # Lookup for a single IosAppDataStream
2131
2138
  #
2132
- # Throws "Target not found" if no such iOS app data stream found, or if the
2133
- # caller does not have permissions to access it.
2134
- #
2135
2139
  # @overload get_ios_app_data_stream(request, options = nil)
2136
2140
  # Pass arguments to `get_ios_app_data_stream` via a request object, either of type
2137
2141
  # {::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest} or an equivalent Hash.
@@ -2287,7 +2291,9 @@ module Google
2287
2291
  # Required. The iOS app stream to update.
2288
2292
  # The `name` field is used to identify the iOS app stream to be updated.
2289
2293
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2290
- # The list of fields to be updated. Omitted fields will not be updated.
2294
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
2295
+ # To replace the entire entity, use one path with the string "*" to match
2296
+ # all fields.
2291
2297
  #
2292
2298
  # @yield [response, operation] Access the result along with the RPC operation
2293
2299
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
@@ -2487,9 +2493,6 @@ module Google
2487
2493
  ##
2488
2494
  # Lookup for a single AndroidAppDataStream
2489
2495
  #
2490
- # Throws "Target not found" if no such android app data stream found, or if
2491
- # the caller does not have permissions to access it.
2492
- #
2493
2496
  # @overload get_android_app_data_stream(request, options = nil)
2494
2497
  # Pass arguments to `get_android_app_data_stream` via a request object, either of type
2495
2498
  # {::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest} or an equivalent Hash.
@@ -2645,7 +2648,9 @@ module Google
2645
2648
  # Required. The android app stream to update.
2646
2649
  # The `name` field is used to identify the android app stream to be updated.
2647
2650
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2648
- # The list of fields to be updated. Omitted fields will not be updated.
2651
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
2652
+ # To replace the entire entity, use one path with the string "*" to match
2653
+ # all fields.
2649
2654
  #
2650
2655
  # @yield [response, operation] Access the result along with the RPC operation
2651
2656
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
@@ -2939,7 +2944,9 @@ module Google
2939
2944
  # Required. The settings to update.
2940
2945
  # The `name` field is used to identify the settings to be updated.
2941
2946
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2942
- # The list of fields to be updated. Omitted fields will not be updated.
2947
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
2948
+ # To replace the entire entity, use one path with the string "*" to match
2949
+ # all fields.
2943
2950
  #
2944
2951
  # @yield [response, operation] Access the result along with the RPC operation
2945
2952
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
@@ -3078,7 +3085,9 @@ module Google
3078
3085
  # @param firebase_link [::Google::Analytics::Admin::V1alpha::FirebaseLink, ::Hash]
3079
3086
  # Required. The Firebase link to update.
3080
3087
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
3081
- # The list of fields to be updated. Omitted fields will not be updated.
3088
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
3089
+ # To replace the entire entity, use one path with the string "*" to match
3090
+ # all fields.
3082
3091
  #
3083
3092
  # @yield [response, operation] Access the result along with the RPC operation
3084
3093
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::FirebaseLink]
@@ -3206,7 +3215,7 @@ module Google
3206
3215
  # @param options [::Gapic::CallOptions, ::Hash]
3207
3216
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3208
3217
  #
3209
- # @overload list_firebase_links(parent: nil)
3218
+ # @overload list_firebase_links(parent: nil, page_size: nil, page_token: nil)
3210
3219
  # Pass arguments to `list_firebase_links` via keyword arguments. Note that at
3211
3220
  # least one keyword argument is required. To specify no parameters, or to keep all
3212
3221
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3214,12 +3223,22 @@ module Google
3214
3223
  # @param parent [::String]
3215
3224
  # Required. Format: properties/\\{property_id}
3216
3225
  # Example: properties/1234
3226
+ # @param page_size [::Integer]
3227
+ # The maximum number of resources to return. The service may return
3228
+ # fewer than this value, even if there are additional pages.
3229
+ # If unspecified, at most 50 resources will be returned.
3230
+ # The maximum value is 200; (higher values will be coerced to the maximum)
3231
+ # @param page_token [::String]
3232
+ # A page token, received from a previous `ListFirebaseLinks` call.
3233
+ # Provide this to retrieve the subsequent page.
3234
+ # When paginating, all other parameters provided to `ListProperties` must
3235
+ # match the call that provided the page token.
3217
3236
  #
3218
3237
  # @yield [response, operation] Access the result along with the RPC operation
3219
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::ListFirebaseLinksResponse]
3238
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>]
3220
3239
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
3221
3240
  #
3222
- # @return [::Google::Analytics::Admin::V1alpha::ListFirebaseLinksResponse]
3241
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>]
3223
3242
  #
3224
3243
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3225
3244
  #
@@ -3253,6 +3272,7 @@ module Google
3253
3272
  retry_policy: @config.retry_policy
3254
3273
 
3255
3274
  @analytics_admin_service_stub.call_rpc :list_firebase_links, request, options: options do |response, operation|
3275
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_firebase_links, request, response, operation, options
3256
3276
  yield response, operation if block_given?
3257
3277
  return response
3258
3278
  end
@@ -3419,7 +3439,9 @@ module Google
3419
3439
  # @param google_ads_link [::Google::Analytics::Admin::V1alpha::GoogleAdsLink, ::Hash]
3420
3440
  # The GoogleAdsLink to update
3421
3441
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
3422
- # The list of fields to be updated. Omitted fields will not be updated.
3442
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
3443
+ # To replace the entire entity, use one path with the string "*" to match
3444
+ # all fields.
3423
3445
  #
3424
3446
  # @yield [response, operation] Access the result along with the RPC operation
3425
3447
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleAdsLink]
@@ -3803,7 +3825,7 @@ module Google
3803
3825
  # Each configuration object is of type `Gapic::Config::Method` and includes
3804
3826
  # the following configuration fields:
3805
3827
  #
3806
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
3828
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
3807
3829
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
3808
3830
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
3809
3831
  # include the following keys:
@@ -24,7 +24,7 @@ module Google
24
24
  module Admin
25
25
  module V1alpha
26
26
  module AnalyticsAdminService
27
- # Service Interface for the Analytics Admin API (App+Web).
27
+ # Service Interface for the Analytics Admin API (GA4).
28
28
  class Service
29
29
 
30
30
  include GRPC::GenericService
@@ -34,12 +34,10 @@ module Google
34
34
  self.service_name = 'google.analytics.admin.v1alpha.AnalyticsAdminService'
35
35
 
36
36
  # Lookup for a single Account.
37
- # Throws "Target not found" if no such account found, or if caller does not
38
- # have permissions to access it.
39
37
  rpc :GetAccount, ::Google::Analytics::Admin::V1alpha::GetAccountRequest, ::Google::Analytics::Admin::V1alpha::Account
40
38
  # Returns all accounts accessible by the caller.
41
39
  #
42
- # Note that these accounts might not currently have App+Web properties.
40
+ # Note that these accounts might not currently have GA4 properties.
43
41
  # Soft-deleted (ie: "trashed") accounts are excluded by default.
44
42
  # Returns an empty list if no relevant accounts are found.
45
43
  rpc :ListAccounts, ::Google::Analytics::Admin::V1alpha::ListAccountsRequest, ::Google::Analytics::Admin::V1alpha::ListAccountsResponse
@@ -61,19 +59,16 @@ module Google
61
59
  rpc :ProvisionAccountTicket, ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketRequest, ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse
62
60
  # Returns summaries of all accounts accessible by the caller.
63
61
  rpc :ListAccountSummaries, ::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest, ::Google::Analytics::Admin::V1alpha::ListAccountSummariesResponse
64
- # Lookup for a single "App+Web" Property.
65
- #
66
- # Throws "Target not found" if no such property found, if property is not
67
- # of the type "App+Web", or if caller does not have permissions to access it.
62
+ # Lookup for a single "GA4" Property.
68
63
  rpc :GetProperty, ::Google::Analytics::Admin::V1alpha::GetPropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
69
64
  # Returns child Properties under the specified parent Account.
70
65
  #
71
- # Only "App+Web" properties will be returned.
66
+ # Only "GA4" properties will be returned.
72
67
  # Properties will be excluded if the caller does not have access.
73
68
  # Soft-deleted (ie: "trashed") properties are excluded by default.
74
69
  # Returns an empty list if no relevant properties are found.
75
70
  rpc :ListProperties, ::Google::Analytics::Admin::V1alpha::ListPropertiesRequest, ::Google::Analytics::Admin::V1alpha::ListPropertiesResponse
76
- # Creates an "App+Web" property with the specified location and attributes.
71
+ # Creates an "GA4" property with the specified location and attributes.
77
72
  rpc :CreateProperty, ::Google::Analytics::Admin::V1alpha::CreatePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
78
73
  # Marks target Property as soft-deleted (ie: "trashed") and returns it.
79
74
  #
@@ -85,7 +80,7 @@ module Google
85
80
  # will be permanently purged.
86
81
  # https://support.google.com/analytics/answer/6154772
87
82
  #
88
- # Returns an error if the target is not found, or is not an App+Web Property.
83
+ # Returns an error if the target is not found, or is not an GA4 Property.
89
84
  rpc :DeleteProperty, ::Google::Analytics::Admin::V1alpha::DeletePropertyRequest, ::Google::Protobuf::Empty
90
85
  # Updates a property.
91
86
  rpc :UpdateProperty, ::Google::Analytics::Admin::V1alpha::UpdatePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
@@ -125,9 +120,6 @@ module Google
125
120
  # Deletes information about multiple users' links to an account or property.
126
121
  rpc :BatchDeleteUserLinks, ::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest, ::Google::Protobuf::Empty
127
122
  # Lookup for a single WebDataStream
128
- #
129
- # Throws "Target not found" if no such web data stream found, or if the
130
- # caller does not have permissions to access it.
131
123
  rpc :GetWebDataStream, ::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest, ::Google::Analytics::Admin::V1alpha::WebDataStream
132
124
  # Deletes a web stream on a property.
133
125
  rpc :DeleteWebDataStream, ::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest, ::Google::Protobuf::Empty
@@ -141,9 +133,6 @@ module Google
141
133
  # Returns an empty list if no relevant web data streams are found.
142
134
  rpc :ListWebDataStreams, ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsResponse
143
135
  # Lookup for a single IosAppDataStream
144
- #
145
- # Throws "Target not found" if no such iOS app data stream found, or if the
146
- # caller does not have permissions to access it.
147
136
  rpc :GetIosAppDataStream, ::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::IosAppDataStream
148
137
  # Deletes an iOS app stream on a property.
149
138
  rpc :DeleteIosAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest, ::Google::Protobuf::Empty
@@ -157,9 +146,6 @@ module Google
157
146
  # Returns an empty list if no relevant iOS app data streams are found.
158
147
  rpc :ListIosAppDataStreams, ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsResponse
159
148
  # Lookup for a single AndroidAppDataStream
160
- #
161
- # Throws "Target not found" if no such android app data stream found, or if
162
- # the caller does not have permissions to access it.
163
149
  rpc :GetAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
164
150
  # Deletes an android app stream on a property.
165
151
  rpc :DeleteAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest, ::Google::Protobuf::Empty
@@ -14,7 +14,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
14
14
  optional :create_time, :message, 2, "google.protobuf.Timestamp"
15
15
  optional :update_time, :message, 3, "google.protobuf.Timestamp"
16
16
  optional :display_name, :string, 4
17
- optional :country_code, :string, 5
17
+ optional :region_code, :string, 5
18
18
  optional :deleted, :bool, 6
19
19
  end
20
20
  add_message "google.analytics.admin.v1alpha.Property" do
@@ -70,19 +70,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
70
70
  optional :page_views_enabled, :bool, 3
71
71
  optional :scrolls_enabled, :bool, 4
72
72
  optional :outbound_clicks_enabled, :bool, 5
73
- optional :content_views_enabled, :bool, 6
74
73
  optional :site_search_enabled, :bool, 7
75
- optional :form_interactions_enabled, :bool, 8
76
74
  optional :video_engagement_enabled, :bool, 9
77
75
  optional :file_downloads_enabled, :bool, 10
78
- optional :data_tagged_element_clicks_enabled, :bool, 11
79
76
  optional :page_loads_enabled, :bool, 12
80
77
  optional :page_changes_enabled, :bool, 13
81
- optional :articles_and_blogs_enabled, :bool, 14
82
- optional :products_and_ecommerce_enabled, :bool, 15
83
78
  optional :search_query_parameter, :string, 16
84
- optional :url_query_parameter, :string, 17
85
- optional :excluded_domains, :string, 18
79
+ optional :uri_query_parameter, :string, 17
86
80
  end
87
81
  add_message "google.analytics.admin.v1alpha.FirebaseLink" do
88
82
  optional :name, :string, 1
@@ -91,11 +85,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
91
85
  optional :maximum_user_access, :enum, 4, "google.analytics.admin.v1alpha.MaximumUserAccess"
92
86
  end
93
87
  add_message "google.analytics.admin.v1alpha.GlobalSiteTag" do
94
- optional :snippet, :string, 1
88
+ optional :name, :string, 1
89
+ optional :snippet, :string, 2
95
90
  end
96
91
  add_message "google.analytics.admin.v1alpha.GoogleAdsLink" do
97
92
  optional :name, :string, 1
98
- optional :parent, :string, 2
99
93
  optional :customer_id, :string, 3
100
94
  optional :can_manage_clients, :bool, 4
101
95
  optional :ads_personalization_enabled, :message, 5, "google.protobuf.BoolValue"
@@ -121,6 +115,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
121
115
  optional :property, :string, 1
122
116
  optional :display_name, :string, 2
123
117
  end
118
+ add_enum "google.analytics.admin.v1alpha.MaximumUserAccess" do
119
+ value :MAXIMUM_USER_ACCESS_UNSPECIFIED, 0
120
+ value :NO_ACCESS, 1
121
+ value :READ_AND_ANALYZE, 2
122
+ value :EDITOR_WITHOUT_LINK_MANAGEMENT, 3
123
+ value :EDITOR_INCLUDING_LINK_MANAGEMENT, 4
124
+ end
124
125
  add_enum "google.analytics.admin.v1alpha.IndustryCategory" do
125
126
  value :INDUSTRY_CATEGORY_UNSPECIFIED, 0
126
127
  value :AUTOMOTIVE, 1
@@ -150,13 +151,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
150
151
  value :JOBS_AND_EDUCATION, 25
151
152
  value :SHOPPING, 26
152
153
  end
153
- add_enum "google.analytics.admin.v1alpha.MaximumUserAccess" do
154
- value :MAXIMUM_USER_ACCESS_UNSPECIFIED, 0
155
- value :NO_ACCESS, 1
156
- value :READ_AND_ANALYZE, 2
157
- value :EDITOR_WITHOUT_LINK_MANAGEMENT, 3
158
- value :EDITOR_INCLUDING_LINK_MANAGEMENT, 4
159
- end
160
154
  end
161
155
  end
162
156
 
@@ -178,8 +172,8 @@ module Google
178
172
  DataSharingSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataSharingSettings").msgclass
179
173
  AccountSummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AccountSummary").msgclass
180
174
  PropertySummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.PropertySummary").msgclass
181
- IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
182
175
  MaximumUserAccess = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.MaximumUserAccess").enummodule
176
+ IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
183
177
  end
184
178
  end
185
179
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Analytics
22
22
  module Admin
23
23
  module V1alpha
24
- VERSION = "0.2.0"
24
+ VERSION = "0.5.0"
25
25
  end
26
26
  end
27
27
  end
@@ -86,7 +86,9 @@ module Google
86
86
  # The account's `name` field is used to identify the account.
87
87
  # @!attribute [rw] update_mask
88
88
  # @return [::Google::Protobuf::FieldMask]
89
- # The list of fields to be updated. Omitted fields will not be updated.
89
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
90
+ # To replace the entire entity, use one path with the string "*" to match
91
+ # all fields.
90
92
  class UpdateAccountRequest
91
93
  include ::Google::Protobuf::MessageExts
92
94
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -134,11 +136,13 @@ module Google
134
136
  # `firebase_project:`(The id or number of the linked firebase project).
135
137
  # Some examples of filters:
136
138
  #
139
+ # ```
137
140
  # | Filter | Description |
138
141
  # |-----------------------------|-------------------------------------------|
139
142
  # | parent:accounts/123 | The account with account id: 123. |
140
143
  # | firebase_project:project-id | The firebase project with id: project-id. |
141
144
  # | firebase_project:123 | The firebase project with number: 123. |
145
+ # ```
142
146
  # @!attribute [rw] page_size
143
147
  # @return [::Integer]
144
148
  # The maximum number of resources to return. The service may return
@@ -182,7 +186,9 @@ module Google
182
186
  # updated.
183
187
  # @!attribute [rw] update_mask
184
188
  # @return [::Google::Protobuf::FieldMask]
185
- # The list of fields to be updated. Omitted fields will not be updated.
189
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
190
+ # To replace the entire entity, use one path with the string "*" to match
191
+ # all fields.
186
192
  class UpdatePropertyRequest
187
193
  include ::Google::Protobuf::MessageExts
188
194
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -326,8 +332,8 @@ module Google
326
332
  # Required. Example format: accounts/1234
327
333
  # @!attribute [rw] notify_new_user
328
334
  # @return [::Boolean]
329
- # Optional. If notify_new_user is set, then email new user that they've been given
330
- # permissions on the resource.
335
+ # Optional. If set, then email the new user notifying them that they've been granted
336
+ # permissions to the resource.
331
337
  # @!attribute [rw] user_link
332
338
  # @return [::Google::Analytics::Admin::V1alpha::UserLink]
333
339
  # Required. The user link to create.
@@ -345,11 +351,12 @@ module Google
345
351
  # Example format: accounts/1234
346
352
  # @!attribute [rw] notify_new_users
347
353
  # @return [::Boolean]
348
- # Optional. If notify_new_users is set, then email new users that they've been given
349
- # permissions on the resource.
354
+ # Optional. If set, then email the new users notifying them that they've been granted
355
+ # permissions to the resource. Regardless of whether this is set or not,
356
+ # notify_new_user field inside each individual request is ignored.
350
357
  # @!attribute [rw] requests
351
358
  # @return [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest>]
352
- # The requests specifying the user links to create.
359
+ # Required. The requests specifying the user links to create.
353
360
  # A maximum of 1000 user links can be created in a batch.
354
361
  class BatchCreateUserLinksRequest
355
362
  include ::Google::Protobuf::MessageExts
@@ -383,7 +390,7 @@ module Google
383
390
  # Example format: accounts/1234
384
391
  # @!attribute [rw] requests
385
392
  # @return [::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest>]
386
- # The requests specifying the user links to update.
393
+ # Required. The requests specifying the user links to update.
387
394
  # A maximum of 1000 user links can be updated in a batch.
388
395
  class BatchUpdateUserLinksRequest
389
396
  include ::Google::Protobuf::MessageExts
@@ -417,7 +424,7 @@ module Google
417
424
  # Example format: accounts/1234
418
425
  # @!attribute [rw] requests
419
426
  # @return [::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest>]
420
- # The requests specifying the user links to update.
427
+ # Required. The requests specifying the user links to update.
421
428
  # A maximum of 1000 user links can be updated in a batch.
422
429
  class BatchDeleteUserLinksRequest
423
430
  include ::Google::Protobuf::MessageExts
@@ -453,7 +460,9 @@ module Google
453
460
  # The `name` field is used to identify the web stream to be updated.
454
461
  # @!attribute [rw] update_mask
455
462
  # @return [::Google::Protobuf::FieldMask]
456
- # The list of fields to be updated. Omitted fields will not be updated.
463
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
464
+ # To replace the entire entity, use one path with the string "*" to match
465
+ # all fields.
457
466
  class UpdateWebDataStreamRequest
458
467
  include ::Google::Protobuf::MessageExts
459
468
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -536,7 +545,9 @@ module Google
536
545
  # The `name` field is used to identify the iOS app stream to be updated.
537
546
  # @!attribute [rw] update_mask
538
547
  # @return [::Google::Protobuf::FieldMask]
539
- # The list of fields to be updated. Omitted fields will not be updated.
548
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
549
+ # To replace the entire entity, use one path with the string "*" to match
550
+ # all fields.
540
551
  class UpdateIosAppDataStreamRequest
541
552
  include ::Google::Protobuf::MessageExts
542
553
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -619,7 +630,9 @@ module Google
619
630
  # The `name` field is used to identify the android app stream to be updated.
620
631
  # @!attribute [rw] update_mask
621
632
  # @return [::Google::Protobuf::FieldMask]
622
- # The list of fields to be updated. Omitted fields will not be updated.
633
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
634
+ # To replace the entire entity, use one path with the string "*" to match
635
+ # all fields.
623
636
  class UpdateAndroidAppDataStreamRequest
624
637
  include ::Google::Protobuf::MessageExts
625
638
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -694,7 +707,9 @@ module Google
694
707
  # The `name` field is used to identify the settings to be updated.
695
708
  # @!attribute [rw] update_mask
696
709
  # @return [::Google::Protobuf::FieldMask]
697
- # The list of fields to be updated. Omitted fields will not be updated.
710
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
711
+ # To replace the entire entity, use one path with the string "*" to match
712
+ # all fields.
698
713
  class UpdateEnhancedMeasurementSettingsRequest
699
714
  include ::Google::Protobuf::MessageExts
700
715
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -719,7 +734,9 @@ module Google
719
734
  # Required. The Firebase link to update.
720
735
  # @!attribute [rw] update_mask
721
736
  # @return [::Google::Protobuf::FieldMask]
722
- # The list of fields to be updated. Omitted fields will not be updated.
737
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
738
+ # To replace the entire entity, use one path with the string "*" to match
739
+ # all fields.
723
740
  class UpdateFirebaseLinkRequest
724
741
  include ::Google::Protobuf::MessageExts
725
742
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -740,6 +757,18 @@ module Google
740
757
  # @return [::String]
741
758
  # Required. Format: properties/\\{property_id}
742
759
  # Example: properties/1234
760
+ # @!attribute [rw] page_size
761
+ # @return [::Integer]
762
+ # The maximum number of resources to return. The service may return
763
+ # fewer than this value, even if there are additional pages.
764
+ # If unspecified, at most 50 resources will be returned.
765
+ # The maximum value is 200; (higher values will be coerced to the maximum)
766
+ # @!attribute [rw] page_token
767
+ # @return [::String]
768
+ # A page token, received from a previous `ListFirebaseLinks` call.
769
+ # Provide this to retrieve the subsequent page.
770
+ # When paginating, all other parameters provided to `ListProperties` must
771
+ # match the call that provided the page token.
743
772
  class ListFirebaseLinksRequest
744
773
  include ::Google::Protobuf::MessageExts
745
774
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -749,6 +778,12 @@ module Google
749
778
  # @!attribute [rw] firebase_links
750
779
  # @return [::Array<::Google::Analytics::Admin::V1alpha::FirebaseLink>]
751
780
  # List of FirebaseLinks. This will have at most one value.
781
+ # @!attribute [rw] next_page_token
782
+ # @return [::String]
783
+ # A token, which can be sent as `page_token` to retrieve the next page.
784
+ # If this field is omitted, there are no subsequent pages.
785
+ # Currently, Google Analytics supports only one FirebaseLink per property,
786
+ # so this will never be populated.
752
787
  class ListFirebaseLinksResponse
753
788
  include ::Google::Protobuf::MessageExts
754
789
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -784,7 +819,9 @@ module Google
784
819
  # The GoogleAdsLink to update
785
820
  # @!attribute [rw] update_mask
786
821
  # @return [::Google::Protobuf::FieldMask]
787
- # The list of fields to be updated. Omitted fields will not be updated.
822
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
823
+ # To replace the entire entity, use one path with the string "*" to match
824
+ # all fields.
788
825
  class UpdateGoogleAdsLinkRequest
789
826
  include ::Google::Protobuf::MessageExts
790
827
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -36,10 +36,9 @@ module Google
36
36
  # @!attribute [rw] display_name
37
37
  # @return [::String]
38
38
  # Required. Human-readable display name for this account.
39
- # @!attribute [rw] country_code
39
+ # @!attribute [rw] region_code
40
40
  # @return [::String]
41
- # Country of business. Must be a non-deprecated code for a UN M.49 region.
42
- # https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html
41
+ # Country of business. Must be a Unicode CLDR region code.
43
42
  # @!attribute [r] deleted
44
43
  # @return [::Boolean]
45
44
  # Output only. Indicates whether this Account is soft-deleted or not. Deleted
@@ -49,7 +48,7 @@ module Google
49
48
  extend ::Google::Protobuf::MessageExts::ClassMethods
50
49
  end
51
50
 
52
- # A resource message representing a Google Analytics App+Web property.
51
+ # A resource message representing a Google Analytics GA4 property.
53
52
  # @!attribute [r] name
54
53
  # @return [::String]
55
54
  # Output only. Resource name of this property.
@@ -279,18 +278,10 @@ module Google
279
278
  # @return [::Boolean]
280
279
  # If enabled, capture an outbound click event each time a visitor clicks a
281
280
  # link that leads them away from your domain.
282
- # @!attribute [rw] content_views_enabled
283
- # @return [::Boolean]
284
- # Capture events when your visitors view content on your site that has
285
- # structured data (eg, articles, blog posts, product details screens, etc.).
286
281
  # @!attribute [rw] site_search_enabled
287
282
  # @return [::Boolean]
288
283
  # If enabled, capture a view search results event each time a visitor
289
284
  # performs a search on your site (based on a query parameter).
290
- # @!attribute [rw] form_interactions_enabled
291
- # @return [::Boolean]
292
- # If enabled, capture a view search results event each time a visitor
293
- # interacts with a form on your site.
294
285
  # @!attribute [rw] video_engagement_enabled
295
286
  # @return [::Boolean]
296
287
  # If enabled, capture video play, progress, and complete events as visitors
@@ -299,42 +290,27 @@ module Google
299
290
  # @return [::Boolean]
300
291
  # If enabled, capture a file download event each time a link is clicked with
301
292
  # a common document, compressed file, application, video, or audio extension.
302
- # @!attribute [rw] data_tagged_element_clicks_enabled
303
- # @return [::Boolean]
304
- # If enabled, capture a click event each time a visitor clicks a link or
305
- # element that has data attributes beginning with "data-ga".
306
- # @!attribute [rw] page_loads_enabled
293
+ # @!attribute [r] page_loads_enabled
307
294
  # @return [::Boolean]
308
- # If enabled, capture a page view event each time a page loads.
295
+ # Output only. If enabled, capture a page view event each time a page loads.
309
296
  # @!attribute [rw] page_changes_enabled
310
297
  # @return [::Boolean]
311
298
  # If enabled, capture a page view event each time the website changes the
312
299
  # browser history state.
313
- # @!attribute [rw] articles_and_blogs_enabled
314
- # @return [::Boolean]
315
- # Capture events when your visitors view content on your site that has
316
- # articles or blog posts.
317
- # @!attribute [rw] products_and_ecommerce_enabled
318
- # @return [::Boolean]
319
- # Capture events when your visitors view content on your site that has
320
- # product details screens, etc.
321
300
  # @!attribute [rw] search_query_parameter
322
301
  # @return [::String]
323
302
  # Required. URL query parameters to interpret as site search parameters.
324
303
  # Max length is 1024 characters. Must not be empty.
325
- # @!attribute [rw] url_query_parameter
304
+ # @!attribute [rw] uri_query_parameter
326
305
  # @return [::String]
327
306
  # Additional URL query parameters.
328
307
  # Max length is 1024 characters.
329
- # @!attribute [rw] excluded_domains
330
- # @return [::String]
331
- # Domains to exclude from measurement. Max length is 1024 characters.
332
308
  class EnhancedMeasurementSettings
333
309
  include ::Google::Protobuf::MessageExts
334
310
  extend ::Google::Protobuf::MessageExts::ClassMethods
335
311
  end
336
312
 
337
- # A link between an App+Web property and a Firebase project.
313
+ # A link between an GA4 property and a Firebase project.
338
314
  # @!attribute [r] name
339
315
  # @return [::String]
340
316
  # Output only. Example format: properties/1234/firebaseLinks/5678
@@ -352,7 +328,7 @@ module Google
352
328
  # Output only. Time when this FirebaseLink was originally created.
353
329
  # @!attribute [rw] maximum_user_access
354
330
  # @return [::Google::Analytics::Admin::V1alpha::MaximumUserAccess]
355
- # Maximum user access to the App + Web property allowed to admins of
331
+ # Maximum user access to the GA4 property allowed to admins of
356
332
  # the linked Firebase project.
357
333
  class FirebaseLink
358
334
  include ::Google::Protobuf::MessageExts
@@ -361,6 +337,10 @@ module Google
361
337
 
362
338
  # Read-only resource with the tag for sending data from a website to a
363
339
  # WebDataStream.
340
+ # @!attribute [r] name
341
+ # @return [::String]
342
+ # Output only. Resource name for this GlobalSiteTag resource.
343
+ # Format: properties/\\{propertyId}/globalSiteTag
364
344
  # @!attribute [rw] snippet
365
345
  # @return [::String]
366
346
  # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of
@@ -370,15 +350,12 @@ module Google
370
350
  extend ::Google::Protobuf::MessageExts::ClassMethods
371
351
  end
372
352
 
373
- # A link between an App+Web property and a Google Ads account.
353
+ # A link between an GA4 property and a Google Ads account.
374
354
  # @!attribute [r] name
375
355
  # @return [::String]
376
356
  # Output only. Format: properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
377
357
  #
378
358
  # Note: googleAdsLinkId is not the Google Ads customer ID.
379
- # @!attribute [rw] parent
380
- # @return [::String]
381
- # Immutable. Format: properties/\\{propertyId}
382
359
  # @!attribute [rw] customer_id
383
360
  # @return [::String]
384
361
  # Immutable. Google Ads customer ID.
@@ -438,7 +415,7 @@ module Google
438
415
  end
439
416
 
440
417
  # A virtual resource representing an overview of an account and
441
- # all its child App+Web properties.
418
+ # all its child GA4 properties.
442
419
  # @!attribute [rw] name
443
420
  # @return [::String]
444
421
  # Resource name for this account summary.
@@ -460,7 +437,7 @@ module Google
460
437
  extend ::Google::Protobuf::MessageExts::ClassMethods
461
438
  end
462
439
 
463
- # A virtual resource representing metadata for an App+Web property.
440
+ # A virtual resource representing metadata for an GA4 property.
464
441
  # @!attribute [rw] property
465
442
  # @return [::String]
466
443
  # Resource name of property referred to by this property summary
@@ -474,6 +451,27 @@ module Google
474
451
  extend ::Google::Protobuf::MessageExts::ClassMethods
475
452
  end
476
453
 
454
+ # Maximum access settings that Firebase user receive on the linked Analytics
455
+ # property.
456
+ module MaximumUserAccess
457
+ # Unspecified maximum user access.
458
+ MAXIMUM_USER_ACCESS_UNSPECIFIED = 0
459
+
460
+ # Firebase users have no access to the Analytics property.
461
+ NO_ACCESS = 1
462
+
463
+ # Firebase users have Read & Analyze access to the Analytics property.
464
+ READ_AND_ANALYZE = 2
465
+
466
+ # Firebase users have edit access to the Analytics property, but may not
467
+ # manage the Firebase link.
468
+ EDITOR_WITHOUT_LINK_MANAGEMENT = 3
469
+
470
+ # Firebase users have edit access to the Analytics property and may manage
471
+ # the Firebase link.
472
+ EDITOR_INCLUDING_LINK_MANAGEMENT = 4
473
+ end
474
+
477
475
  # The category selected for this property, used for industry benchmarking.
478
476
  module IndustryCategory
479
477
  # Industry category unspecified
@@ -557,27 +555,6 @@ module Google
557
555
  # Shopping
558
556
  SHOPPING = 26
559
557
  end
560
-
561
- # Maximum access settings that Firebase user receive on the linked Analytics
562
- # property.
563
- module MaximumUserAccess
564
- # Unspecified maximum user access.
565
- MAXIMUM_USER_ACCESS_UNSPECIFIED = 0
566
-
567
- # Firebase users have no access to the Analytics property.
568
- NO_ACCESS = 1
569
-
570
- # Firebase users have Read & Analyze access to the Analytics property.
571
- READ_AND_ANALYZE = 2
572
-
573
- # Firebase users have edit access to the Analytics property, but may not
574
- # manage the Firebase link.
575
- EDITOR_WITHOUT_LINK_MANAGEMENT = 3
576
-
577
- # Firebase users have edit access to the Analytics property and may manage
578
- # the Firebase link.
579
- EDITOR_INCLUDING_LINK_MANAGEMENT = 4
580
- end
581
558
  end
582
559
  end
583
560
  end
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -70,7 +70,16 @@ module Google
70
70
  # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
71
  #
72
72
  #
73
- # Example 5: Compute Timestamp from current time in Python.
73
+ # Example 5: Compute Timestamp from Java `Instant.now()`.
74
+ #
75
+ # Instant now = Instant.now();
76
+ #
77
+ # Timestamp timestamp =
78
+ # Timestamp.newBuilder().setSeconds(now.getEpochSecond())
79
+ # .setNanos(now.getNano()).build();
80
+ #
81
+ #
82
+ # Example 6: Compute Timestamp from current time in Python.
74
83
  #
75
84
  # timestamp = Timestamp()
76
85
  # timestamp.GetCurrentTime()
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-analytics-admin-v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-10-14 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -152,7 +152,9 @@ dependencies:
152
152
  version: '0.9'
153
153
  description: The Analytics Admin API allows for programmatic access to the Google
154
154
  Analytics App+Web configuration data. You can use the Google Analytics Admin API
155
- to manage accounts and App+Web properties.
155
+ to manage accounts and App+Web properties. Note that google-analytics-admin-v1alpha
156
+ is a version-specific client library. For most uses, we recommend installing the
157
+ main client library google-analytics-admin instead. See the readme for more details.
156
158
  email: googleapis-packages@google.com
157
159
  executables: []
158
160
  extensions: []
@@ -200,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
200
202
  - !ruby/object:Gem::Version
201
203
  version: '0'
202
204
  requirements: []
203
- rubygems_version: 3.1.4
205
+ rubygems_version: 3.2.6
204
206
  signing_key:
205
207
  specification_version: 4
206
208
  summary: API Client library for the Google Analytics Admin V1alpha API