google-analytics-admin-v1alpha 0.36.0 → 0.37.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.
@@ -9826,172 +9826,6 @@ module Google
9826
9826
  raise ::Google::Cloud::Error.from_error(e)
9827
9827
  end
9828
9828
 
9829
- ##
9830
- # Sets the opt out status for the automated GA4 setup process for a UA
9831
- # property.
9832
- # Note: this has no effect on GA4 property.
9833
- #
9834
- # @overload set_automated_ga4_configuration_opt_out(request, options = nil)
9835
- # Pass arguments to `set_automated_ga4_configuration_opt_out` via a request object, either of type
9836
- # {::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
9837
- #
9838
- # @param request [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::Hash]
9839
- # A request object representing the call parameters. Required. To specify no
9840
- # parameters, or to keep all the default parameter values, pass an empty Hash.
9841
- # @param options [::Gapic::CallOptions, ::Hash]
9842
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9843
- #
9844
- # @overload set_automated_ga4_configuration_opt_out(property: nil, opt_out: nil)
9845
- # Pass arguments to `set_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
9846
- # least one keyword argument is required. To specify no parameters, or to keep all
9847
- # the default parameter values, pass an empty Hash as a request object (see above).
9848
- #
9849
- # @param property [::String]
9850
- # Required. The UA property to set the opt out status. Note this request uses
9851
- # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
9852
- # Format: properties/\\{internalWebPropertyId}
9853
- # Example: properties/1234
9854
- # @param opt_out [::Boolean]
9855
- # The status to set.
9856
- #
9857
- # @yield [response, operation] Access the result along with the RPC operation
9858
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
9859
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
9860
- #
9861
- # @return [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
9862
- #
9863
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
9864
- #
9865
- # @example Basic example
9866
- # require "google/analytics/admin/v1alpha"
9867
- #
9868
- # # Create a client object. The client can be reused for multiple calls.
9869
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9870
- #
9871
- # # Create a request. To set request fields, pass in keyword arguments.
9872
- # request = Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest.new
9873
- #
9874
- # # Call the set_automated_ga4_configuration_opt_out method.
9875
- # result = client.set_automated_ga4_configuration_opt_out request
9876
- #
9877
- # # The returned object is of type Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse.
9878
- # p result
9879
- #
9880
- def set_automated_ga4_configuration_opt_out request, options = nil
9881
- raise ::ArgumentError, "request must be provided" if request.nil?
9882
-
9883
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest
9884
-
9885
- # Converts hash and nil to an options object
9886
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9887
-
9888
- # Customize the options with defaults
9889
- metadata = @config.rpcs.set_automated_ga4_configuration_opt_out.metadata.to_h
9890
-
9891
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
9892
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9893
- lib_name: @config.lib_name, lib_version: @config.lib_version,
9894
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9895
- metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
9896
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9897
-
9898
- options.apply_defaults timeout: @config.rpcs.set_automated_ga4_configuration_opt_out.timeout,
9899
- metadata: metadata,
9900
- retry_policy: @config.rpcs.set_automated_ga4_configuration_opt_out.retry_policy
9901
-
9902
- options.apply_defaults timeout: @config.timeout,
9903
- metadata: @config.metadata,
9904
- retry_policy: @config.retry_policy
9905
-
9906
- @analytics_admin_service_stub.call_rpc :set_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
9907
- yield response, operation if block_given?
9908
- end
9909
- rescue ::GRPC::BadStatus => e
9910
- raise ::Google::Cloud::Error.from_error(e)
9911
- end
9912
-
9913
- ##
9914
- # Fetches the opt out status for the automated GA4 setup process for a UA
9915
- # property.
9916
- # Note: this has no effect on GA4 property.
9917
- #
9918
- # @overload fetch_automated_ga4_configuration_opt_out(request, options = nil)
9919
- # Pass arguments to `fetch_automated_ga4_configuration_opt_out` via a request object, either of type
9920
- # {::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
9921
- #
9922
- # @param request [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest, ::Hash]
9923
- # A request object representing the call parameters. Required. To specify no
9924
- # parameters, or to keep all the default parameter values, pass an empty Hash.
9925
- # @param options [::Gapic::CallOptions, ::Hash]
9926
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9927
- #
9928
- # @overload fetch_automated_ga4_configuration_opt_out(property: nil)
9929
- # Pass arguments to `fetch_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
9930
- # least one keyword argument is required. To specify no parameters, or to keep all
9931
- # the default parameter values, pass an empty Hash as a request object (see above).
9932
- #
9933
- # @param property [::String]
9934
- # Required. The UA property to get the opt out status. Note this request uses
9935
- # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
9936
- # Format: properties/\\{internalWebPropertyId}
9937
- # Example: properties/1234
9938
- #
9939
- # @yield [response, operation] Access the result along with the RPC operation
9940
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
9941
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
9942
- #
9943
- # @return [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
9944
- #
9945
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
9946
- #
9947
- # @example Basic example
9948
- # require "google/analytics/admin/v1alpha"
9949
- #
9950
- # # Create a client object. The client can be reused for multiple calls.
9951
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9952
- #
9953
- # # Create a request. To set request fields, pass in keyword arguments.
9954
- # request = Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest.new
9955
- #
9956
- # # Call the fetch_automated_ga4_configuration_opt_out method.
9957
- # result = client.fetch_automated_ga4_configuration_opt_out request
9958
- #
9959
- # # The returned object is of type Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse.
9960
- # p result
9961
- #
9962
- def fetch_automated_ga4_configuration_opt_out request, options = nil
9963
- raise ::ArgumentError, "request must be provided" if request.nil?
9964
-
9965
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest
9966
-
9967
- # Converts hash and nil to an options object
9968
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9969
-
9970
- # Customize the options with defaults
9971
- metadata = @config.rpcs.fetch_automated_ga4_configuration_opt_out.metadata.to_h
9972
-
9973
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
9974
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9975
- lib_name: @config.lib_name, lib_version: @config.lib_version,
9976
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9977
- metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
9978
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9979
-
9980
- options.apply_defaults timeout: @config.rpcs.fetch_automated_ga4_configuration_opt_out.timeout,
9981
- metadata: metadata,
9982
- retry_policy: @config.rpcs.fetch_automated_ga4_configuration_opt_out.retry_policy
9983
-
9984
- options.apply_defaults timeout: @config.timeout,
9985
- metadata: @config.metadata,
9986
- retry_policy: @config.retry_policy
9987
-
9988
- @analytics_admin_service_stub.call_rpc :fetch_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
9989
- yield response, operation if block_given?
9990
- end
9991
- rescue ::GRPC::BadStatus => e
9992
- raise ::Google::Cloud::Error.from_error(e)
9993
- end
9994
-
9995
9829
  ##
