google-analytics-admin-v1alpha 0.1.0 → 0.3.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: 734c150c206623555963164c03111582e2a0f5b5e3dad9b34fa85e634be9c56f
4
- data.tar.gz: 4babe6d26fa7dd7bd472fc7aee75554f1b624b827bf0c8f088ecc4f9cf6be626
3
+ metadata.gz: 2fa9912c70452f75a9a47b08c027918ab245b4ffc160d9be1973d6c0ff5df796
4
+ data.tar.gz: 5b87868d3d1803532ae1ff6efd9660b00de7958a52f87785457708c469eedf3f
5
5
  SHA512:
6
- metadata.gz: 8d35ab3087ddc934517ad4f3064480817999fb8efdaa3f9ffcec135f8939dbed459ff7b196b57b0c0d7d723fa680a7c3e4ee9d5ec99249437249830fa860d549
7
- data.tar.gz: 7c5b8b37625c9ff93e8861aab526e5a2fc37ea906739a160f307b2bf163658b93b649128a3b6dc88b38544feecf39421d67c861876d702183ef26f608d9f0dd8
6
+ metadata.gz: 78f36f56669257e15a20aacc41cb0f05e7d1f11b1f4dd0ba825d3f9a303c3ed8e8cb94276d20b0b88fb5296656adf2e11c8ff96bd8f1e8b14432f6a2e2fb0337
7
+ data.tar.gz: 914d68eb554bdf7e4ce8e147e20711b208e79eb8a0b945a5ee4a5ad05e51f057f445eed625154b3f3e55a43c90baa17130cce91f57fc2ce1c96296cfaf0d6681
@@ -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
@@ -238,6 +238,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
238
238
  add_message "google.analytics.admin.v1alpha.GetDataSharingSettingsRequest" do
239
239
  optional :name, :string, 1
240
240
  end
241
+ add_message "google.analytics.admin.v1alpha.ListAccountSummariesRequest" do
242
+ optional :page_size, :int32, 1
243
+ optional :page_token, :string, 2
244
+ end
245
+ add_message "google.analytics.admin.v1alpha.ListAccountSummariesResponse" do
246
+ repeated :account_summaries, :message, 1, "google.analytics.admin.v1alpha.AccountSummary"
247
+ optional :next_page_token, :string, 2
248
+ end
241
249
  end
242
250
  end
243
251
 
@@ -305,6 +313,8 @@ module Google
305
313
  ListGoogleAdsLinksRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListGoogleAdsLinksRequest").msgclass
306
314
  ListGoogleAdsLinksResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListGoogleAdsLinksResponse").msgclass
307
315
  GetDataSharingSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetDataSharingSettingsRequest").msgclass
316
+ ListAccountSummariesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAccountSummariesRequest").msgclass
317
+ ListAccountSummariesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAccountSummariesResponse").msgclass
308
318
  end
309
319
  end
310
320
  end
@@ -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
@@ -315,7 +315,7 @@ module Google
315
315
  ##
316
316
  # Returns all accounts accessible by the caller.
317
317
  #
318
- # Note that these accounts might not currently have App+Web properties.
318
+ # Note that these accounts might not currently have GA4 properties.
319
319
  # Soft-deleted (ie: "trashed") accounts are excluded by default.
320
320
  # Returns an empty list if no relevant accounts are found.
321
321
  #
@@ -600,10 +600,79 @@ module Google
600
600
  end
601
601
 
602
602
  ##
603
- # Lookup for a single "App+Web" Property.
603
+ # Returns summaries of all accounts accessible by the caller.
604
+ #
605
+ # @overload list_account_summaries(request, options = nil)
606
+ # Pass arguments to `list_account_summaries` via a request object, either of type
607
+ # {::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest} or an equivalent Hash.
608
+ #
609
+ # @param request [::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest, ::Hash]
610
+ # A request object representing the call parameters. Required. To specify no
611
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
612
+ # @param options [::Gapic::CallOptions, ::Hash]
613
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
614
+ #
615
+ # @overload list_account_summaries(page_size: nil, page_token: nil)
616
+ # Pass arguments to `list_account_summaries` via keyword arguments. Note that at
617
+ # least one keyword argument is required. To specify no parameters, or to keep all
618
+ # the default parameter values, pass an empty Hash as a request object (see above).
619
+ #
620
+ # @param page_size [::Integer]
621
+ # The maximum number of AccountSummary resources to return. The service may
622
+ # return fewer than this value, even if there are additional pages.
623
+ # If unspecified, at most 50 resources will be returned.
624
+ # The maximum value is 200; (higher values will be coerced to the maximum)
625
+ # @param page_token [::String]
626
+ # A page token, received from a previous `ListAccountSummaries` call.
627
+ # Provide this to retrieve the subsequent page.
628
+ # When paginating, all other parameters provided to `ListAccountSummaries`
629
+ # must match the call that provided the page token.
630
+ #
631
+ # @yield [response, operation] Access the result along with the RPC operation
632
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>]
633
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
634
+ #
635
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>]
636
+ #
637
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
638
+ #
639
+ def list_account_summaries request, options = nil
640
+ raise ::ArgumentError, "request must be provided" if request.nil?
641
+
642
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest
643
+
644
+ # Converts hash and nil to an options object
645
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
646
+
647
+ # Customize the options with defaults
648
+ metadata = @config.rpcs.list_account_summaries.metadata.to_h
649
+
650
+ # Set x-goog-api-client and x-goog-user-project headers
651
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
652
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
653
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
654
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
655
+
656
+ options.apply_defaults timeout: @config.rpcs.list_account_summaries.timeout,
657
+ metadata: metadata,
658
+ retry_policy: @config.rpcs.list_account_summaries.retry_policy
659
+ options.apply_defaults metadata: @config.metadata,
660
+ retry_policy: @config.retry_policy
661
+
662
+ @analytics_admin_service_stub.call_rpc :list_account_summaries, request, options: options do |response, operation|
663
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_account_summaries, request, response, operation, options
664
+ yield response, operation if block_given?
665
+ return response
666
+ end
667
+ rescue ::GRPC::BadStatus => e
668
+ raise ::Google::Cloud::Error.from_error(e)
669
+ end
670
+
671
+ ##
672
+ # Lookup for a single "GA4" Property.
604
673
  #
