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.
@@ -9121,174 +9121,6 @@ module Google
9121
9121
  raise ::Google::Cloud::Error.from_error(e)
9122
9122
  end
9123
9123
 
9124
- ##
9125
- # Sets the opt out status for the automated GA4 setup process for a UA
9126
- # property.
9127
- # Note: this has no effect on GA4 property.
9128
- #
9129
- # @overload set_automated_ga4_configuration_opt_out(request, options = nil)
9130
- # Pass arguments to `set_automated_ga4_configuration_opt_out` via a request object, either of type
9131
- # {::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
9132
- #
9133
- # @param request [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::Hash]
9134
- # A request object representing the call parameters. Required. To specify no
9135
- # parameters, or to keep all the default parameter values, pass an empty Hash.
9136
- # @param options [::Gapic::CallOptions, ::Hash]
9137
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
9138
- #
9139
- # @overload set_automated_ga4_configuration_opt_out(property: nil, opt_out: nil)
9140
- # Pass arguments to `set_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
9141
- # least one keyword argument is required. To specify no parameters, or to keep all
9142
- # the default parameter values, pass an empty Hash as a request object (see above).
9143
- #
9144
- # @param property [::String]
9145
- # Required. The UA property to set the opt out status. Note this request uses
9146
- # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
9147
- # Format: properties/\\{internalWebPropertyId}
9148
- # Example: properties/1234
9149
- # @param opt_out [::Boolean]
9150
- # The status to set.
9151
- # @yield [result, operation] Access the result along with the TransportOperation object
9152
- # @yieldparam result [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
9153
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
9154
- #
9155
- # @return [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
9156
- #
9157
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
9158
- #
9159
- # @example Basic example
9160
- # require "google/analytics/admin/v1alpha"
9161
- #
9162
- # # Create a client object. The client can be reused for multiple calls.
9163
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
9164
- #
9165
- # # Create a request. To set request fields, pass in keyword arguments.
9166
- # request = Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest.new
9167
- #
9168
- # # Call the set_automated_ga4_configuration_opt_out method.
9169
- # result = client.set_automated_ga4_configuration_opt_out request
9170
- #
9171
- # # The returned object is of type Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse.
9172
- # p result
9173
- #
9174
- def set_automated_ga4_configuration_opt_out request, options = nil
9175
- raise ::ArgumentError, "request must be provided" if request.nil?
9176
-
9177
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest
9178
-
9179
- # Converts hash and nil to an options object
9180
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9181
-
9182
- # Customize the options with defaults
9183
- call_metadata = @config.rpcs.set_automated_ga4_configuration_opt_out.metadata.to_h
9184
-
9185
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
9186
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9187
- lib_name: @config.lib_name, lib_version: @config.lib_version,
9188
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
9189
- transports_version_send: [:rest]
9190
-
9191
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
9192
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9193
-
9194
- options.apply_defaults timeout: @config.rpcs.set_automated_ga4_configuration_opt_out.timeout,
9195
- metadata: call_metadata,
9196
- retry_policy: @config.rpcs.set_automated_ga4_configuration_opt_out.retry_policy
9197
-
9198
- options.apply_defaults timeout: @config.timeout,
9199
- metadata: @config.metadata,
9200
- retry_policy: @config.retry_policy
9201
-
9202
- @analytics_admin_service_stub.set_automated_ga4_configuration_opt_out request, options do |result, operation|
9203
- yield result, operation if block_given?
9204
- end
9205
- rescue ::Gapic::Rest::Error => e
9206
- raise ::Google::Cloud::Error.from_error(e)
9207
- end
9208
-
9209
- ##
9210
- # Fetches the opt out status for the automated GA4 setup process for a UA
9211
- # property.
9212
- # Note: this has no effect on GA4 property.
9213
- #
9214
- # @overload fetch_automated_ga4_configuration_opt_out(request, options = nil)
9215
- # Pass arguments to `fetch_automated_ga4_configuration_opt_out` via a request object, either of type
9216
- # {::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
9217
- #
9218
- # @param request [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest, ::Hash]
9219
- # A request object representing the call parameters. Required. To specify no
9220
- # parameters, or to keep all the default parameter values, pass an empty Hash.
9221
- # @param options [::Gapic::CallOptions, ::Hash]
9222
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
9223
- #
9224
- # @overload fetch_automated_ga4_configuration_opt_out(property: nil)
9225
- # Pass arguments to `fetch_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
9226
- # least one keyword argument is required. To specify no parameters, or to keep all
9227
- # the default parameter values, pass an empty Hash as a request object (see above).
9228
- #
9229
- # @param property [::String]
9230
- # Required. The UA property to get the opt out status. Note this request uses
9231
- # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
9232
- # Format: properties/\\{internalWebPropertyId}
9233
- # Example: properties/1234
9234
- # @yield [result, operation] Access the result along with the TransportOperation object
9235
- # @yieldparam result [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
9236
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
9237
- #
9238
- # @return [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
9239
- #
9240
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
9241
- #
9242
- # @example Basic example
9243
- # require "google/analytics/admin/v1alpha"
9244
- #
9245
- # # Create a client object. The client can be reused for multiple calls.
9246
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
9247
- #
9248
- # # Create a request. To set request fields, pass in keyword arguments.
9249
- # request = Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest.new
9250
- #
9251
- # # Call the fetch_automated_ga4_configuration_opt_out method.
9252
- # result = client.fetch_automated_ga4_configuration_opt_out request
9253
- #
9254
- # # The returned object is of type Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse.
9255
- # p result
9256
- #
9257
- def fetch_automated_ga4_configuration_opt_out request, options = nil
9258
- raise ::ArgumentError, "request must be provided" if request.nil?
9259
-
9260
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest
9261
-
9262
- # Converts hash and nil to an options object
9263
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9264
-
9265
- # Customize the options with defaults
9266
- call_metadata = @config.rpcs.fetch_automated_ga4_configuration_opt_out.metadata.to_h
9267
-
9268
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
9269
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9270
- lib_name: @config.lib_name, lib_version: @config.lib_version,
9271
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
9272
- transports_version_send: [:rest]
9273
-
9274
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
9275
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9276
-
9277
- options.apply_defaults timeout: @config.rpcs.fetch_automated_ga4_configuration_opt_out.timeout,
9278
- metadata: call_metadata,
9279
- retry_policy: @config.rpcs.fetch_automated_ga4_configuration_opt_out.retry_policy
9280
-
9281
- options.apply_defaults timeout: @config.timeout,
9282
- metadata: @config.metadata,
9283
- retry_policy: @config.retry_policy
9284
-
9285
- @analytics_admin_service_stub.fetch_automated_ga4_configuration_opt_out request, options do |result, operation|
9286
- yield result, operation if block_given?
9287
- end
9288
- rescue ::Gapic::Rest::Error => e
9289
- raise ::Google::Cloud::Error.from_error(e)
9290
- end
9291
-
9292
9124
  ##
