google-analytics-admin-v1alpha 0.40.0 → 0.41.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.
@@ -338,12 +338,12 @@ module Google
338
338
  # the default parameter values, pass an empty Hash as a request object (see above).
339
339
  #
340
340
  # @param page_size [::Integer]
341
- # The maximum number of resources to return. The service may return
341
+ # Optional. The maximum number of resources to return. The service may return
342
342
  # fewer than this value, even if there are additional pages.
343
343
  # If unspecified, at most 50 resources will be returned.
344
344
  # The maximum value is 200; (higher values will be coerced to the maximum)
345
345
  # @param page_token [::String]
346
- # A page token, received from a previous `ListAccounts` call.
346
+ # Optional. A page token, received from a previous `ListAccounts` call.
347
347
  # Provide this to retrieve the subsequent page.
348
348
  # When paginating, all other parameters provided to `ListAccounts` must
349
349
  # match the call that provided the page token.
@@ -701,15 +701,15 @@ module Google
701
701
  # the default parameter values, pass an empty Hash as a request object (see above).
702
702
  #
703
703
  # @param page_size [::Integer]
704
- # The maximum number of AccountSummary resources to return. The service may
705
- # return fewer than this value, even if there are additional pages.
706
- # If unspecified, at most 50 resources will be returned.
707
- # The maximum value is 200; (higher values will be coerced to the maximum)
704
+ # Optional. The maximum number of AccountSummary resources to return. The
705
+ # service may return fewer than this value, even if there are additional
706
+ # pages. If unspecified, at most 50 resources will be returned. The maximum
707
+ # value is 200; (higher values will be coerced to the maximum)
708
708
  # @param page_token [::String]
709
- # A page token, received from a previous `ListAccountSummaries` call.
710
- # Provide this to retrieve the subsequent page.
711
- # When paginating, all other parameters provided to `ListAccountSummaries`
712
- # must match the call that provided the page token.
709
+ # Optional. A page token, received from a previous `ListAccountSummaries`
710
+ # call. Provide this to retrieve the subsequent page. When paginating, all
711
+ # other parameters provided to `ListAccountSummaries` must match the call
712
+ # that provided the page token.
713
713
  #
714
714
  # @yield [response, operation] Access the result along with the RPC operation
715
715
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>]
@@ -900,12 +900,12 @@ module Google
900
900
  # | firebase_project:123 | The firebase project with number: 123. |
901
901
  # ```
902
902
  # @param page_size [::Integer]
903
- # The maximum number of resources to return. The service may return
903
+ # Optional. The maximum number of resources to return. The service may return
904
904
  # fewer than this value, even if there are additional pages.
905
905
  # If unspecified, at most 50 resources will be returned.
906
906
  # The maximum value is 200; (higher values will be coerced to the maximum)
907
907
  # @param page_token [::String]
908
- # A page token, received from a previous `ListProperties` call.
908
+ # Optional. A page token, received from a previous `ListProperties` call.
909
909
  # Provide this to retrieve the subsequent page.
910
910
  # When paginating, all other parameters provided to `ListProperties` must
911
911
  # match the call that provided the page token.
@@ -1446,12 +1446,12 @@ module Google
1446
1446
  #
1447
1447
  # Example: `properties/1234`
1448
1448
  # @param page_size [::Integer]
1449
- # The maximum number of resources to return. The service may return
1449
+ # Optional. The maximum number of resources to return. The service may return
1450
1450
  # fewer than this value, even if there are additional pages.
1451
1451
  # If unspecified, at most 50 resources will be returned.
1452
1452
  # The maximum value is 200; (higher values will be coerced to the maximum)
1453
1453
  # @param page_token [::String]
1454
- # A page token, received from a previous `ListFirebaseLinks` call.
1454
+ # Optional. A page token, received from a previous `ListFirebaseLinks` call.
1455
1455
  # Provide this to retrieve the subsequent page.