605
674
  # Throws "Target not found" if no such property found, if property is not
606
- # of the type "App+Web", or if caller does not have permissions to access it.
675
+ # of the type "GA4", or if caller does not have permissions to access it.
607
676
  #
608
677
  # @overload get_property(request, options = nil)
609
678
  # Pass arguments to `get_property` via a request object, either of type
@@ -673,7 +742,7 @@ module Google
673
742
  ##
674
743
  # Returns child Properties under the specified parent Account.
675
744
  #
676
- # Only "App+Web" properties will be returned.
745
+ # Only "GA4" properties will be returned.
677
746
  # Properties will be excluded if the caller does not have access.
678
747
  # Soft-deleted (ie: "trashed") properties are excluded by default.
679
748
  # Returns an empty list if no relevant properties are found.
@@ -761,7 +830,7 @@ module Google
761
830
  end
762
831
 
763
832
  ##
764
- # Creates an "App+Web" property with the specified location and attributes.
833
+ # Creates an "GA4" property with the specified location and attributes.
765
834
  #
766
835
  # @overload create_property(request, options = nil)
767
836
  # Pass arguments to `create_property` via a request object, either of type
@@ -832,7 +901,7 @@ module Google
832
901
  # will be permanently purged.
833
902
  # https://support.google.com/analytics/answer/6154772
834
903
  #
835
- # Returns an error if the target is not found, or is not an App+Web Property.
904
+ # Returns an error if the target is not found, or is not an GA4 Property.
836
905
  #
837
906
  # @overload delete_property(request, options = nil)
838
907
  # Pass arguments to `delete_property` via a request object, either of type
@@ -1295,8 +1364,8 @@ module Google
1295
1364
  # @param parent [::String]
1296
1365
  # Required. Example format: accounts/1234
1297
1366
  # @param notify_new_user [::Boolean]
1298
- # Optional. If notify_new_user is set, then email new user that they've been given
1299
- # permissions on the resource.
1367
+ # Optional. If set, then email the new user notifying them that they've been granted
1368
+ # permissions to the resource.
1300
1369
  # @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
1301
1370
  # Required. The user link to create.
1302
1371
  #
@@ -1372,10 +1441,11 @@ module Google
1372
1441
  # messages must either be empty or match this field.
1373
1442
  # Example format: accounts/1234
1374
1443
  # @param notify_new_users [::Boolean]
1375
- # Optional. If notify_new_users is set, then email new users that they've been given
1376
- # permissions on the resource.
1444
+ # Optional. If set, then email the new users notifying them that they've been granted
1445
+ # permissions to the resource. Regardless of whether this is set or not,
1446
+ # notify_new_user field inside each individual request is ignored.
1377
1447
  # @param requests [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash>]
1378
- # The requests specifying the user links to create.
1448
+ # Required. The requests specifying the user links to create.
1379
1449
  # A maximum of 1000 user links can be created in a batch.
1380
1450
  #
1381
1451
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1513,7 +1583,7 @@ module Google
1513
1583
  # empty or match this field.
1514
1584
  # Example format: accounts/1234
1515
1585
  # @param requests [::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash>]
1516
- # The requests specifying the user links to update.
1586
+ # Required. The requests specifying the user links to update.
1517
1587
  # A maximum of 1000 user links can be updated in a batch.
1518
1588
  #
1519
1589
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1651,7 +1721,7 @@ module Google
1651
1721
  # field.
1652
1722
  # Example format: accounts/1234
1653
1723
  # @param requests [::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash>]
1654
- # The requests specifying the user links to update.
1724
+ # Required. The requests specifying the user links to update.
1655
1725
  # A maximum of 1000 user links can be updated in a batch.
1656
1726
  #
1657
1727
  # @yield [response, operation] Access the result along with the RPC operation
@@ -2798,6 +2868,7 @@ module Google
2798
2868
  # @param name [::String]
2799
2869
  # Required. The name of the settings to lookup.
2800
2870
  # Format:
2871
+ #
2801
2872
  # properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
2802
2873
  # Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
2803
2874
  #
@@ -3694,7 +3765,7 @@ module Google
3694
3765
 
3695
3766
  config_attr :endpoint, "analyticsadmin.googleapis.com", ::String
3696
3767
  config_attr :credentials, nil do |value|
3697
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3768
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3698
3769
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
3699
3770
  allowed.any? { |klass| klass === value }
3700
3771
  end
@@ -3771,6 +3842,11 @@ module Google
3771
3842
  #
3772
3843
  attr_reader :provision_account_ticket
3773
3844
  ##
3845
+ # RPC-specific configuration for `list_account_summaries`
3846
+ # @return [::Gapic::Config::Method]
3847
+ #
3848
+ attr_reader :list_account_summaries
3849
+ ##
3774
3850
  # RPC-specific configuration for `get_property`
3775
3851
  # @return [::Gapic::Config::Method]
3776
3852
  #
@@ -3993,6 +4069,8 @@ module Google
3993
4069
  @update_account = ::Gapic::Config::Method.new update_account_config
3994
4070
  provision_account_ticket_config = parent_rpcs&.provision_account_ticket if parent_rpcs&.respond_to? :provision_account_ticket
3995
4071
  @provision_account_ticket = ::Gapic::Config::Method.new provision_account_ticket_config
4072
+ list_account_summaries_config = parent_rpcs&.list_account_summaries if parent_rpcs&.respond_to? :list_account_summaries
4073
+ @list_account_summaries = ::Gapic::Config::Method.new list_account_summaries_config
3996
4074
  get_property_config = parent_rpcs&.get_property if parent_rpcs&.respond_to? :get_property
3997
4075
  @get_property = ::Gapic::Config::Method.new get_property_config