9293
9125
  # Creates a BigQueryLink.
9294
9126
  #
@@ -9877,342 +9709,6 @@ module Google
9877
9709
  raise ::Google::Cloud::Error.from_error(e)
9878
9710
  end
9879
9711
 
9880
- ##
9881
- # Creates a connected site tag for a Universal Analytics property. You can
9882
- # create a maximum of 20 connected site tags per property.
9883
- # Note: This API cannot be used on GA4 properties.
9884
- #
9885
- # @overload create_connected_site_tag(request, options = nil)
9886
- # Pass arguments to `create_connected_site_tag` via a request object, either of type
9887
- # {::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest} or an equivalent Hash.
9888
- #
9889
- # @param request [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest, ::Hash]
9890
- # A request object representing the call parameters. Required. To specify no
9891
- # parameters, or to keep all the default parameter values, pass an empty Hash.
9892
- # @param options [::Gapic::CallOptions, ::Hash]
9893
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
9894
- #
9895
- # @overload create_connected_site_tag(property: nil, connected_site_tag: nil)
9896
- # Pass arguments to `create_connected_site_tag` via keyword arguments. Note that at
9897
- # least one keyword argument is required. To specify no parameters, or to keep all
9898
- # the default parameter values, pass an empty Hash as a request object (see above).
9899
- #
9900
- # @param property [::String]
9901
- # The Universal Analytics property to create connected site tags for.
9902
- # This API does not support GA4 properties.
9903
- # Format: properties/\\{universalAnalyticsPropertyId}
9904
- # Example: properties/1234
9905
- # @param connected_site_tag [::Google::Analytics::Admin::V1alpha::ConnectedSiteTag, ::Hash]
9906
- # Required. The tag to add to the Universal Analytics property
9907
- # @yield [result, operation] Access the result along with the TransportOperation object
9908
- # @yieldparam result [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
9909
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
9910
- #
9911
- # @return [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
9912
- #
9913
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
9914
- #
9915
- # @example Basic example
9916
- # require "google/analytics/admin/v1alpha"
9917
- #
9918
- # # Create a client object. The client can be reused for multiple calls.
9919
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
9920
- #
9921
- # # Create a request. To set request fields, pass in keyword arguments.
9922
- # request = Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest.new
9923
- #
9924
- # # Call the create_connected_site_tag method.
9925
- # result = client.create_connected_site_tag request
9926
- #
9927
- # # The returned object is of type Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse.
9928
- # p result
9929
- #
9930
- def create_connected_site_tag request, options = nil
9931
- raise ::ArgumentError, "request must be provided" if request.nil?
9932
-
9933
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest
9934
-
9935
- # Converts hash and nil to an options object
9936
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9937
-
9938
- # Customize the options with defaults
9939
- call_metadata = @config.rpcs.create_connected_site_tag.metadata.to_h
9940
-
9941
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
9942
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9943
- lib_name: @config.lib_name, lib_version: @config.lib_version,
9944
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
9945
- transports_version_send: [:rest]
9946
-
9947
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
9948
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9949
-
9950
- options.apply_defaults timeout: @config.rpcs.create_connected_site_tag.timeout,
9951
- metadata: call_metadata,
9952
- retry_policy: @config.rpcs.create_connected_site_tag.retry_policy
9953
-
9954
- options.apply_defaults timeout: @config.timeout,
9955
- metadata: @config.metadata,
9956
- retry_policy: @config.retry_policy
9957
-
9958
- @analytics_admin_service_stub.create_connected_site_tag request, options do |result, operation|
9959
- yield result, operation if block_given?
9960
- end
9961
- rescue ::Gapic::Rest::Error => e
9962
- raise ::Google::Cloud::Error.from_error(e)
9963
- end
9964
-
9965
- ##
9966
- # Deletes a connected site tag for a Universal Analytics property.
9967
- # Note: this has no effect on GA4 properties.
9968
- #
9969
- # @overload delete_connected_site_tag(request, options = nil)
9970
- # Pass arguments to `delete_connected_site_tag` via a request object, either of type
9971
- # {::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest} or an equivalent Hash.
9972
- #
9973
- # @param request [::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest, ::Hash]
9974
- # A request object representing the call parameters. Required. To specify no
9975
- # parameters, or to keep all the default parameter values, pass an empty Hash.
9976
- # @param options [::Gapic::CallOptions, ::Hash]
9977
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
9978
- #
9979
- # @overload delete_connected_site_tag(property: nil, tag_id: nil)
9980
- # Pass arguments to `delete_connected_site_tag` via keyword arguments. Note that at
9981
- # least one keyword argument is required. To specify no parameters, or to keep all
9982
- # the default parameter values, pass an empty Hash as a request object (see above).
9983
- #
9984
- # @param property [::String]
9985
- # The Universal Analytics property to delete connected site tags for.
9986
- # This API does not support GA4 properties.
9987
- # Format: properties/\\{universalAnalyticsPropertyId}
9988
- # Example: properties/1234
9989
- # @param tag_id [::String]
9990
- # Tag ID to forward events to. Also known as the Measurement ID, or the
9991
- # "G-ID" (For example: G-12345).
9992
- # @yield [result, operation] Access the result along with the TransportOperation object
9993
- # @yieldparam result [::Google::Protobuf::Empty]
9994
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
9995
- #
9996
- # @return [::Google::Protobuf::Empty]
9997
- #
9998
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
9999
- #
10000
- # @example Basic example
10001
- # require "google/analytics/admin/v1alpha"
10002
- #
10003
- # # Create a client object. The client can be reused for multiple calls.
10004
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
10005
- #
10006
- # # Create a request. To set request fields, pass in keyword arguments.
10007
- # request = Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest.new
10008
- #
10009
- # # Call the delete_connected_site_tag method.
10010
- # result = client.delete_connected_site_tag request
10011
- #
10012
- # # The returned object is of type Google::Protobuf::Empty.
10013
- # p result
10014
- #
10015
- def delete_connected_site_tag request, options = nil
10016
- raise ::ArgumentError, "request must be provided" if request.nil?
10017
-
10018
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest
10019
-
10020
- # Converts hash and nil to an options object
10021
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
10022
-
10023
- # Customize the options with defaults
10024
- call_metadata = @config.rpcs.delete_connected_site_tag.metadata.to_h
10025
-
10026
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
10027
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
10028
- lib_name: @config.lib_name, lib_version: @config.lib_version,
10029
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
10030
- transports_version_send: [:rest]
10031
-
10032
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
10033
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
10034
-
10035
- options.apply_defaults timeout: @config.rpcs.delete_connected_site_tag.timeout,
10036
- metadata: call_metadata,
10037
- retry_policy: @config.rpcs.delete_connected_site_tag.retry_policy
10038
-
10039
- options.apply_defaults timeout: @config.timeout,
10040
- metadata: @config.metadata,
10041
- retry_policy: @config.retry_policy
10042
-
10043
- @analytics_admin_service_stub.delete_connected_site_tag request, options do |result, operation|
10044
- yield result, operation if block_given?
10045
- end
10046
- rescue ::Gapic::Rest::Error => e
10047
- raise ::Google::Cloud::Error.from_error(e)
10048
- end
10049
-
10050
- ##
10051
- # Lists the connected site tags for a Universal Analytics property. A maximum
10052
- # of 20 connected site tags will be returned. Note: this has no effect on GA4
10053
- # property.
10054
- #
10055
- # @overload list_connected_site_tags(request, options = nil)
10056
- # Pass arguments to `list_connected_site_tags` via a request object, either of type
10057
- # {::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest} or an equivalent Hash.
10058
- #
10059
- # @param request [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest, ::Hash]
10060
- # A request object representing the call parameters. Required. To specify no
10061
- # parameters, or to keep all the default parameter values, pass an empty Hash.
10062
- # @param options [::Gapic::CallOptions, ::Hash]
10063
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
10064
- #
10065
- # @overload list_connected_site_tags(property: nil)
10066
- # Pass arguments to `list_connected_site_tags` via keyword arguments. Note that at
10067
- # least one keyword argument is required. To specify no parameters, or to keep all
10068
- # the default parameter values, pass an empty Hash as a request object (see above).
10069
- #
10070
- # @param property [::String]
10071
- # The Universal Analytics property to fetch connected site tags for.
10072
- # This does not work on GA4 properties. A maximum of 20 connected site tags
10073
- # will be returned.
10074
- # Example Format: `properties/1234`
10075
- # @yield [result, operation] Access the result along with the TransportOperation object
10076
- # @yieldparam result [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
10077
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
10078
- #
10079
- # @return [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
10080
- #
10081
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
10082
- #
10083
- # @example Basic example
10084
- # require "google/analytics/admin/v1alpha"
10085
- #
10086
- # # Create a client object. The client can be reused for multiple calls.
10087
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
10088
- #
10089
- # # Create a request. To set request fields, pass in keyword arguments.
10090
- # request = Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest.new
10091
- #
10092
- # # Call the list_connected_site_tags method.
10093
- # result = client.list_connected_site_tags request
10094
- #
10095
- # # The returned object is of type Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse.
10096
- # p result
10097
- #
10098
- def list_connected_site_tags request, options = nil
10099
- raise ::ArgumentError, "request must be provided" if request.nil?
10100
-
10101
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest
10102
-
10103
- # Converts hash and nil to an options object
10104
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
10105
-
10106
- # Customize the options with defaults
10107
- call_metadata = @config.rpcs.list_connected_site_tags.metadata.to_h
10108
-
10109
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
10110
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
10111
- lib_name: @config.lib_name, lib_version: @config.lib_version,
10112
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
10113
- transports_version_send: [:rest]
10114
-
10115
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
10116
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
10117
-
10118
- options.apply_defaults timeout: @config.rpcs.list_connected_site_tags.timeout,
10119
- metadata: call_metadata,
10120
- retry_policy: @config.rpcs.list_connected_site_tags.retry_policy
10121
-
10122
- options.apply_defaults timeout: @config.timeout,
10123
- metadata: @config.metadata,
10124
- retry_policy: @config.retry_policy
10125
-
10126
- @analytics_admin_service_stub.list_connected_site_tags request, options do |result, operation|
10127
- yield result, operation if block_given?
10128
- end
10129
- rescue ::Gapic::Rest::Error => e
10130
- raise ::Google::Cloud::Error.from_error(e)
10131
- end
10132
-
10133
- ##
10134
- # Given a specified UA property, looks up the GA4 property connected to it.
10135
- # Note: this cannot be used with GA4 properties.
10136
- #
10137
- # @overload fetch_connected_ga4_property(request, options = nil)
10138
- # Pass arguments to `fetch_connected_ga4_property` via a request object, either of type
10139
- # {::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest} or an equivalent Hash.
10140
- #
10141
- # @param request [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest, ::Hash]
10142
- # A request object representing the call parameters. Required. To specify no
10143
- # parameters, or to keep all the default parameter values, pass an empty Hash.
10144
- # @param options [::Gapic::CallOptions, ::Hash]
10145
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
10146
- #
10147
- # @overload fetch_connected_ga4_property(property: nil)
10148
- # Pass arguments to `fetch_connected_ga4_property` via keyword arguments. Note that at
10149
- # least one keyword argument is required. To specify no parameters, or to keep all
10150
- # the default parameter values, pass an empty Hash as a request object (see above).
10151
- #
10152
- # @param property [::String]
10153
- # Required. The UA property for which to look up the connected GA4 property.
10154
- # Note this request uses the
10155
- # internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
10156
- # Format: properties/\\{internal_web_property_id}
10157
- # Example: properties/1234
10158
- # @yield [result, operation] Access the result along with the TransportOperation object
10159
- # @yieldparam result [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
10160
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
10161
- #
10162
- # @return [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
10163
- #
10164
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
10165
- #
10166
- # @example Basic example
10167
- # require "google/analytics/admin/v1alpha"
10168
- #
10169
- # # Create a client object. The client can be reused for multiple calls.
10170
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
10171
- #
10172
- # # Create a request. To set request fields, pass in keyword arguments.
10173
- # request = Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest.new
10174
- #
10175
- # # Call the fetch_connected_ga4_property method.
10176
- # result = client.fetch_connected_ga4_property request
10177
- #
10178
- # # The returned object is of type Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse.
10179
- # p result
10180
- #
10181
- def fetch_connected_ga4_property request, options = nil
10182
- raise ::ArgumentError, "request must be provided" if request.nil?
10183
-
10184
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest
10185
-
10186
- # Converts hash and nil to an options object
10187
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
10188
-
10189
- # Customize the options with defaults
10190
- call_metadata = @config.rpcs.fetch_connected_ga4_property.metadata.to_h
10191
-
10192
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
10193
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
10194
- lib_name: @config.lib_name, lib_version: @config.lib_version,
10195
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
10196
- transports_version_send: [:rest]
10197
-
10198
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
10199
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
10200
-
10201
- options.apply_defaults timeout: @config.rpcs.fetch_connected_ga4_property.timeout,
10202
- metadata: call_metadata,
10203
- retry_policy: @config.rpcs.fetch_connected_ga4_property.retry_policy
10204
-
10205
- options.apply_defaults timeout: @config.timeout,
10206
- metadata: @config.metadata,
10207
- retry_policy: @config.retry_policy
10208
-
10209
- @analytics_admin_service_stub.fetch_connected_ga4_property request, options do |result, operation|
10210
- yield result, operation if block_given?
10211
- end
10212
- rescue ::Gapic::Rest::Error => e
10213
- raise ::Google::Cloud::Error.from_error(e)
10214
- end
10215
-
10216
9712
  ##