1456
1456
  # When paginating, all other parameters provided to `ListFirebaseLinks` must
1457
1457
  # match the call that provided the page token.
@@ -1899,11 +1899,11 @@ module Google
1899
1899
  # @param parent [::String]
1900
1900
  # Required. Example format: properties/1234
1901
1901
  # @param page_size [::Integer]
1902
- # The maximum number of resources to return.
1902
+ # Optional. The maximum number of resources to return.
1903
1903
  # If unspecified, at most 50 resources will be returned.
1904
1904
  # The maximum value is 200 (higher values will be coerced to the maximum).
1905
1905
  # @param page_token [::String]
1906
- # A page token, received from a previous `ListGoogleAdsLinks` call.
1906
+ # Optional. A page token, received from a previous `ListGoogleAdsLinks` call.
1907
1907
  # Provide this to retrieve the subsequent page.
1908
1908
  #
1909
1909
  # When paginating, all other parameters provided to `ListGoogleAdsLinks` must
@@ -2179,14 +2179,15 @@ module Google
2179
2179
  # Format:
2180
2180
  # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets
2181
2181
  # @param page_size [::Integer]
2182
- # The maximum number of resources to return.
2182
+ # Optional. The maximum number of resources to return.
2183
2183
  # If unspecified, at most 10 resources will be returned.
2184
2184
  # The maximum value is 10. Higher values will be coerced to the maximum.
2185
2185
  # @param page_token [::String]
2186
- # A page token, received from a previous `ListMeasurementProtocolSecrets`
2187
- # call. Provide this to retrieve the subsequent page. When paginating, all
2188
- # other parameters provided to `ListMeasurementProtocolSecrets` must match
2189
- # the call that provided the page token.
2186
+ # Optional. A page token, received from a previous
2187
+ # `ListMeasurementProtocolSecrets` call. Provide this to retrieve the
2188
+ # subsequent page. When paginating, all other parameters provided to
2189
+ # `ListMeasurementProtocolSecrets` must match the call that provided the page
2190
+ # token.
2190
2191
  #
2191
2192
  # @yield [response, operation] Access the result along with the RPC operation
2192
2193
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
@@ -2994,12 +2995,12 @@ module Google
2994
2995
  # properties/\\{property_id}/dataStreams/\\{dataStream}
2995
2996
  # Example: properties/1234/dataStreams/5678
2996
2997
  # @param page_size [::Integer]
2997
- # The maximum number of resources to return. The service may return
2998
+ # Optional. The maximum number of resources to return. The service may return
2998
2999
  # fewer than this value, even if there are additional pages.
2999
3000
  # If unspecified, at most 50 resources will be returned.
3000
3001
  # The maximum value is 200; (higher values will be coerced to the maximum)
3001
3002
  # @param page_token [::String]
3002
- # A page token, received from a previous
3003
+ # Optional. A page token, received from a previous
3003
3004
  # `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the
3004
3005
  # subsequent page. When paginating, all other parameters provided to
3005
3006
  # `ListSKAdNetworkConversionValueSchema` must match the call that provided
@@ -3777,14 +3778,14 @@ module Google
3777
3778
  # Required. The resource name of the parent property.
3778
3779
  # Example: 'properties/123'
3779
3780
  # @param page_size [::Integer]
3780
- # The maximum number of resources to return.
3781
+ # Optional. The maximum number of resources to return.
3781
3782
  # If unspecified, at most 50 resources will be returned.
3782
3783
  # The maximum value is 200; (higher values will be coerced to the maximum)
3783
3784
  # @param page_token [::String]
3784
- # A page token, received from a previous `ListConversionEvents` call.
3785
- # Provide this to retrieve the subsequent page.
3786
- # When paginating, all other parameters provided to `ListConversionEvents`
3787
- # must match the call that provided the page token.
3785
+ # Optional. A page token, received from a previous `ListConversionEvents`
3786
+ # call. Provide this to retrieve the subsequent page. When paginating, all
3787
+ # other parameters provided to `ListConversionEvents` must match the call
3788
+ # that provided the page token.
3788
3789
  #