9996
9830
  # Creates a BigQueryLink.
9997
9831
  #
@@ -10629,338 +10463,6 @@ module Google
10629
10463
  raise ::Google::Cloud::Error.from_error(e)
10630
10464
  end
10631
10465
 
10632
- ##
10633
- # Creates a connected site tag for a Universal Analytics property. You can
10634
- # create a maximum of 20 connected site tags per property.
10635
- # Note: This API cannot be used on GA4 properties.
10636
- #
10637
- # @overload create_connected_site_tag(request, options = nil)
10638
- # Pass arguments to `create_connected_site_tag` via a request object, either of type
10639
- # {::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest} or an equivalent Hash.
10640
- #
10641
- # @param request [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest, ::Hash]
10642
- # A request object representing the call parameters. Required. To specify no
10643
- # parameters, or to keep all the default parameter values, pass an empty Hash.
10644
- # @param options [::Gapic::CallOptions, ::Hash]
10645
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
10646
- #
10647
- # @overload create_connected_site_tag(property: nil, connected_site_tag: nil)
10648
- # Pass arguments to `create_connected_site_tag` via keyword arguments. Note that at
10649
- # least one keyword argument is required. To specify no parameters, or to keep all
10650
- # the default parameter values, pass an empty Hash as a request object (see above).
10651
- #
10652
- # @param property [::String]
10653
- # The Universal Analytics property to create connected site tags for.
10654
- # This API does not support GA4 properties.
10655
- # Format: properties/\\{universalAnalyticsPropertyId}
10656
- # Example: properties/1234
10657
- # @param connected_site_tag [::Google::Analytics::Admin::V1alpha::ConnectedSiteTag, ::Hash]
10658
- # Required. The tag to add to the Universal Analytics property
10659
- #
10660
- # @yield [response, operation] Access the result along with the RPC operation
10661
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
10662
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
10663
- #
10664
- # @return [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
10665
- #
10666
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
10667
- #
10668
- # @example Basic example
10669
- # require "google/analytics/admin/v1alpha"
10670
- #
10671
- # # Create a client object. The client can be reused for multiple calls.
10672
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
10673
- #
10674
- # # Create a request. To set request fields, pass in keyword arguments.
10675
- # request = Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest.new
10676
- #
10677
- # # Call the create_connected_site_tag method.
10678
- # result = client.create_connected_site_tag request
10679
- #
10680
- # # The returned object is of type Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse.
10681
- # p result
10682
- #
10683
- def create_connected_site_tag request, options = nil
10684
- raise ::ArgumentError, "request must be provided" if request.nil?
10685
-
10686
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest
10687
-
10688
- # Converts hash and nil to an options object
10689
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
10690
-
10691
- # Customize the options with defaults
10692
- metadata = @config.rpcs.create_connected_site_tag.metadata.to_h
10693
-
10694
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
10695
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
10696
- lib_name: @config.lib_name, lib_version: @config.lib_version,
10697
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
10698
- metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
10699
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
10700
-
10701
- options.apply_defaults timeout: @config.rpcs.create_connected_site_tag.timeout,
10702
- metadata: metadata,
10703
- retry_policy: @config.rpcs.create_connected_site_tag.retry_policy
10704
-
10705
- options.apply_defaults timeout: @config.timeout,
10706
- metadata: @config.metadata,
10707
- retry_policy: @config.retry_policy
10708
-
10709
- @analytics_admin_service_stub.call_rpc :create_connected_site_tag, request, options: options do |response, operation|
10710
- yield response, operation if block_given?
10711
- end
10712
- rescue ::GRPC::BadStatus => e
10713
- raise ::Google::Cloud::Error.from_error(e)
10714
- end
10715
-
10716
- ##
10717
- # Deletes a connected site tag for a Universal Analytics property.
10718
- # Note: this has no effect on GA4 properties.
10719
- #
10720
- # @overload delete_connected_site_tag(request, options = nil)
10721
- # Pass arguments to `delete_connected_site_tag` via a request object, either of type
10722
- # {::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest} or an equivalent Hash.
10723
- #
10724
- # @param request [::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest, ::Hash]
10725
- # A request object representing the call parameters. Required. To specify no
10726
- # parameters, or to keep all the default parameter values, pass an empty Hash.
10727
- # @param options [::Gapic::CallOptions, ::Hash]
10728
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
10729
- #
10730
- # @overload delete_connected_site_tag(property: nil, tag_id: nil)
10731
- # Pass arguments to `delete_connected_site_tag` via keyword arguments. Note that at
10732
- # least one keyword argument is required. To specify no parameters, or to keep all
10733
- # the default parameter values, pass an empty Hash as a request object (see above).
10734
- #
10735
- # @param property [::String]
10736
- # The Universal Analytics property to delete connected site tags for.
10737
- # This API does not support GA4 properties.
10738
- # Format: properties/\\{universalAnalyticsPropertyId}
10739
- # Example: properties/1234
10740
- # @param tag_id [::String]
10741
- # Tag ID to forward events to. Also known as the Measurement ID, or the
10742
- # "G-ID" (For example: G-12345).
10743
- #
10744
- # @yield [response, operation] Access the result along with the RPC operation
10745
- # @yieldparam response [::Google::Protobuf::Empty]
10746
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
10747
- #
10748
- # @return [::Google::Protobuf::Empty]
10749
- #
10750
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
10751
- #
10752
- # @example Basic example
10753
- # require "google/analytics/admin/v1alpha"
10754
- #
10755
- # # Create a client object. The client can be reused for multiple calls.
10756
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
10757
- #
10758
- # # Create a request. To set request fields, pass in keyword arguments.
10759
- # request = Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest.new
10760
- #
10761
- # # Call the delete_connected_site_tag method.
10762
- # result = client.delete_connected_site_tag request
10763
- #
10764
- # # The returned object is of type Google::Protobuf::Empty.
10765
- # p result
10766
- #
10767
- def delete_connected_site_tag request, options = nil
10768
- raise ::ArgumentError, "request must be provided" if request.nil?
10769
-
10770
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest
10771
-
10772
- # Converts hash and nil to an options object
10773
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
10774
-
10775
- # Customize the options with defaults
10776
- metadata = @config.rpcs.delete_connected_site_tag.metadata.to_h
10777
-
10778
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
10779
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
10780
- lib_name: @config.lib_name, lib_version: @config.lib_version,
10781
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
10782
- metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
10783
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
10784
-
10785
- options.apply_defaults timeout: @config.rpcs.delete_connected_site_tag.timeout,
10786
- metadata: metadata,
10787
- retry_policy: @config.rpcs.delete_connected_site_tag.retry_policy
10788
-
10789
- options.apply_defaults timeout: @config.timeout,
10790
- metadata: @config.metadata,
10791
- retry_policy: @config.retry_policy
10792
-
10793
- @analytics_admin_service_stub.call_rpc :delete_connected_site_tag, request, options: options do |response, operation|
10794
- yield response, operation if block_given?
10795
- end
10796
- rescue ::GRPC::BadStatus => e
10797
- raise ::Google::Cloud::Error.from_error(e)
10798
- end
10799
-
10800
- ##
10801
- # Lists the connected site tags for a Universal Analytics property. A maximum
10802
- # of 20 connected site tags will be returned. Note: this has no effect on GA4
10803
- # property.
10804
- #
10805
- # @overload list_connected_site_tags(request, options = nil)
10806
- # Pass arguments to `list_connected_site_tags` via a request object, either of type
10807
- # {::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest} or an equivalent Hash.
10808
- #
10809
- # @param request [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest, ::Hash]
10810
- # A request object representing the call parameters. Required. To specify no
10811
- # parameters, or to keep all the default parameter values, pass an empty Hash.
10812
- # @param options [::Gapic::CallOptions, ::Hash]
10813
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
10814
- #
10815
- # @overload list_connected_site_tags(property: nil)
10816
- # Pass arguments to `list_connected_site_tags` via keyword arguments. Note that at
10817
- # least one keyword argument is required. To specify no parameters, or to keep all
10818
- # the default parameter values, pass an empty Hash as a request object (see above).
10819
- #
10820
- # @param property [::String]
10821
- # The Universal Analytics property to fetch connected site tags for.
10822
- # This does not work on GA4 properties. A maximum of 20 connected site tags
10823
- # will be returned.
10824
- # Example Format: `properties/1234`
10825
- #
10826
- # @yield [response, operation] Access the result along with the RPC operation
10827
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
10828
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
10829
- #
10830
- # @return [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
10831
- #
10832
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
10833
- #
10834
- # @example Basic example
10835
- # require "google/analytics/admin/v1alpha"
10836
- #
10837
- # # Create a client object. The client can be reused for multiple calls.
10838
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
10839
- #
10840
- # # Create a request. To set request fields, pass in keyword arguments.
10841
- # request = Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest.new
10842
- #
10843
- # # Call the list_connected_site_tags method.
10844
- # result = client.list_connected_site_tags request
10845
- #
10846
- # # The returned object is of type Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse.
10847
- # p result
10848
- #
10849
- def list_connected_site_tags request, options = nil
10850
- raise ::ArgumentError, "request must be provided" if request.nil?
10851
-
10852
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest
10853
-
10854
- # Converts hash and nil to an options object
10855
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
10856
-
10857
- # Customize the options with defaults
10858
- metadata = @config.rpcs.list_connected_site_tags.metadata.to_h
10859
-
10860
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
10861
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
10862
- lib_name: @config.lib_name, lib_version: @config.lib_version,
10863
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
10864
- metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
10865
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
10866
-
10867
- options.apply_defaults timeout: @config.rpcs.list_connected_site_tags.timeout,
10868
- metadata: metadata,
10869
- retry_policy: @config.rpcs.list_connected_site_tags.retry_policy
10870
-
10871
- options.apply_defaults timeout: @config.timeout,
10872
- metadata: @config.metadata,
10873
- retry_policy: @config.retry_policy
10874
-
10875
- @analytics_admin_service_stub.call_rpc :list_connected_site_tags, request, options: options do |response, operation|
10876
- yield response, operation if block_given?
10877
- end
10878
- rescue ::GRPC::BadStatus => e
10879
- raise ::Google::Cloud::Error.from_error(e)
10880
- end
10881
-
10882
- ##
10883
- # Given a specified UA property, looks up the GA4 property connected to it.
10884
- # Note: this cannot be used with GA4 properties.
10885
- #
10886
- # @overload fetch_connected_ga4_property(request, options = nil)
10887
- # Pass arguments to `fetch_connected_ga4_property` via a request object, either of type
10888
- # {::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest} or an equivalent Hash.
10889
- #
10890
- # @param request [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest, ::Hash]
10891
- # A request object representing the call parameters. Required. To specify no
10892
- # parameters, or to keep all the default parameter values, pass an empty Hash.
10893
- # @param options [::Gapic::CallOptions, ::Hash]
10894
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
10895
- #
10896
- # @overload fetch_connected_ga4_property(property: nil)
10897
- # Pass arguments to `fetch_connected_ga4_property` via keyword arguments. Note that at
10898
- # least one keyword argument is required. To specify no parameters, or to keep all
10899
- # the default parameter values, pass an empty Hash as a request object (see above).
10900
- #
10901
- # @param property [::String]
10902
- # Required. The UA property for which to look up the connected GA4 property.
10903
- # Note this request uses the
10904
- # internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
10905
- # Format: properties/\\{internal_web_property_id}
10906
- # Example: properties/1234
10907
- #
10908
- # @yield [response, operation] Access the result along with the RPC operation
10909
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
10910
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
10911
- #
10912
- # @return [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
10913
- #
10914
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
10915
- #
10916
- # @example Basic example
10917
- # require "google/analytics/admin/v1alpha"
10918
- #
10919
- # # Create a client object. The client can be reused for multiple calls.
10920
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
10921
- #
10922
- # # Create a request. To set request fields, pass in keyword arguments.
10923
- # request = Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest.new
10924
- #
10925
- # # Call the fetch_connected_ga4_property method.
10926
- # result = client.fetch_connected_ga4_property request
10927
- #
10928
- # # The returned object is of type Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse.
10929
- # p result
10930
- #
10931
- def fetch_connected_ga4_property request, options = nil
10932
- raise ::ArgumentError, "request must be provided" if request.nil?
10933
-
10934
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest
10935
-
10936
- # Converts hash and nil to an options object
10937
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
10938
-
10939
- # Customize the options with defaults
10940
- metadata = @config.rpcs.fetch_connected_ga4_property.metadata.to_h
10941
-
10942
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
10943
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
10944
- lib_name: @config.lib_name, lib_version: @config.lib_version,
10945
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
10946
- metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
10947
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
10948
-
10949
- options.apply_defaults timeout: @config.rpcs.fetch_connected_ga4_property.timeout,
10950
- metadata: metadata,
10951
- retry_policy: @config.rpcs.fetch_connected_ga4_property.retry_policy
10952
-
10953
- options.apply_defaults timeout: @config.timeout,
10954
- metadata: @config.metadata,
10955
- retry_policy: @config.retry_policy
10956
-
10957
- @analytics_admin_service_stub.call_rpc :fetch_connected_ga4_property, request, options: options do |response, operation|
10958
- yield response, operation if block_given?
10959
- end
10960
- rescue ::GRPC::BadStatus => e
10961
- raise ::Google::Cloud::Error.from_error(e)
10962
- end
10963
-
10964
10466
  ##