10217
9713
  # Looks up a single AdSenseLink.
10218
9714
  #
@@ -13482,22 +12978,34 @@ module Google
13482
12978
  # Google Analytics [user
13483
12979
  # ID](https://firebase.google.com/docs/analytics/userid).
13484
12980
  #
13485
- # 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.
12981
+ # 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.
13486
12982
  # @param client_id [::String]
13487
12983
  # Google Analytics [client
13488
12984
  # ID](https://support.google.com/analytics/answer/11593727).
13489
12985
  #
13490
- # 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.
12986
+ # 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.
13491
12987
  # @param app_instance_id [::String]
13492
12988
  # Firebase [application instance
13493
12989
  # ID](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId).
13494
12990
  #
13495
- # 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.
12991
+ # 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.
13496
12992
  # @param user_provided_data [::String]
13497
- # The un-hashed, unencrypted, [user-provided
13498
- # data](https://support.google.com/analytics/answer/14077171).
12993
+ # [User-provided
12994
+ # data](https://support.google.com/analytics/answer/14077171). May contain
12995
+ # either one email address or one phone number.
12996
+ #
12997
+ # Email addresses should be normalized as such:
12998
+ #
12999
+ # * lowercase
13000
+ # * remove periods before @ for gmail.com/googlemail.com addresses
13001
+ # * remove all spaces
13002
+ #
13003
+ # Phone numbers should be normalized as such:
13499
13004
  #