3789
3790
  # @yield [response, operation] Access the result along with the RPC operation
3790
3791
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
@@ -4232,11 +4233,11 @@ module Google
4232
4233
  # Required. The resource name of the parent property.
4233
4234
  # Example: 'properties/123'
4234
4235
  # @param page_size [::Integer]
4235
- # The maximum number of resources to return.
4236
+ # Optional. The maximum number of resources to return.
4236
4237
  # If unspecified, at most 50 resources will be returned.
4237
4238
  # The maximum value is 200; (higher values will be coerced to the maximum)
4238
4239
  # @param page_token [::String]
4239
- # A page token, received from a previous `ListKeyEvents` call.
4240
+ # Optional. A page token, received from a previous `ListKeyEvents` call.
4240
4241
  # Provide this to retrieve the subsequent page.
4241
4242
  # When paginating, all other parameters provided to `ListKeyEvents`
4242
4243
  # must match the call that provided the page token.
@@ -5503,12 +5504,12 @@ module Google
5503
5504
  # @param parent [::String]
5504
5505
  # Required. Example format: properties/1234
5505
5506
  # @param page_size [::Integer]
5506
- # The maximum number of resources to return.
5507
+ # Optional. The maximum number of resources to return.
5507
5508
  # If unspecified, at most 50 resources will be returned.
5508
5509
  # The maximum value is 200 (higher values will be coerced to the maximum).
5509
5510
  # @param page_token [::String]
5510
- # A page token, received from a previous `ListCustomDimensions` call.
5511
- # Provide this to retrieve the subsequent page.
5511
+ # Optional. A page token, received from a previous `ListCustomDimensions`
5512
+ # call. Provide this to retrieve the subsequent page.
5512
5513
  #
5513
5514
  # When paginating, all other parameters provided to `ListCustomDimensions`
5514
5515
  # must match the call that provided the page token.
@@ -14360,7 +14361,7 @@ module Google
14360
14361
  end
14361
14362
 
14362
14363
  ##
14363
- # Returns the singleton data retention settings for this property.
14364
+ # Returns the reporting identity settings for this property.
14364
14365
  #
14365
14366
  # @overload get_reporting_identity_settings(request, options = nil)
14366
14367
  # Pass arguments to `get_reporting_identity_settings` via a request object, either of type
@@ -14447,6 +14448,92 @@ module Google
14447
14448
  raise ::Google::Cloud::Error.from_error(e)
14448
14449
  end
14449
14450
 