3998
4076
  list_properties_config = parent_rpcs&.list_properties if parent_rpcs&.respond_to? :list_properties
@@ -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
@@ -36,13 +36,13 @@ module Google
36
36
  # Lookup for a single Account.
37
37
  # Throws "Target not found" if no such account found, or if caller does not
38
38
  # have permissions to access it.
39
- rpc :GetAccount, Google::Analytics::Admin::V1alpha::GetAccountRequest, Google::Analytics::Admin::V1alpha::Account
39
+ rpc :GetAccount, ::Google::Analytics::Admin::V1alpha::GetAccountRequest, ::Google::Analytics::Admin::V1alpha::Account
40
40
  # Returns all accounts accessible by the caller.
41
41
  #
42
- # Note that these accounts might not currently have App+Web properties.
42
+ # Note that these accounts might not currently have GA4 properties.
43
43
  # Soft-deleted (ie: "trashed") accounts are excluded by default.
44
44
  # Returns an empty list if no relevant accounts are found.
45
- rpc :ListAccounts, Google::Analytics::Admin::V1alpha::ListAccountsRequest, Google::Analytics::Admin::V1alpha::ListAccountsResponse
45
+ rpc :ListAccounts, ::Google::Analytics::Admin::V1alpha::ListAccountsRequest, ::Google::Analytics::Admin::V1alpha::ListAccountsResponse
46
46
  # Marks target Account as soft-deleted (ie: "trashed") and returns it.
47
47
  #
48
48
  # This API does not have a method to restore soft-deleted accounts.
@@ -54,25 +54,27 @@ module Google
54
54
  # https://support.google.com/analytics/answer/6154772
55
55
  #
56
56
  # Returns an error if the target is not found.
57
- rpc :DeleteAccount, Google::Analytics::Admin::V1alpha::DeleteAccountRequest, Google::Protobuf::Empty
57
+ rpc :DeleteAccount, ::Google::Analytics::Admin::V1alpha::DeleteAccountRequest, ::Google::Protobuf::Empty
58
58
  # Updates an account.
59
- rpc :UpdateAccount, Google::Analytics::Admin::V1alpha::UpdateAccountRequest, Google::Analytics::Admin::V1alpha::Account
59
+ rpc :UpdateAccount, ::Google::Analytics::Admin::V1alpha::UpdateAccountRequest, ::Google::Analytics::Admin::V1alpha::Account
60
60
  # Requests a ticket for creating an account.
61
- rpc :ProvisionAccountTicket, Google::Analytics::Admin::V1alpha::ProvisionAccountTicketRequest, Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse
62
- # Lookup for a single "App+Web" Property.
61
+ rpc :ProvisionAccountTicket, ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketRequest, ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse
62
+ # Returns summaries of all accounts accessible by the caller.
63
+ rpc :ListAccountSummaries, ::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest, ::Google::Analytics::Admin::V1alpha::ListAccountSummariesResponse
64
+ # Lookup for a single "GA4" Property.
63
65
  #
64
66
  # Throws "Target not found" if no such property found, if property is not
65
- # of the type "App+Web", or if caller does not have permissions to access it.
66
- rpc :GetProperty, Google::Analytics::Admin::V1alpha::GetPropertyRequest, Google::Analytics::Admin::V1alpha::Property
67
+ # of the type "GA4", or if caller does not have permissions to access it.
68
+ rpc :GetProperty, ::Google::Analytics::Admin::V1alpha::GetPropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
67
69
  # Returns child Properties under the specified parent Account.
68
70
  #
69
- # Only "App+Web" properties will be returned.
71
+ # Only "GA4" properties will be returned.
70
72
  # Properties will be excluded if the caller does not have access.
71
73
  # Soft-deleted (ie: "trashed") properties are excluded by default.
72
74
  # Returns an empty list if no relevant properties are found.
73
- rpc :ListProperties, Google::Analytics::Admin::V1alpha::ListPropertiesRequest, Google::Analytics::Admin::V1alpha::ListPropertiesResponse
74
- # Creates an "App+Web" property with the specified location and attributes.
75
- rpc :CreateProperty, Google::Analytics::Admin::V1alpha::CreatePropertyRequest, Google::Analytics::Admin::V1alpha::Property
75
+ rpc :ListProperties, ::Google::Analytics::Admin::V1alpha::ListPropertiesRequest, ::Google::Analytics::Admin::V1alpha::ListPropertiesResponse
76
+ # Creates an "GA4" property with the specified location and attributes.
77
+ rpc :CreateProperty, ::Google::Analytics::Admin::V1alpha::CreatePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
76
78
  # Marks target Property as soft-deleted (ie: "trashed") and returns it.
77
79
  #
78
80
  # This API does not have a method to restore soft-deleted properties.
@@ -83,16 +85,16 @@ module Google
83
85
  # will be permanently purged.
84
86
  # https://support.google.com/analytics/answer/6154772
85
87
  #
86
- # Returns an error if the target is not found, or is not an App+Web Property.
87
- rpc :DeleteProperty, Google::Analytics::Admin::V1alpha::DeletePropertyRequest, Google::Protobuf::Empty
88
+ # Returns an error if the target is not found, or is not an GA4 Property.
89
+ rpc :DeleteProperty, ::Google::Analytics::Admin::V1alpha::DeletePropertyRequest, ::Google::Protobuf::Empty
88
90
  # Updates a property.
89
- rpc :UpdateProperty, Google::Analytics::Admin::V1alpha::UpdatePropertyRequest, Google::Analytics::Admin::V1alpha::Property
91
+ rpc :UpdateProperty, ::Google::Analytics::Admin::V1alpha::UpdatePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
90
92
  # Gets information about a user's link to an account or property.
91
- rpc :GetUserLink, Google::Analytics::Admin::V1alpha::GetUserLinkRequest, Google::Analytics::Admin::V1alpha::UserLink
93
+ rpc :GetUserLink, ::Google::Analytics::Admin::V1alpha::GetUserLinkRequest, ::Google::Analytics::Admin::V1alpha::UserLink
92
94
  # Gets information about multiple users' links to an account or property.