13500
- # 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.
13005
+ # * remove all non digit characters
13006
+ # * add + prefix
13007
+ #
13008
+ # 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.
13501
13009
  # @param name [::String]
13502
13010
  # Required. The name of the property to submit user deletion for.
13503
13011
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -13559,7 +13067,7 @@ module Google
13559
13067
  end
13560
13068
 
13561
13069
  ##
13562
- # List all Subproperty Sync Configs on a property.
13070
+ # List all `SubpropertySyncConfig` resources for a property.
13563
13071
  #
13564
13072
  # @overload list_subproperty_sync_configs(request, options = nil)
13565
13073
  # Pass arguments to `list_subproperty_sync_configs` via a request object, either of type
@@ -13656,7 +13164,7 @@ module Google
13656
13164
  end
13657
13165
 
13658
13166
  ##
13659
- # Updates a Subproperty Sync Config.
13167
+ # Updates a `SubpropertySyncConfig`.
13660
13168
  #
13661
13169
  # @overload update_subproperty_sync_config(request, options = nil)
13662
13170
  # Pass arguments to `update_subproperty_sync_config` via a request object, either of type
@@ -13674,7 +13182,7 @@ module Google
13674
13182
  # the default parameter values, pass an empty Hash as a request object (see above).
13675
13183
  #