14451
+ ##
14452
+ # Looks up settings related to user-provided data for a property.
14453
+ #
14454
+ # @overload get_user_provided_data_settings(request, options = nil)
14455
+ # Pass arguments to `get_user_provided_data_settings` via a request object, either of type
14456
+ # {::Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest} or an equivalent Hash.
14457
+ #
14458
+ # @param request [::Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest, ::Hash]
14459
+ # A request object representing the call parameters. Required. To specify no
14460
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
14461
+ # @param options [::Gapic::CallOptions, ::Hash]
14462
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
14463
+ #
14464
+ # @overload get_user_provided_data_settings(name: nil)
14465
+ # Pass arguments to `get_user_provided_data_settings` via keyword arguments. Note that at
14466
+ # least one keyword argument is required. To specify no parameters, or to keep all
14467
+ # the default parameter values, pass an empty Hash as a request object (see above).
14468
+ #
14469
+ # @param name [::String]
14470
+ # Required. The name of the user provided data settings to retrieve.
14471
+ # Format: properties/\\{property}/userProvidedDataSettings
14472
+ #
14473
+ # @yield [response, operation] Access the result along with the RPC operation
14474
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::UserProvidedDataSettings]
14475
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
14476
+ #
14477
+ # @return [::Google::Analytics::Admin::V1alpha::UserProvidedDataSettings]
14478
+ #
14479
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
14480
+ #
14481
+ # @example Basic example
14482
+ # require "google/analytics/admin/v1alpha"
14483
+ #
14484
+ # # Create a client object. The client can be reused for multiple calls.
14485
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
14486
+ #
14487
+ # # Create a request. To set request fields, pass in keyword arguments.
14488
+ # request = Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest.new
14489
+ #
14490
+ # # Call the get_user_provided_data_settings method.
14491
+ # result = client.get_user_provided_data_settings request
14492
+ #
14493
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::UserProvidedDataSettings.
14494
+ # p result
14495
+ #
14496
+ def get_user_provided_data_settings request, options = nil
14497
+ raise ::ArgumentError, "request must be provided" if request.nil?
14498
+
14499
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest
14500
+
14501
+ # Converts hash and nil to an options object
14502
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
14503
+
14504
+ # Customize the options with defaults
14505
+ metadata = @config.rpcs.get_user_provided_data_settings.metadata.to_h
14506
+
14507
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
14508
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
14509
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
14510
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
14511
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
14512
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
14513
+
14514
+ header_params = {}
14515
+ if request.name
14516
+ header_params["name"] = request.name
14517
+ end
14518
+
14519
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
14520
+ metadata[:"x-goog-request-params"] ||= request_params_header
14521
+
14522
+ options.apply_defaults timeout: @config.rpcs.get_user_provided_data_settings.timeout,
14523
+ metadata: metadata,
14524
+ retry_policy: @config.rpcs.get_user_provided_data_settings.retry_policy
14525
+
14526
+ options.apply_defaults timeout: @config.timeout,
14527
+ metadata: @config.metadata,
14528
+ retry_policy: @config.retry_policy
14529
+
14530
+ @analytics_admin_service_stub.call_rpc :get_user_provided_data_settings, request, options: options do |response, operation|
14531
+ yield response, operation if block_given?
14532
+ end
14533
+ rescue ::GRPC::BadStatus => e
14534
+ raise ::Google::Cloud::Error.from_error(e)
14535
+ end
14536
+
14450
14537
  ##
14451
14538
  # Configuration class for the AnalyticsAdminService API.
14452
14539
  #
@@ -15400,6 +15487,11 @@ module Google
15400
15487
  # @return [::Gapic::Config::Method]
15401
15488
  #
15402
15489
  attr_reader :get_reporting_identity_settings
15490
+ ##
15491
+ # RPC-specific configuration for `get_user_provided_data_settings`
15492
+ # @return [::Gapic::Config::Method]
15493
+ #
15494
+ attr_reader :get_user_provided_data_settings
15403
15495
 
15404
15496
  # @private
15405
15497
  def initialize parent_rpcs = nil
@@ -15711,6 +15803,8 @@ module Google
15711
15803
  @get_subproperty_sync_config = ::Gapic::Config::Method.new get_subproperty_sync_config_config
15712
15804
  get_reporting_identity_settings_config = parent_rpcs.get_reporting_identity_settings if parent_rpcs.respond_to? :get_reporting_identity_settings
15713
15805
  @get_reporting_identity_settings = ::Gapic::Config::Method.new get_reporting_identity_settings_config
15806
+ get_user_provided_data_settings_config = parent_rpcs.get_user_provided_data_settings if parent_rpcs.respond_to? :get_user_provided_data_settings
15807
+ @get_user_provided_data_settings = ::Gapic::Config::Method.new get_user_provided_data_settings_config
15714
15808
 
15715
15809
  yield self if block_given?
15716
15810
  end
@@ -642,6 +642,20 @@ module Google
642
642
  "properties/#{property}/subpropertySyncConfigs/#{subproperty_sync_config}"
643
643
  end
644
644
 