10965
10467
  # Looks up a single AdSenseLink.
10966
10468
  #
@@ -14480,22 +13982,34 @@ module Google
14480
13982
  # Google Analytics [user
14481
13983
  # ID](https://firebase.google.com/docs/analytics/userid).
14482
13984
  #
14483
- # Note: The following fields are mutually exclusive: `user_id`, `client_id`, `app_instance_id`, `user_provided_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
13985
+ # Note: The following parameters are mutually exclusive: `user_id`, `client_id`, `app_instance_id`, `user_provided_data`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
14484
13986
  # @param client_id [::String]
14485
13987
  # Google Analytics [client
14486
13988
  # ID](https://support.google.com/analytics/answer/11593727).
14487
13989
  #
14488
- # Note: The following fields are mutually exclusive: `client_id`, `user_id`, `app_instance_id`, `user_provided_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
13990
+ # Note: The following parameters are mutually exclusive: `client_id`, `user_id`, `app_instance_id`, `user_provided_data`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
14489
13991
  # @param app_instance_id [::String]
14490
13992
  # Firebase [application instance
14491
13993
  # ID](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId).
14492
13994
  #
14493
- # Note: The following fields are mutually exclusive: `app_instance_id`, `user_id`, `client_id`, `user_provided_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
13995
+ # Note: The following parameters are mutually exclusive: `app_instance_id`, `user_id`, `client_id`, `user_provided_data`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
14494
13996
  # @param user_provided_data [::String]