13676
13184
  # @param subproperty_sync_config [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig, ::Hash]
13677
- # Required. The SubpropertySyncConfig to update.
13185
+ # Required. The `SubpropertySyncConfig` to update.
13678
13186
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
13679
13187
  # Optional. The list of fields to update. Field names must be in snake case
13680
13188
  # (for example, "field_to_update"). Omitted fields will not be updated. To
@@ -13739,7 +13247,7 @@ module Google
13739
13247
  end
13740
13248
 
13741
13249
  ##
13742
- # Lookup for a single Subproperty Sync Config.
13250
+ # Lookup for a single `SubpropertySyncConfig`.
13743
13251
  #
13744
13252
  # @overload get_subproperty_sync_config(request, options = nil)
13745
13253
  # Pass arguments to `get_subproperty_sync_config` via a request object, either of type
@@ -13819,6 +13327,87 @@ module Google
13819
13327
  raise ::Google::Cloud::Error.from_error(e)
13820
13328
  end
13821
13329
 
13330
+ ##
13331
+ # Returns the singleton data retention settings for this property.
13332
+ #
13333
+ # @overload get_reporting_identity_settings(request, options = nil)
13334
+ # Pass arguments to `get_reporting_identity_settings` via a request object, either of type
13335
+ # {::Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest} or an equivalent Hash.
13336
+ #
13337
+ # @param request [::Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest, ::Hash]
13338
+ # A request object representing the call parameters. Required. To specify no
13339
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
13340
+ # @param options [::Gapic::CallOptions, ::Hash]
13341
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
13342
+ #
13343
+ # @overload get_reporting_identity_settings(name: nil)
13344
+ # Pass arguments to `get_reporting_identity_settings` via keyword arguments. Note that at
13345
+ # least one keyword argument is required. To specify no parameters, or to keep all
13346
+ # the default parameter values, pass an empty Hash as a request object (see above).
13347
+ #
13348
+ # @param name [::String]
13349
+ # Required. The name of the settings to lookup.
13350
+ # Format:
13351
+ # properties/\\{property}/reportingIdentitySettings
13352
+ # Example: "properties/1000/reportingIdentitySettings"
13353
+ # @yield [result, operation] Access the result along with the TransportOperation object
13354
+ # @yieldparam result [::Google::Analytics::Admin::V1alpha::ReportingIdentitySettings]
13355
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
13356
+ #
13357
+ # @return [::Google::Analytics::Admin::V1alpha::ReportingIdentitySettings]
13358
+ #
13359
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
13360
+ #
13361
+ # @example Basic example
13362
+ # require "google/analytics/admin/v1alpha"
13363
+ #
13364
+ # # Create a client object. The client can be reused for multiple calls.
13365
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client.new
13366
+ #
13367
+ # # Create a request. To set request fields, pass in keyword arguments.
13368
+ # request = Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest.new
13369
+ #
13370
+ # # Call the get_reporting_identity_settings method.
13371
+ # result = client.get_reporting_identity_settings request
13372
+ #
13373
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::ReportingIdentitySettings.
13374
+ # p result
13375
+ #
13376
+ def get_reporting_identity_settings request, options = nil
13377
+ raise ::ArgumentError, "request must be provided" if request.nil?
13378
+
13379
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetReportingIdentitySettingsRequest
13380
+
13381
+ # Converts hash and nil to an options object
13382
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
13383
+
13384
+ # Customize the options with defaults
13385
+ call_metadata = @config.rpcs.get_reporting_identity_settings.metadata.to_h
13386
+
13387
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
13388
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
13389
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
13390
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
13391
+ transports_version_send: [:rest]
13392
+
13393
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
13394
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
13395
+
13396
+ options.apply_defaults timeout: @config.rpcs.get_reporting_identity_settings.timeout,
13397
+ metadata: call_metadata,
13398
+ retry_policy: @config.rpcs.get_reporting_identity_settings.retry_policy
13399
+
13400
+ options.apply_defaults timeout: @config.timeout,
13401
+ metadata: @config.metadata,
13402
+ retry_policy: @config.retry_policy
13403
+
13404
+ @analytics_admin_service_stub.get_reporting_identity_settings request, options do |result, operation|
13405
+ yield result, operation if block_given?
13406
+ end
13407
+ rescue ::Gapic::Rest::Error => e
13408
+ raise ::Google::Cloud::Error.from_error(e)
13409
+ end
13410
+
13822
13411
  ##