93
- rpc :BatchGetUserLinks, Google::Analytics::Admin::V1alpha::BatchGetUserLinksRequest, Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse
95
+ rpc :BatchGetUserLinks, ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksRequest, ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse
94
96
  # Lists all user links on an account or property.
95
- rpc :ListUserLinks, Google::Analytics::Admin::V1alpha::ListUserLinksRequest, Google::Analytics::Admin::V1alpha::ListUserLinksResponse
97
+ rpc :ListUserLinks, ::Google::Analytics::Admin::V1alpha::ListUserLinksRequest, ::Google::Analytics::Admin::V1alpha::ListUserLinksResponse
96
98
  # Lists all user links on an account or property, including implicit ones
97
99
  # that come from effective permissions granted by groups or organization
98
100
  # admin roles.
@@ -102,107 +104,107 @@ module Google
102
104
  # command. They have to be removed from the group/etc that gives them
103
105
  # permissions, which is currently only usable/discoverable in the GA or GMP
104
106
  # UIs.
105
- rpc :AuditUserLinks, Google::Analytics::Admin::V1alpha::AuditUserLinksRequest, Google::Analytics::Admin::V1alpha::AuditUserLinksResponse
107
+ rpc :AuditUserLinks, ::Google::Analytics::Admin::V1alpha::AuditUserLinksRequest, ::Google::Analytics::Admin::V1alpha::AuditUserLinksResponse
106
108
  # Creates a user link on an account or property.
107
109
  #
108
110
  # If the user with the specified email already has permissions on the
109
111
  # account or property, then the user's existing permissions will be unioned
110
112
  # with the permissions specified in the new UserLink.
111
- rpc :CreateUserLink, Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, Google::Analytics::Admin::V1alpha::UserLink
113
+ rpc :CreateUserLink, ::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Google::Analytics::Admin::V1alpha::UserLink
112
114
  # Creates information about multiple users' links to an account or property.
113
115
  #
114
116
  # This method is transactional. If any UserLink cannot be created, none of
115
117
  # the UserLinks will be created.
116
- rpc :BatchCreateUserLinks, Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest, Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse
118
+ rpc :BatchCreateUserLinks, ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest, ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse
117
119
  # Updates a user link on an account or property.
118
- rpc :UpdateUserLink, Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, Google::Analytics::Admin::V1alpha::UserLink
120
+ rpc :UpdateUserLink, ::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Google::Analytics::Admin::V1alpha::UserLink
119
121
  # Updates information about multiple users' links to an account or property.
120
- rpc :BatchUpdateUserLinks, Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest, Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse
122
+ rpc :BatchUpdateUserLinks, ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest, ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse
121
123
  # Deletes a user link on an account or property.
122
- rpc :DeleteUserLink, Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, Google::Protobuf::Empty
124
+ rpc :DeleteUserLink, ::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Google::Protobuf::Empty
123
125
  # Deletes information about multiple users' links to an account or property.
124
- rpc :BatchDeleteUserLinks, Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest, Google::Protobuf::Empty
126
+ rpc :BatchDeleteUserLinks, ::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest, ::Google::Protobuf::Empty
125
127
  # Lookup for a single WebDataStream
126
128
  #
127
129
  # Throws "Target not found" if no such web data stream found, or if the
128
130
  # caller does not have permissions to access it.
129
- rpc :GetWebDataStream, Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest, Google::Analytics::Admin::V1alpha::WebDataStream
131
+ rpc :GetWebDataStream, ::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest, ::Google::Analytics::Admin::V1alpha::WebDataStream
130
132
  # Deletes a web stream on a property.
131
- rpc :DeleteWebDataStream, Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest, Google::Protobuf::Empty
133
+ rpc :DeleteWebDataStream, ::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest, ::Google::Protobuf::Empty
132
134
  # Updates a web stream on a property.
133
- rpc :UpdateWebDataStream, Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest, Google::Analytics::Admin::V1alpha::WebDataStream
135
+ rpc :UpdateWebDataStream, ::Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest, ::Google::Analytics::Admin::V1alpha::WebDataStream
134
136
  # Creates a web stream with the specified location and attributes.
135
- rpc :CreateWebDataStream, Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest, Google::Analytics::Admin::V1alpha::WebDataStream
137
+ rpc :CreateWebDataStream, ::Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest, ::Google::Analytics::Admin::V1alpha::WebDataStream
136
138
  # Returns child web data streams under the specified parent property.
137
139
  #
138
140
  # Web data streams will be excluded if the caller does not have access.
139
141
  # Returns an empty list if no relevant web data streams are found.
140
- rpc :ListWebDataStreams, Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest, Google::Analytics::Admin::V1alpha::ListWebDataStreamsResponse
142
+ rpc :ListWebDataStreams, ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsResponse
141
143
  # Lookup for a single IosAppDataStream
142
144
  #
143
145
  # Throws "Target not found" if no such iOS app data stream found, or if the
144
146
  # caller does not have permissions to access it.
145
- rpc :GetIosAppDataStream, Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest, Google::Analytics::Admin::V1alpha::IosAppDataStream
147
+ rpc :GetIosAppDataStream, ::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::IosAppDataStream
146
148
  # Deletes an iOS app stream on a property.
147
- rpc :DeleteIosAppDataStream, Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest, Google::Protobuf::Empty
149
+ rpc :DeleteIosAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest, ::Google::Protobuf::Empty
148
150
  # Updates an iOS app stream on a property.
149
- rpc :UpdateIosAppDataStream, Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest, Google::Analytics::Admin::V1alpha::IosAppDataStream
151
+ rpc :UpdateIosAppDataStream, ::Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::IosAppDataStream
150
152
  # Creates an iOS app data stream with the specified location and attributes.
151
- rpc :CreateIosAppDataStream, Google::Analytics::Admin::V1alpha::CreateIosAppDataStreamRequest, Google::Analytics::Admin::V1alpha::IosAppDataStream
153
+ rpc :CreateIosAppDataStream, ::Google::Analytics::Admin::V1alpha::CreateIosAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::IosAppDataStream
152
154
  # Returns child iOS app data streams under the specified parent property.