14495
- # The un-hashed, unencrypted, [user-provided
14496
- # data](https://support.google.com/analytics/answer/14077171).
13997
+ # [User-provided
13998
+ # data](https://support.google.com/analytics/answer/14077171). May contain
13999
+ # either one email address or one phone number.
14000
+ #
14001
+ # Email addresses should be normalized as such:
14002
+ #
14003
+ # * lowercase
14004
+ # * remove periods before @ for gmail.com/googlemail.com addresses
14005
+ # * remove all spaces
14006
+ #
14007
+ # Phone numbers should be normalized as such:
14497
14008
  #
14498
- # Note: The following fields are mutually exclusive: `user_provided_data`, `user_id`, `client_id`, `app_instance_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
14009
+ # * remove all non digit characters
14010
+ # * add + prefix
14011
+ #
14012
+ # Note: The following parameters are mutually exclusive: `user_provided_data`, `user_id`, `client_id`, `app_instance_id`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
14499
14013
  # @param name [::String]
14500
14014
  # Required. The name of the property to submit user deletion for.
14501
14015
  #
@@ -14564,7 +14078,7 @@ module Google
14564
14078
  end
14565
14079
 
14566
14080
  ##
14567
- # List all Subproperty Sync Configs on a property.
14081
+ # List all `SubpropertySyncConfig` resources for a property.
14568
14082
  #