13823
13412
  # Configuration class for the AnalyticsAdminService REST API.
13824
13413
  #
@@ -14486,16 +14075,6 @@ module Google
14486
14075
  #
14487
14076
  attr_reader :delete_channel_group
14488
14077
  ##
14489
- # RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
14490
- # @return [::Gapic::Config::Method]
14491
- #
14492
- attr_reader :set_automated_ga4_configuration_opt_out
14493
- ##
14494
- # RPC-specific configuration for `fetch_automated_ga4_configuration_opt_out`
14495
- # @return [::Gapic::Config::Method]
14496
- #
14497
- attr_reader :fetch_automated_ga4_configuration_opt_out
14498
- ##
14499
14078
  # RPC-specific configuration for `create_big_query_link`
14500
14079
  # @return [::Gapic::Config::Method]
14501
14080
  #
@@ -14531,26 +14110,6 @@ module Google
14531
14110
  #
14532
14111
  attr_reader :update_enhanced_measurement_settings
14533
14112
  ##
14534
- # RPC-specific configuration for `create_connected_site_tag`
14535
- # @return [::Gapic::Config::Method]
14536
- #
14537
- attr_reader :create_connected_site_tag
14538
- ##
14539
- # RPC-specific configuration for `delete_connected_site_tag`
14540
- # @return [::Gapic::Config::Method]
14541
- #
14542
- attr_reader :delete_connected_site_tag
14543
- ##
14544
- # RPC-specific configuration for `list_connected_site_tags`
14545
- # @return [::Gapic::Config::Method]
14546
- #
14547
- attr_reader :list_connected_site_tags
14548
- ##
14549
- # RPC-specific configuration for `fetch_connected_ga4_property`
14550
- # @return [::Gapic::Config::Method]
14551
- #
14552
- attr_reader :fetch_connected_ga4_property
14553
- ##
14554
14113
  # RPC-specific configuration for `get_ad_sense_link`