153
155
  #
154
156
  # iOS app data streams will be excluded if the caller does not have access.
155
157
  # Returns an empty list if no relevant iOS app data streams are found.
156
- rpc :ListIosAppDataStreams, Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest, Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsResponse
158
+ rpc :ListIosAppDataStreams, ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsResponse
157
159
  # Lookup for a single AndroidAppDataStream
158
160
  #
159
161
  # Throws "Target not found" if no such android app data stream found, or if
160
162
  # the caller does not have permissions to access it.
161
- rpc :GetAndroidAppDataStream, Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest, Google::Analytics::Admin::V1alpha::AndroidAppDataStream
163
+ rpc :GetAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
162
164
  # Deletes an android app stream on a property.
163
- rpc :DeleteAndroidAppDataStream, Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest, Google::Protobuf::Empty
165
+ rpc :DeleteAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest, ::Google::Protobuf::Empty
164
166
  # Updates an android app stream on a property.
165
- rpc :UpdateAndroidAppDataStream, Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest, Google::Analytics::Admin::V1alpha::AndroidAppDataStream
167
+ rpc :UpdateAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
166
168
  # Creates an android app stream with the specified location and attributes.
167
- rpc :CreateAndroidAppDataStream, Google::Analytics::Admin::V1alpha::CreateAndroidAppDataStreamRequest, Google::Analytics::Admin::V1alpha::AndroidAppDataStream
169
+ rpc :CreateAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::CreateAndroidAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
168
170
  # Returns child android app streams under the specified parent property.
169
171
  #
170
172
  # Android app streams will be excluded if the caller does not have access.
171
173
  # Returns an empty list if no relevant android app streams are found.
172
- rpc :ListAndroidAppDataStreams, Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest, Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsResponse
174
+ rpc :ListAndroidAppDataStreams, ::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsResponse
173
175
  # Returns the singleton enhanced measurement settings for this web stream.
174
176
  # Note that the stream must enable enhanced measurement for these settings to
175
177
  # take effect.
176
- rpc :GetEnhancedMeasurementSettings, Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
178
+ rpc :GetEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
177
179
  # Updates the singleton enhanced measurement settings for this web stream.
178
180
  # Note that the stream must enable enhanced measurement for these settings to
179
181
  # take effect.
180
- rpc :UpdateEnhancedMeasurementSettings, Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
182
+ rpc :UpdateEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
181
183
  # Creates a FirebaseLink.
182
184
  #
183
185
  # Properties can have at most one FirebaseLink.
184
- rpc :CreateFirebaseLink, Google::Analytics::Admin::V1alpha::CreateFirebaseLinkRequest, Google::Analytics::Admin::V1alpha::FirebaseLink
186
+ rpc :CreateFirebaseLink, ::Google::Analytics::Admin::V1alpha::CreateFirebaseLinkRequest, ::Google::Analytics::Admin::V1alpha::FirebaseLink
185
187
  # Updates a FirebaseLink on a property
186
- rpc :UpdateFirebaseLink, Google::Analytics::Admin::V1alpha::UpdateFirebaseLinkRequest, Google::Analytics::Admin::V1alpha::FirebaseLink
188
+ rpc :UpdateFirebaseLink, ::Google::Analytics::Admin::V1alpha::UpdateFirebaseLinkRequest, ::Google::Analytics::Admin::V1alpha::FirebaseLink
187
189
  # Deletes a FirebaseLink on a property
188
- rpc :DeleteFirebaseLink, Google::Analytics::Admin::V1alpha::DeleteFirebaseLinkRequest, Google::Protobuf::Empty
190
+ rpc :DeleteFirebaseLink, ::Google::Analytics::Admin::V1alpha::DeleteFirebaseLinkRequest, ::Google::Protobuf::Empty
189
191
  # Lists FirebaseLinks on a property.
190
192
  # Properties can have at most one FirebaseLink.
191
- rpc :ListFirebaseLinks, Google::Analytics::Admin::V1alpha::ListFirebaseLinksRequest, Google::Analytics::Admin::V1alpha::ListFirebaseLinksResponse
193
+ rpc :ListFirebaseLinks, ::Google::Analytics::Admin::V1alpha::ListFirebaseLinksRequest, ::Google::Analytics::Admin::V1alpha::ListFirebaseLinksResponse
192
194
  # Returns the Site Tag for the specified web stream.
193
195
  # Site Tags are immutable singletons.
194
- rpc :GetGlobalSiteTag, Google::Analytics::Admin::V1alpha::GetGlobalSiteTagRequest, Google::Analytics::Admin::V1alpha::GlobalSiteTag
196
+ rpc :GetGlobalSiteTag, ::Google::Analytics::Admin::V1alpha::GetGlobalSiteTagRequest, ::Google::Analytics::Admin::V1alpha::GlobalSiteTag
195
197
  # Creates a GoogleAdsLink.
196
- rpc :CreateGoogleAdsLink, Google::Analytics::Admin::V1alpha::CreateGoogleAdsLinkRequest, Google::Analytics::Admin::V1alpha::GoogleAdsLink
198
+ rpc :CreateGoogleAdsLink, ::Google::Analytics::Admin::V1alpha::CreateGoogleAdsLinkRequest, ::Google::Analytics::Admin::V1alpha::GoogleAdsLink
197
199
  # Updates a GoogleAdsLink on a property
198
- rpc :UpdateGoogleAdsLink, Google::Analytics::Admin::V1alpha::UpdateGoogleAdsLinkRequest, Google::Analytics::Admin::V1alpha::GoogleAdsLink
200
+ rpc :UpdateGoogleAdsLink, ::Google::Analytics::Admin::V1alpha::UpdateGoogleAdsLinkRequest, ::Google::Analytics::Admin::V1alpha::GoogleAdsLink
199
201
  # Deletes a GoogleAdsLink on a property