14569
14083
  # @overload list_subproperty_sync_configs(request, options = nil)
14570
14084
  # Pass arguments to `list_subproperty_sync_configs` via a request object, either of type
@@ -14668,7 +14182,7 @@ module Google
14668
14182
  end
14669
14183
 
14670
14184
  ##
14671
- # Updates a Subproperty Sync Config.
14185
+ # Updates a `SubpropertySyncConfig`.
14672
14186
  #
14673
14187
  # @overload update_subproperty_sync_config(request, options = nil)
14674
14188
  # Pass arguments to `update_subproperty_sync_config` via a request object, either of type
@@ -14686,7 +14200,7 @@ module Google
14686
14200
  # the default parameter values, pass an empty Hash as a request object (see above).
14687
14201
  #
14688
14202
  # @param subproperty_sync_config [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig, ::Hash]
14689
- # Required. The SubpropertySyncConfig to update.
14203
+ # Required. The `SubpropertySyncConfig` to update.
14690
14204
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
14691
14205
  # Optional. The list of fields to update. Field names must be in snake case
14692
14206
  # (for example, "field_to_update"). Omitted fields will not be updated. To
@@ -14758,7 +14272,7 @@ module Google
14758
14272
  end
14759
14273
 
14760
14274
  ##
14761
- # Lookup for a single Subproperty Sync Config.
14275
+ # Lookup for a single `SubpropertySyncConfig`.
14762
14276
  #