14555
14114
  # @return [::Gapic::Config::Method]
14556
14115
  #
@@ -14760,6 +14319,11 @@ module Google
14760
14319
  # @return [::Gapic::Config::Method]
14761
14320
  #
14762
14321
  attr_reader :get_subproperty_sync_config
14322
+ ##
14323
+ # RPC-specific configuration for `get_reporting_identity_settings`
14324
+ # @return [::Gapic::Config::Method]
14325
+ #
14326
+ attr_reader :get_reporting_identity_settings
14763
14327
 
14764
14328
  # @private
14765
14329
  def initialize parent_rpcs = nil
@@ -14971,10 +14535,6 @@ module Google
14971
14535
  @update_channel_group = ::Gapic::Config::Method.new update_channel_group_config
14972
14536
  delete_channel_group_config = parent_rpcs.delete_channel_group if parent_rpcs.respond_to? :delete_channel_group
14973
14537
  @delete_channel_group = ::Gapic::Config::Method.new delete_channel_group_config
14974
- 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
14975
- @set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
14976
- 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
14977
- @fetch_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new fetch_automated_ga4_configuration_opt_out_config
14978
14538
  create_big_query_link_config = parent_rpcs.create_big_query_link if parent_rpcs.respond_to? :create_big_query_link
14979
14539
  @create_big_query_link = ::Gapic::Config::Method.new create_big_query_link_config