200
- rpc :DeleteGoogleAdsLink, Google::Analytics::Admin::V1alpha::DeleteGoogleAdsLinkRequest, Google::Protobuf::Empty
202
+ rpc :DeleteGoogleAdsLink, ::Google::Analytics::Admin::V1alpha::DeleteGoogleAdsLinkRequest, ::Google::Protobuf::Empty
201
203
  # Lists GoogleAdsLinks on a property.
202
- rpc :ListGoogleAdsLinks, Google::Analytics::Admin::V1alpha::ListGoogleAdsLinksRequest, Google::Analytics::Admin::V1alpha::ListGoogleAdsLinksResponse
204
+ rpc :ListGoogleAdsLinks, ::Google::Analytics::Admin::V1alpha::ListGoogleAdsLinksRequest, ::Google::Analytics::Admin::V1alpha::ListGoogleAdsLinksResponse
203
205
  # Get data sharing settings on an account.
204
206
  # Data sharing settings are singletons.
205
- rpc :GetDataSharingSettings, Google::Analytics::Admin::V1alpha::GetDataSharingSettingsRequest, Google::Analytics::Admin::V1alpha::DataSharingSettings
207
+ rpc :GetDataSharingSettings, ::Google::Analytics::Admin::V1alpha::GetDataSharingSettingsRequest, ::Google::Analytics::Admin::V1alpha::DataSharingSettings
206
208
  end
207
209
 
208
210
  Stub = Service.rpc_stub_class
@@ -92,6 +92,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
92
92
  end
93
93
  add_message "google.analytics.admin.v1alpha.GlobalSiteTag" do
94
94
  optional :snippet, :string, 1
95
+ optional :name, :string, 2
95
96
  end
96
97
  add_message "google.analytics.admin.v1alpha.GoogleAdsLink" do
97
98
  optional :name, :string, 1
@@ -111,6 +112,23 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
111
112
  optional :sharing_with_google_products_enabled, :bool, 5
112
113
  optional :sharing_with_others_enabled, :bool, 6
113
114
  end
115
+ add_message "google.analytics.admin.v1alpha.AccountSummary" do
116
+ optional :name, :string, 1
117
+ optional :account, :string, 2
118
+ optional :display_name, :string, 3
119
+ repeated :property_summaries, :message, 4, "google.analytics.admin.v1alpha.PropertySummary"
120
+ end
121
+ add_message "google.analytics.admin.v1alpha.PropertySummary" do
122
+ optional :property, :string, 1
123
+ optional :display_name, :string, 2
124
+ end
125
+ add_enum "google.analytics.admin.v1alpha.MaximumUserAccess" do
126
+ value :MAXIMUM_USER_ACCESS_UNSPECIFIED, 0
127
+ value :NO_ACCESS, 1
128
+ value :READ_AND_ANALYZE, 2
129
+ value :EDITOR_WITHOUT_LINK_MANAGEMENT, 3
130
+ value :EDITOR_INCLUDING_LINK_MANAGEMENT, 4
131
+ end
114
132
  add_enum "google.analytics.admin.v1alpha.IndustryCategory" do
115
133
  value :INDUSTRY_CATEGORY_UNSPECIFIED, 0
116
134
  value :AUTOMOTIVE, 1
@@ -140,13 +158,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
140
158
  value :JOBS_AND_EDUCATION, 25
141
159
  value :SHOPPING, 26
142
160
  end
143
- add_enum "google.analytics.admin.v1alpha.MaximumUserAccess" do
144
- value :MAXIMUM_USER_ACCESS_UNSPECIFIED, 0
145
- value :NO_ACCESS, 1
146
- value :READ_AND_ANALYZE, 2
147
- value :EDITOR_WITHOUT_LINK_MANAGEMENT, 3
148
- value :EDITOR_INCLUDING_LINK_MANAGEMENT, 4
149
- end
150
161
  end
151
162
  end
152
163
 
@@ -166,8 +177,10 @@ module Google
166
177
  GlobalSiteTag = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GlobalSiteTag").msgclass
167
178
  GoogleAdsLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GoogleAdsLink").msgclass
168
179
  DataSharingSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataSharingSettings").msgclass
169
- IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
180
+ AccountSummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AccountSummary").msgclass
181
+ PropertySummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.PropertySummary").msgclass
170
182
  MaximumUserAccess = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.MaximumUserAccess").enummodule
183
+ IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
171
184
  end
172
185
  end
173
186
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Analytics
22
22
  module Admin
23
23
  module V1alpha
24
- VERSION = "0.1.0"
24
+ VERSION = "0.3.0"
25
25
  end
26
26
  end
27
27
  end
@@ -326,8 +326,8 @@ module Google
326
326
  # Required. Example format: accounts/1234
327
327
  # @!attribute [rw] notify_new_user
328
328
  # @return [::Boolean]
329
- # Optional. If notify_new_user is set, then email new user that they've been given
330
- # permissions on the resource.
329
+ # Optional. If set, then email the new user notifying them that they've been granted
330
+ # permissions to the resource.
331
331
  # @!attribute [rw] user_link
332
332
  # @return [::Google::Analytics::Admin::V1alpha::UserLink]
333
333
  # Required. The user link to create.
@@ -345,11 +345,12 @@ module Google
345
345
  # Example format: accounts/1234
346
346
  # @!attribute [rw] notify_new_users
347
347
  # @return [::Boolean]
348
- # Optional. If notify_new_users is set, then email new users that they've been given
349
- # permissions on the resource.
348
+ # Optional. If set, then email the new users notifying them that they've been granted
349
+ # permissions to the resource. Regardless of whether this is set or not,
350
+ # notify_new_user field inside each individual request is ignored.
350
351
  # @!attribute [rw] requests
351
352
  # @return [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest>]
352
- # The requests specifying the user links to create.
353
+ # Required. The requests specifying the user links to create.
353
354
  # A maximum of 1000 user links can be created in a batch.
354
355
  class BatchCreateUserLinksRequest
355
356
  include ::Google::Protobuf::MessageExts
@@ -383,7 +384,7 @@ module Google
383
384
  # Example format: accounts/1234