14763
14277
  # @overload get_subproperty_sync_config(request, options = nil)
14764
14278
  # Pass arguments to `get_subproperty_sync_config` via a request object, either of type
@@ -14845,6 +14359,94 @@ module Google
14845
14359
  raise ::Google::Cloud::Error.from_error(e)
14846
14360
  end
14847
14361
 
14362
+ ##
14363
+ # Returns the singleton data retention settings for this property.
14364
+ #
14365
+ # @overload get_reporting_identity_settings(request, options = nil)
14366
+ # Pass arguments to `get_reporting_identity_settings` via a request object, either of type
14367
+ # {::Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest} or an equivalent Hash.
14368
+ #
14369
+ # @param request [::Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest, ::Hash]
14370
+ # A request object representing the call parameters. Required. To specify no
14371
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
14372
+ # @param options [::Gapic::CallOptions, ::Hash]
14373
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
14374
+ #
14375
+ # @overload get_reporting_identity_settings(name: nil)
14376
+ # Pass arguments to `get_reporting_identity_settings` via keyword arguments. Note that at
14377
+ # least one keyword argument is required. To specify no parameters, or to keep all
14378
+ # the default parameter values, pass an empty Hash as a request object (see above).
14379
+ #
14380
+ # @param name [::String]
14381
+ # Required. The name of the settings to lookup.
14382
+ # Format:
14383
+ # properties/\\{property}/reportingIdentitySettings
14384
+ # Example: "properties/1000/reportingIdentitySettings"
14385
+ #
14386
+ # @yield [response, operation] Access the result along with the RPC operation
14387
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::ReportingIdentitySettings]
14388
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
14389
+ #
14390
+ # @return [::Google::Analytics::Admin::V1alpha::ReportingIdentitySettings]
14391
+ #
14392
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
14393
+ #
14394
+ # @example Basic example
14395
+ # require "google/analytics/admin/v1alpha"
14396
+ #
14397
+ # # Create a client object. The client can be reused for multiple calls.
14398
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
14399
+ #
14400
+ # # Create a request. To set request fields, pass in keyword arguments.
14401
+ # request = Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest.new
14402
+ #
14403
+ # # Call the get_reporting_identity_settings method.
14404
+ # result = client.get_reporting_identity_settings request
14405
+ #
14406
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::ReportingIdentitySettings.
14407
+ # p result
14408
+ #
14409
+ def get_reporting_identity_settings request, options = nil
14410
+ raise ::ArgumentError, "request must be provided" if request.nil?
14411
+
14412
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest
14413
+
14414
+ # Converts hash and nil to an options object
14415
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
14416
+
14417
+ # Customize the options with defaults
14418
+ metadata = @config.rpcs.get_reporting_identity_settings.metadata.to_h
14419
+
14420
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
14421
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
14422
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
14423
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
14424
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
14425
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
14426
+
14427
+ header_params = {}
14428
+ if request.name
14429
+ header_params["name"] = request.name
14430
+ end
14431
+
14432
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
14433
+ metadata[:"x-goog-request-params"] ||= request_params_header
14434
+
14435
+ options.apply_defaults timeout: @config.rpcs.get_reporting_identity_settings.timeout,
14436
+ metadata: metadata,
14437
+ retry_policy: @config.rpcs.get_reporting_identity_settings.retry_policy
14438
+
14439
+ options.apply_defaults timeout: @config.timeout,
14440
+ metadata: @config.metadata,
14441
+ retry_policy: @config.retry_policy
14442
+
14443
+ @analytics_admin_service_stub.call_rpc :get_reporting_identity_settings, request, options: options do |response, operation|
14444
+ yield response, operation if block_given?
14445
+ end
14446
+ rescue ::GRPC::BadStatus => e
14447
+ raise ::Google::Cloud::Error.from_error(e)
14448
+ end
14449
+
14848
14450
  ##