645
+ ##
646
+ # Create a fully-qualified UserProvidedDataSettings resource string.
647
+ #
648
+ # The resource will be in the following format:
649
+ #
650
+ # `properties/{property}/userProvidedDataSettings`
651
+ #
652
+ # @param property [String]
653
+ #
654
+ # @return [::String]
655
+ def user_provided_data_settings_path property:
656
+ "properties/#{property}/userProvidedDataSettings"
657
+ end
658
+
645
659
  extend self
646
660
  end
647
661
  end
@@ -324,12 +324,12 @@ module Google
324
324
  # the default parameter values, pass an empty Hash as a request object (see above).
325
325
  #
326
326
  # @param page_size [::Integer]
327
- # The maximum number of resources to return. The service may return
327
+ # Optional. The maximum number of resources to return. The service may return
328
328
  # fewer than this value, even if there are additional pages.
329
329
  # If unspecified, at most 50 resources will be returned.
330
330
  # The maximum value is 200; (higher values will be coerced to the maximum)
331
331
  # @param page_token [::String]
332
- # A page token, received from a previous `ListAccounts` call.
332
+ # Optional. A page token, received from a previous `ListAccounts` call.
333
333
  # Provide this to retrieve the subsequent page.
334
334
  # When paginating, all other parameters provided to `ListAccounts` must
335
335
  # match the call that provided the page token.
@@ -675,15 +675,15 @@ module Google
675
675
  # the default parameter values, pass an empty Hash as a request object (see above).
676
676
  #
677
677
  # @param page_size [::Integer]
678
- # The maximum number of AccountSummary resources to return. The service may
679
- # return fewer than this value, even if there are additional pages.
680
- # If unspecified, at most 50 resources will be returned.
681
- # The maximum value is 200; (higher values will be coerced to the maximum)
678
+ # Optional. The maximum number of AccountSummary resources to return. The
679
+ # service may return fewer than this value, even if there are additional
680
+ # pages. If unspecified, at most 50 resources will be returned. The maximum
681
+ # value is 200; (higher values will be coerced to the maximum)
682
682
  # @param page_token [::String]
683
- # A page token, received from a previous `ListAccountSummaries` call.
684
- # Provide this to retrieve the subsequent page.
685
- # When paginating, all other parameters provided to `ListAccountSummaries`
686
- # must match the call that provided the page token.
683
+ # Optional. A page token, received from a previous `ListAccountSummaries`
684
+ # call. Provide this to retrieve the subsequent page. When paginating, all
685
+ # other parameters provided to `ListAccountSummaries` must match the call
686
+ # that provided the page token.
687
687
  # @yield [result, operation] Access the result along with the TransportOperation object
688
688
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>]
689
689
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -868,12 +868,12 @@ module Google
868
868
  # | firebase_project:123 | The firebase project with number: 123. |
869
869
  # ```
870
870
  # @param page_size [::Integer]
871
- # The maximum number of resources to return. The service may return
871
+ # Optional. The maximum number of resources to return. The service may return
872
872
  # fewer than this value, even if there are additional pages.
873
873
  # If unspecified, at most 50 resources will be returned.
874
874
  # The maximum value is 200; (higher values will be coerced to the maximum)
875
875
  # @param page_token [::String]
876
- # A page token, received from a previous `ListProperties` call.
876
+ # Optional. A page token, received from a previous `ListProperties` call.
877
877
  # Provide this to retrieve the subsequent page.
878
878
  # When paginating, all other parameters provided to `ListProperties` must
879
879
  # match the call that provided the page token.
@@ -1388,12 +1388,12 @@ module Google
1388
1388
  #
1389
1389
  # Example: `properties/1234`
1390
1390
  # @param page_size [::Integer]
1391
- # The maximum number of resources to return. The service may return
1391
+ # Optional. The maximum number of resources to return. The service may return
1392
1392
  # fewer than this value, even if there are additional pages.
1393
1393
  # If unspecified, at most 50 resources will be returned.