14980
14540
  get_big_query_link_config = parent_rpcs.get_big_query_link if parent_rpcs.respond_to? :get_big_query_link
@@ -14989,14 +14549,6 @@ module Google
14989
14549
  @get_enhanced_measurement_settings = ::Gapic::Config::Method.new get_enhanced_measurement_settings_config
14990
14550
  update_enhanced_measurement_settings_config = parent_rpcs.update_enhanced_measurement_settings if parent_rpcs.respond_to? :update_enhanced_measurement_settings
14991
14551
  @update_enhanced_measurement_settings = ::Gapic::Config::Method.new update_enhanced_measurement_settings_config
14992
- create_connected_site_tag_config = parent_rpcs.create_connected_site_tag if parent_rpcs.respond_to? :create_connected_site_tag
14993
- @create_connected_site_tag = ::Gapic::Config::Method.new create_connected_site_tag_config
14994
- delete_connected_site_tag_config = parent_rpcs.delete_connected_site_tag if parent_rpcs.respond_to? :delete_connected_site_tag
14995
- @delete_connected_site_tag = ::Gapic::Config::Method.new delete_connected_site_tag_config
14996
- list_connected_site_tags_config = parent_rpcs.list_connected_site_tags if parent_rpcs.respond_to? :list_connected_site_tags
14997
- @list_connected_site_tags = ::Gapic::Config::Method.new list_connected_site_tags_config
14998
- fetch_connected_ga4_property_config = parent_rpcs.fetch_connected_ga4_property if parent_rpcs.respond_to? :fetch_connected_ga4_property
14999
- @fetch_connected_ga4_property = ::Gapic::Config::Method.new fetch_connected_ga4_property_config
15000
14552
  get_ad_sense_link_config = parent_rpcs.get_ad_sense_link if parent_rpcs.respond_to? :get_ad_sense_link
15001
14553
  @get_ad_sense_link = ::Gapic::Config::Method.new get_ad_sense_link_config
15002
14554
  create_ad_sense_link_config = parent_rpcs.create_ad_sense_link if parent_rpcs.respond_to? :create_ad_sense_link
@@ -15081,6 +14633,8 @@ module Google
15081
14633
  @update_subproperty_sync_config = ::Gapic::Config::Method.new update_subproperty_sync_config_config
15082
14634
  get_subproperty_sync_config_config = parent_rpcs.get_subproperty_sync_config if parent_rpcs.respond_to? :get_subproperty_sync_config
15083
14635
  @get_subproperty_sync_config = ::Gapic::Config::Method.new get_subproperty_sync_config_config
14636
+ get_reporting_identity_settings_config = parent_rpcs.get_reporting_identity_settings if parent_rpcs.respond_to? :get_reporting_identity_settings
14637
+ @get_reporting_identity_settings = ::Gapic::Config::Method.new get_reporting_identity_settings_config
15084
14638
 
15085
14639
  yield self if block_given?
15086
14640
  end