14849
14451
  # Configuration class for the AnalyticsAdminService API.
14850
14452
  #
@@ -15532,16 +15134,6 @@ module Google
15532
15134
  #
15533
15135
  attr_reader :delete_channel_group
15534
15136
  ##
15535
- # RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
15536
- # @return [::Gapic::Config::Method]
15537
- #
15538
- attr_reader :set_automated_ga4_configuration_opt_out
15539
- ##
15540
- # RPC-specific configuration for `fetch_automated_ga4_configuration_opt_out`
15541
- # @return [::Gapic::Config::Method]
15542
- #
15543
- attr_reader :fetch_automated_ga4_configuration_opt_out
15544
- ##
15545
15137
  # RPC-specific configuration for `create_big_query_link`
15546
15138
  # @return [::Gapic::Config::Method]
15547
15139
  #
@@ -15577,26 +15169,6 @@ module Google
15577
15169
  #
15578
15170
  attr_reader :update_enhanced_measurement_settings
15579
15171
  ##
15580
- # RPC-specific configuration for `create_connected_site_tag`
15581
- # @return [::Gapic::Config::Method]
15582
- #
15583
- attr_reader :create_connected_site_tag
15584
- ##
15585
- # RPC-specific configuration for `delete_connected_site_tag`
15586
- # @return [::Gapic::Config::Method]
15587
- #
15588
- attr_reader :delete_connected_site_tag
15589
- ##
15590
- # RPC-specific configuration for `list_connected_site_tags`
15591
- # @return [::Gapic::Config::Method]
15592
- #
15593
- attr_reader :list_connected_site_tags
15594
- ##
15595
- # RPC-specific configuration for `fetch_connected_ga4_property`
15596
- # @return [::Gapic::Config::Method]
15597
- #
15598
- attr_reader :fetch_connected_ga4_property
15599
- ##
15600
15172
  # RPC-specific configuration for `get_ad_sense_link`
15601
15173
  # @return [::Gapic::Config::Method]
15602
15174
  #
@@ -15806,6 +15378,11 @@ module Google
15806
15378
  # @return [::Gapic::Config::Method]
15807
15379
  #
15808
15380
  attr_reader :get_subproperty_sync_config