1394
1394
  # The maximum value is 200; (higher values will be coerced to the maximum)
1395
1395
  # @param page_token [::String]
1396
- # A page token, received from a previous `ListFirebaseLinks` call.
1396
+ # Optional. A page token, received from a previous `ListFirebaseLinks` call.
1397
1397
  # Provide this to retrieve the subsequent page.
1398
1398
  # When paginating, all other parameters provided to `ListFirebaseLinks` must
1399
1399
  # match the call that provided the page token.
@@ -1806,11 +1806,11 @@ module Google
1806
1806
  # @param parent [::String]
1807
1807
  # Required. Example format: properties/1234
1808
1808
  # @param page_size [::Integer]
1809
- # The maximum number of resources to return.
1809
+ # Optional. The maximum number of resources to return.
1810
1810
  # If unspecified, at most 50 resources will be returned.
1811
1811
  # The maximum value is 200 (higher values will be coerced to the maximum).
1812
1812
  # @param page_token [::String]
1813
- # A page token, received from a previous `ListGoogleAdsLinks` call.
1813
+ # Optional. A page token, received from a previous `ListGoogleAdsLinks` call.
1814
1814
  # Provide this to retrieve the subsequent page.
1815
1815
  #
1816
1816
  # When paginating, all other parameters provided to `ListGoogleAdsLinks` must
@@ -2065,14 +2065,15 @@ module Google
2065
2065
  # Format:
2066
2066
  # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets
2067
2067
  # @param page_size [::Integer]
2068
- # The maximum number of resources to return.
2068
+ # Optional. The maximum number of resources to return.
2069
2069
  # If unspecified, at most 10 resources will be returned.
2070
2070
  # The maximum value is 10. Higher values will be coerced to the maximum.
2071
2071
  # @param page_token [::String]
2072
- # A page token, received from a previous `ListMeasurementProtocolSecrets`
2073
- # call. Provide this to retrieve the subsequent page. When paginating, all
2074
- # other parameters provided to `ListMeasurementProtocolSecrets` must match
2075
- # the call that provided the page token.
2072
+ # Optional. A page token, received from a previous
2073
+ # `ListMeasurementProtocolSecrets` call. Provide this to retrieve the
2074
+ # subsequent page. When paginating, all other parameters provided to
2075
+ # `ListMeasurementProtocolSecrets` must match the call that provided the page
2076
+ # token.
2076
2077
  # @yield [result, operation] Access the result along with the TransportOperation object
2077
2078
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
2078
2079
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2817,12 +2818,12 @@ module Google
2817
2818
  # properties/\\{property_id}/dataStreams/\\{dataStream}
2818
2819
  # Example: properties/1234/dataStreams/5678
2819
2820
  # @param page_size [::Integer]
2820
- # The maximum number of resources to return. The service may return
2821
+ # Optional. The maximum number of resources to return. The service may return
2821
2822
  # fewer than this value, even if there are additional pages.
2822
2823
  # If unspecified, at most 50 resources will be returned.
2823
2824
  # The maximum value is 200; (higher values will be coerced to the maximum)
2824
2825
  # @param page_token [::String]
2825
- # A page token, received from a previous
2826
+ # Optional. A page token, received from a previous
2826
2827
  # `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the
2827
2828
  # subsequent page. When paginating, all other parameters provided to
2828
2829
  # `ListSKAdNetworkConversionValueSchema` must match the call that provided
@@ -3534,14 +3535,14 @@ module Google
3534
3535
  # Required. The resource name of the parent property.
3535
3536
  # Example: 'properties/123'
3536
3537
  # @param page_size [::Integer]
3537
- # The maximum number of resources to return.
3538
+ # Optional. The maximum number of resources to return.
3538
3539
  # If unspecified, at most 50 resources will be returned.
3539
3540
  # The maximum value is 200; (higher values will be coerced to the maximum)
3540
3541
  # @param page_token [::String]