384
385
  # @!attribute [rw] requests
385
386
  # @return [::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest>]
386
- # The requests specifying the user links to update.
387
+ # Required. The requests specifying the user links to update.
387
388
  # A maximum of 1000 user links can be updated in a batch.
388
389
  class BatchUpdateUserLinksRequest
389
390
  include ::Google::Protobuf::MessageExts
@@ -417,7 +418,7 @@ module Google
417
418
  # Example format: accounts/1234
418
419
  # @!attribute [rw] requests
419
420
  # @return [::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest>]
420
- # The requests specifying the user links to update.
421
+ # Required. The requests specifying the user links to update.
421
422
  # A maximum of 1000 user links can be updated in a batch.
422
423
  class BatchDeleteUserLinksRequest
423
424
  include ::Google::Protobuf::MessageExts
@@ -680,6 +681,7 @@ module Google
680
681
  # @return [::String]
681
682
  # Required. The name of the settings to lookup.
682
683
  # Format:
684
+ #
683
685
  # properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
684
686
  # Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
685
687
  class GetEnhancedMeasurementSettingsRequest
@@ -843,6 +845,37 @@ module Google
843
845
  include ::Google::Protobuf::MessageExts
844
846
  extend ::Google::Protobuf::MessageExts::ClassMethods
845
847
  end
848
+
849
+ # Request message for ListAccountSummaries RPC.
850
+ # @!attribute [rw] page_size
851
+ # @return [::Integer]
852
+ # The maximum number of AccountSummary resources to return. The service may
853
+ # return fewer than this value, even if there are additional pages.
854
+ # If unspecified, at most 50 resources will be returned.
855
+ # The maximum value is 200; (higher values will be coerced to the maximum)
856
+ # @!attribute [rw] page_token
857
+ # @return [::String]
858
+ # A page token, received from a previous `ListAccountSummaries` call.
859
+ # Provide this to retrieve the subsequent page.
860
+ # When paginating, all other parameters provided to `ListAccountSummaries`
861
+ # must match the call that provided the page token.
862
+ class ListAccountSummariesRequest
863
+ include ::Google::Protobuf::MessageExts
864
+ extend ::Google::Protobuf::MessageExts::ClassMethods
865
+ end
866
+
867
+ # Response message for ListAccountSummaries RPC.
868
+ # @!attribute [rw] account_summaries
869
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccountSummary>]
870
+ # Account summaries of all accounts the caller has access to.
871
+ # @!attribute [rw] next_page_token
872
+ # @return [::String]
873
+ # A token, which can be sent as `page_token` to retrieve the next page.
874
+ # If this field is omitted, there are no subsequent pages.
875
+ class ListAccountSummariesResponse
876
+ include ::Google::Protobuf::MessageExts
877
+ extend ::Google::Protobuf::MessageExts::ClassMethods
878
+ end
846
879
  end
847
880
  end
848
881
  end
@@ -39,7 +39,10 @@ module Google
39
39
  # @!attribute [rw] country_code
40
40
  # @return [::String]
41
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
42
+ #
43
+ # https:
44
+ # //unicode.org/cldr/charts/latest/supplem
45
+ # // ental/territory_containment_un_m_49.html
43
46
  # @!attribute [r] deleted
44
47
  # @return [::Boolean]
45
48
  # Output only. Indicates whether this Account is soft-deleted or not. Deleted
@@ -49,7 +52,7 @@ module Google
49
52
  extend ::Google::Protobuf::MessageExts::ClassMethods
50
53
  end
51
54
 
52
- # A resource message representing a Google Analytics App+Web property.
55
+ # A resource message representing a Google Analytics GA4 property.
53
56
  # @!attribute [r] name
54
57
  # @return [::String]
55
58
  # Output only. Resource name of this property.
@@ -97,8 +100,9 @@ module Google
97
100
  # Examples: "USD", "EUR", "JPY"
98
101
  # @!attribute [r] deleted
99
102
  # @return [::Boolean]
100
- # Output only. Indicates whether this Property is soft-deleted or not. Deleted properties
101
- # are excluded from List results unless specifically requested.
103
+ # Output only. Indicates whether this Property is soft-deleted or not.
104
+ # Deleted properties are excluded from List results unless specifically
105
+ # requested.
102
106
  class Property
103
107
  include ::Google::Protobuf::MessageExts
104
108
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -258,6 +262,7 @@ module Google
258
262
  # @return [::String]
259
263
  # Output only. Resource name of this Data Stream.
260
264
  # Format:
265
+ #
261
266
  # properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
262
267
  # Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
263
268
  # @!attribute [rw] stream_enabled
@@ -269,8 +274,8 @@ module Google
269
274
  # whether they are respected.
270
275
  # @!attribute [r] page_views_enabled
271
276
  # @return [::Boolean]
272
- # Output only. If enabled, capture a page view event each time a page loads or the
273
- # website changes the browser history state.
277
+ # Output only. If enabled, capture a page view event each time a page loads
278
+ # or the website changes the browser history state.
274
279
  # @!attribute [rw] scrolls_enabled
275
280
  # @return [::Boolean]
276
281
  # If enabled, capture scroll events each time a visitor gets to the bottom of
@@ -334,15 +339,15 @@ module Google
334
339
  extend ::Google::Protobuf::MessageExts::ClassMethods
335
340
  end
336
341
 
337
- # A link between an App+Web property and a Firebase project.
342
+ # A link between an GA4 property and a Firebase project.
338
343
  # @!attribute [r] name
339
344
  # @return [::String]
340
345
  # Output only. Example format: properties/1234/firebaseLinks/5678
341
346
  # @!attribute [rw] project
342
347
  # @return [::String]
343
- # Immutable. Firebase project resource name. When creating a FirebaseLink, you may
344
- # provide this resource name using either a project number or project ID.
345
- # Once this resource has been created, returned FirebaseLinks will always
348
+ # Immutable. Firebase project resource name. When creating a FirebaseLink,
349
+ # you may provide this resource name using either a project number or project
350
+ # ID. Once this resource has been created, returned FirebaseLinks will always
346
351
  # have a project_name that contains a project number.