15381
+ ##
15382
+ # RPC-specific configuration for `get_reporting_identity_settings`
15383
+ # @return [::Gapic::Config::Method]
15384
+ #
15385
+ attr_reader :get_reporting_identity_settings
15809
15386
 
15810
15387
  # @private
15811
15388
  def initialize parent_rpcs = nil
@@ -16017,10 +15594,6 @@ module Google
16017
15594
  @update_channel_group = ::Gapic::Config::Method.new update_channel_group_config
16018
15595
  delete_channel_group_config = parent_rpcs.delete_channel_group if parent_rpcs.respond_to? :delete_channel_group
16019
15596
  @delete_channel_group = ::Gapic::Config::Method.new delete_channel_group_config
16020
- set_automated_ga4_configuration_opt_out_config = parent_rpcs.set_automated_ga4_configuration_opt_out if parent_rpcs.respond_to? :set_automated_ga4_configuration_opt_out
16021
- @set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
16022
- fetch_automated_ga4_configuration_opt_out_config = parent_rpcs.fetch_automated_ga4_configuration_opt_out if parent_rpcs.respond_to? :fetch_automated_ga4_configuration_opt_out
16023
- @fetch_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new fetch_automated_ga4_configuration_opt_out_config
16024
15597
  create_big_query_link_config = parent_rpcs.create_big_query_link if parent_rpcs.respond_to? :create_big_query_link
16025
15598
  @create_big_query_link = ::Gapic::Config::Method.new create_big_query_link_config
16026
15599
  get_big_query_link_config = parent_rpcs.get_big_query_link if parent_rpcs.respond_to? :get_big_query_link
@@ -16035,14 +15608,6 @@ module Google
16035
15608
  @get_enhanced_measurement_settings = ::Gapic::Config::Method.new get_enhanced_measurement_settings_config
16036
15609
  update_enhanced_measurement_settings_config = parent_rpcs.update_enhanced_measurement_settings if parent_rpcs.respond_to? :update_enhanced_measurement_settings
16037
15610
  @update_enhanced_measurement_settings = ::Gapic::Config::Method.new update_enhanced_measurement_settings_config
16038
- create_connected_site_tag_config = parent_rpcs.create_connected_site_tag if parent_rpcs.respond_to? :create_connected_site_tag
16039
- @create_connected_site_tag = ::Gapic::Config::Method.new create_connected_site_tag_config
16040
- delete_connected_site_tag_config = parent_rpcs.delete_connected_site_tag if parent_rpcs.respond_to? :delete_connected_site_tag
16041
- @delete_connected_site_tag = ::Gapic::Config::Method.new delete_connected_site_tag_config
16042
- list_connected_site_tags_config = parent_rpcs.list_connected_site_tags if parent_rpcs.respond_to? :list_connected_site_tags
16043
- @list_connected_site_tags = ::Gapic::Config::Method.new list_connected_site_tags_config
16044
- fetch_connected_ga4_property_config = parent_rpcs.fetch_connected_ga4_property if parent_rpcs.respond_to? :fetch_connected_ga4_property
16045
- @fetch_connected_ga4_property = ::Gapic::Config::Method.new fetch_connected_ga4_property_config
16046
15611
  get_ad_sense_link_config = parent_rpcs.get_ad_sense_link if parent_rpcs.respond_to? :get_ad_sense_link
16047
15612
  @get_ad_sense_link = ::Gapic::Config::Method.new get_ad_sense_link_config
16048
15613
  create_ad_sense_link_config = parent_rpcs.create_ad_sense_link if parent_rpcs.respond_to? :create_ad_sense_link
@@ -16127,6 +15692,8 @@ module Google
16127
15692
  @update_subproperty_sync_config = ::Gapic::Config::Method.new update_subproperty_sync_config_config
16128
15693
  get_subproperty_sync_config_config = parent_rpcs.get_subproperty_sync_config if parent_rpcs.respond_to? :get_subproperty_sync_config
16129
15694
  @get_subproperty_sync_config = ::Gapic::Config::Method.new get_subproperty_sync_config_config
15695
+ get_reporting_identity_settings_config = parent_rpcs.get_reporting_identity_settings if parent_rpcs.respond_to? :get_reporting_identity_settings
15696
+ @get_reporting_identity_settings = ::Gapic::Config::Method.new get_reporting_identity_settings_config
16130
15697
 
16131
15698
  yield self if block_given?
16132
15699
  end