3541
- # A page token, received from a previous `ListConversionEvents` call.
3542
- # Provide this to retrieve the subsequent page.
3543
- # When paginating, all other parameters provided to `ListConversionEvents`
3544
- # must match the call that provided the page token.
3542
+ # Optional. A page token, received from a previous `ListConversionEvents`
3543
+ # call. Provide this to retrieve the subsequent page. When paginating, all
3544
+ # other parameters provided to `ListConversionEvents` must match the call
3545
+ # that provided the page token.
3545
3546
  # @yield [result, operation] Access the result along with the TransportOperation object
3546
3547
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
3547
3548
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -3954,11 +3955,11 @@ module Google
3954
3955
  # Required. The resource name of the parent property.
3955
3956
  # Example: 'properties/123'
3956
3957
  # @param page_size [::Integer]
3957
- # The maximum number of resources to return.
3958
+ # Optional. The maximum number of resources to return.
3958
3959
  # If unspecified, at most 50 resources will be returned.
3959
3960
  # The maximum value is 200; (higher values will be coerced to the maximum)
3960
3961
  # @param page_token [::String]
3961
- # A page token, received from a previous `ListKeyEvents` call.
3962
+ # Optional. A page token, received from a previous `ListKeyEvents` call.
3962
3963
  # Provide this to retrieve the subsequent page.
3963
3964
  # When paginating, all other parameters provided to `ListKeyEvents`
3964
3965
  # must match the call that provided the page token.
@@ -5127,12 +5128,12 @@ module Google
5127
5128
  # @param parent [::String]
5128
5129
  # Required. Example format: properties/1234
5129
5130
  # @param page_size [::Integer]
5130
- # The maximum number of resources to return.
5131
+ # Optional. The maximum number of resources to return.
5131
5132
  # If unspecified, at most 50 resources will be returned.
5132
5133
  # The maximum value is 200 (higher values will be coerced to the maximum).
5133
5134
  # @param page_token [::String]
5134
- # A page token, received from a previous `ListCustomDimensions` call.
5135
- # Provide this to retrieve the subsequent page.
5135
+ # Optional. A page token, received from a previous `ListCustomDimensions`
5136
+ # call. Provide this to retrieve the subsequent page.
5136
5137
  #
5137
5138
  # When paginating, all other parameters provided to `ListCustomDimensions`
5138
5139
  # must match the call that provided the page token.
@@ -13328,7 +13329,7 @@ module Google
13328
13329
  end
13329
13330
 
13330
13331
  ##
13331
- # Returns the singleton data retention settings for this property.
13332
+ # Returns the reporting identity settings for this property.
13332
13333
  #
13333
13334
  # @overload get_reporting_identity_settings(request, options = nil)
13334
13335
  # Pass arguments to `get_reporting_identity_settings` via a request object, either of type
@@ -13408,6 +13409,85 @@ module Google
13408
13409
  raise ::Google::Cloud::Error.from_error(e)
13409
13410
  end
13410
13411
 