347
352
  #
348
353
  # Format: 'projects/\\{project number}'
@@ -352,7 +357,7 @@ module Google
352
357
  # Output only. Time when this FirebaseLink was originally created.
353
358
  # @!attribute [rw] maximum_user_access
354
359
  # @return [::Google::Analytics::Admin::V1alpha::MaximumUserAccess]
355
- # Maximum user access to the App + Web property allowed to admins of
360
+ # Maximum user access to the GA4 property allowed to admins of
356
361
  # the linked Firebase project.
357
362
  class FirebaseLink
358
363
  include ::Google::Protobuf::MessageExts
@@ -363,17 +368,21 @@ module Google
363
368
  # WebDataStream.
364
369
  # @!attribute [rw] snippet
365
370
  # @return [::String]
366
- # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of
367
- # every webpage to measure.
371
+ # Immutable. JavaScript code snippet to be pasted as the first item into the
372
+ # head tag of every webpage to measure.
373
+ # @!attribute [rw] name
374
+ # @return [::String]
375
+ # The resource name of this tag.
368
376
  class GlobalSiteTag
369
377
  include ::Google::Protobuf::MessageExts
370
378
  extend ::Google::Protobuf::MessageExts::ClassMethods
371
379
  end
372
380
 
373
- # A link between an App+Web property and a Google Ads account.
381
+ # A link between an GA4 property and a Google Ads account.
374
382
  # @!attribute [r] name
375
383
  # @return [::String]
376
- # Output only. Format: properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
384
+ # Output only. Format:
385
+ # properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
377
386
  #
378
387
  # Note: googleAdsLinkId is not the Google Ads customer ID.
379
388
  # @!attribute [rw] parent
@@ -437,6 +446,64 @@ module Google
437
446
  extend ::Google::Protobuf::MessageExts::ClassMethods
438
447
  end
439
448
 
449
+ # A virtual resource representing an overview of an account and
450
+ # all its child GA4 properties.
451
+ # @!attribute [rw] name
452
+ # @return [::String]
453
+ # Resource name for this account summary.
454
+ # Format: accountSummaries/\\{account_id}
455
+ # Example: "accountSummaries/1000"
456
+ # @!attribute [rw] account
457
+ # @return [::String]
458
+ # Resource name of account referred to by this account summary
459
+ # Format: accounts/\\{account_id}
460
+ # Example: "accounts/1000"
461
+ # @!attribute [rw] display_name
462
+ # @return [::String]
463
+ # Display name for the account referred to in this account summary.
464
+ # @!attribute [rw] property_summaries
465
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::PropertySummary>]
466
+ # List of summaries for child accounts of this account.
467
+ class AccountSummary
468
+ include ::Google::Protobuf::MessageExts
469
+ extend ::Google::Protobuf::MessageExts::ClassMethods
470
+ end
471
+
472
+ # A virtual resource representing metadata for an GA4 property.
473
+ # @!attribute [rw] property
474
+ # @return [::String]
475
+ # Resource name of property referred to by this property summary
476
+ # Format: properties/\\{property_id}
477
+ # Example: "properties/1000"
478
+ # @!attribute [rw] display_name
479
+ # @return [::String]
480
+ # Display name for the property referred to in this account summary.
481
+ class PropertySummary
482
+ include ::Google::Protobuf::MessageExts
483
+ extend ::Google::Protobuf::MessageExts::ClassMethods
484
+ end
485
+
486
+ # Maximum access settings that Firebase user receive on the linked Analytics
487
+ # property.
488
+ module MaximumUserAccess
489
+ # Unspecified maximum user access.
490
+ MAXIMUM_USER_ACCESS_UNSPECIFIED = 0
491
+
492
+ # Firebase users have no access to the Analytics property.
493
+ NO_ACCESS = 1
494
+
495
+ # Firebase users have Read & Analyze access to the Analytics property.
496
+ READ_AND_ANALYZE = 2
497
+
498
+ # Firebase users have edit access to the Analytics property, but may not
499
+ # manage the Firebase link.
500
+ EDITOR_WITHOUT_LINK_MANAGEMENT = 3
501
+
502
+ # Firebase users have edit access to the Analytics property and may manage
503
+ # the Firebase link.
504
+ EDITOR_INCLUDING_LINK_MANAGEMENT = 4
505
+ end
506
+
440
507
  # The category selected for this property, used for industry benchmarking.
441
508
  module IndustryCategory
442
509
  # Industry category unspecified
@@ -520,27 +587,6 @@ module Google
520
587
  # Shopping
521
588
  SHOPPING = 26
522
589
  end
523
-
524
- # Maximum access settings that Firebase user receive on the linked Analytics
525
- # property.
526
- module MaximumUserAccess
527
- # Unspecified maximum user access.
528
- MAXIMUM_USER_ACCESS_UNSPECIFIED = 0
529
-
530
- # Firebase users have no access to the Analytics property.
531
- NO_ACCESS = 1
532
-
533
- # Firebase users have Read & Analyze access to the Analytics property.
534
- READ_AND_ANALYZE = 2
535
-
536
- # Firebase users have edit access to the Analytics property, but may not
537
- # manage the Firebase link.
538
- EDITOR_WITHOUT_LINK_MANAGEMENT = 3
539
-
540
- # Firebase users have edit access to the Analytics property and may manage
541
- # the Firebase link.
542
- EDITOR_INCLUDING_LINK_MANAGEMENT = 4
543
- end
544
590
  end
545
591
  end
546
592
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.1.0
4
+ version: 0.3.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-08-06 00:00:00.000000000 Z
11
+ date: 2020-12-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
200
200
  - !ruby/object:Gem::Version
201
201
  version: '0'
202
202
  requirements: []
203
- rubygems_version: 3.1.3
203
+ rubygems_version: 3.1.4
204
204
  signing_key:
205
205
  specification_version: 4
206
206
  summary: API Client library for the Google Analytics Admin V1alpha API