13412
+ ##
13413
+ # Looks up settings related to user-provided data for a property.
13414
+ #
13415
+ # @overload get_user_provided_data_settings(request, options = nil)
13416
+ # Pass arguments to `get_user_provided_data_settings` via a request object, either of type
13417
+ # {::Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest} or an equivalent Hash.
13418
+ #
13419
+ # @param request [::Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest, ::Hash]
13420
+ # A request object representing the call parameters. Required. To specify no
13421
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
13422
+ # @param options [::Gapic::CallOptions, ::Hash]
13423
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
13424
+ #
13425
+ # @overload get_user_provided_data_settings(name: nil)
13426
+ # Pass arguments to `get_user_provided_data_settings` via keyword arguments. Note that at
13427
+ # least one keyword argument is required. To specify no parameters, or to keep all
13428
+ # the default parameter values, pass an empty Hash as a request object (see above).
13429
+ #
13430
+ # @param name [::String]
13431
+ # Required. The name of the user provided data settings to retrieve.
13432
+ # Format: properties/\\{property}/userProvidedDataSettings
13433
+ # @yield [result, operation] Access the result along with the TransportOperation object
13434
+ # @yieldparam result [::Google::Analytics::Admin::V1alpha::UserProvidedDataSettings]
13435
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
13436
+ #
13437
+ # @return [::Google::Analytics::Admin::V1alpha::UserProvidedDataSettings]
13438
+ #
13439
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
13440
+ #
13441
+ # @example Basic example
13442
+ # require "google/analytics/admin/v1alpha"
13443
+ #
13444
+ # # Create a client object. The client can be reused for multiple calls.
13445
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
13446
+ #
13447
+ # # Create a request. To set request fields, pass in keyword arguments.
13448
+ # request = Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest.new
13449
+ #
13450
+ # # Call the get_user_provided_data_settings method.
13451
+ # result = client.get_user_provided_data_settings request
13452
+ #
13453
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::UserProvidedDataSettings.
13454
+ # p result
13455
+ #
13456
+ def get_user_provided_data_settings request, options = nil
13457
+ raise ::ArgumentError, "request must be provided" if request.nil?
13458
+
13459
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetUserProvidedDataSettingsRequest
13460
+
13461
+ # Converts hash and nil to an options object
13462
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
13463
+
13464
+ # Customize the options with defaults
13465
+ call_metadata = @config.rpcs.get_user_provided_data_settings.metadata.to_h
13466
+
13467
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
13468
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
13469
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
13470
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
13471
+ transports_version_send: [:rest]
13472
+
13473
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
13474
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
13475
+
13476
+ options.apply_defaults timeout: @config.rpcs.get_user_provided_data_settings.timeout,
13477
+ metadata: call_metadata,
13478
+ retry_policy: @config.rpcs.get_user_provided_data_settings.retry_policy
13479
+
13480
+ options.apply_defaults timeout: @config.timeout,
13481
+ metadata: @config.metadata,
13482
+ retry_policy: @config.retry_policy
13483
+
13484
+ @analytics_admin_service_stub.get_user_provided_data_settings request, options do |result, operation|
13485
+ yield result, operation if block_given?
13486
+ end
13487
+ rescue ::Gapic::Rest::Error => e
13488
+ raise ::Google::Cloud::Error.from_error(e)
13489
+ end
13490
+
13411
13491
  ##
13412
13492
  # Configuration class for the AnalyticsAdminService REST API.
13413
13493
  #
@@ -14324,6 +14404,11 @@ module Google
14324
14404
  # @return [::Gapic::Config::Method]
14325
14405
  #
14326
14406
  attr_reader :get_reporting_identity_settings
14407
+ ##
14408
+ # RPC-specific configuration for `get_user_provided_data_settings`
14409
+ # @return [::Gapic::Config::Method]
14410
+ #
14411
+ attr_reader :get_user_provided_data_settings
14327
14412
 
14328
14413
  # @private
14329
14414
  def initialize parent_rpcs = nil
@@ -14635,6 +14720,8 @@ module Google
14635
14720
  @get_subproperty_sync_config = ::Gapic::Config::Method.new get_subproperty_sync_config_config
14636
14721
  get_reporting_identity_settings_config = parent_rpcs.get_reporting_identity_settings if parent_rpcs.respond_to? :get_reporting_identity_settings
14637
14722
  @get_reporting_identity_settings = ::Gapic::Config::Method.new get_reporting_identity_settings_config
14723
+ get_user_provided_data_settings_config = parent_rpcs.get_user_provided_data_settings if parent_rpcs.respond_to? :get_user_provided_data_settings
14724
+ @get_user_provided_data_settings = ::Gapic::Config::Method.new get_user_provided_data_settings_config
14638
14725
 
14639
14726
  yield self if block_given?
14640
14727
  end