google-analytics-admin-v1alpha 0.35.0 → 0.36.0

data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb

@@ -13427,7 +13427,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload provision_subproperty(subproperty: nil, subproperty_event_filter: nil)
+            # @overload provision_subproperty(subproperty: nil, subproperty_event_filter: nil, custom_dimension_and_metric_synchronization_mode: nil)
             #   Pass arguments to `provision_subproperty` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -13436,6 +13436,9 @@ module Google
             #     Required. The subproperty to create.
             #   @param subproperty_event_filter [::Google::Analytics::Admin::V1alpha::SubpropertyEventFilter, ::Hash]
             #     Optional. The subproperty event filter to create on an ordinary property.
+            #   @param custom_dimension_and_metric_synchronization_mode [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig::SynchronizationMode]
+            #     Optional. The subproperty feature synchronization mode for Custom
+            #     Dimensions and Metrics
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Analytics::Admin::V1alpha::ProvisionSubpropertyResponse]
@@ -14560,6 +14563,288 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # List all Subproperty Sync Configs on a property.
+            #
+            # @overload list_subproperty_sync_configs(request, options = nil)
+            #   Pass arguments to `list_subproperty_sync_configs` via a request object, either of type
+            #   {::Google::Analytics::Admin::V1alpha::ListSubpropertySyncConfigsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Analytics::Admin::V1alpha::ListSubpropertySyncConfigsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload list_subproperty_sync_configs(parent: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `list_subproperty_sync_configs` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. Resource name of the property.
+            #     Format: properties/property_id
+            #     Example: properties/123
+            #   @param page_size [::Integer]
+            #     Optional. The maximum number of resources to return. The service may return
+            #     fewer than this value, even if there are additional pages. If unspecified,
+            #     at most 50 resources will be returned. The maximum value is 200; (higher
+            #     values will be coerced to the maximum)
+            #   @param page_token [::String]
+            #     Optional. A page token, received from a previous
+            #     `ListSubpropertySyncConfig` call. Provide this to retrieve the subsequent
+            #     page. When paginating, all other parameters provided to
+            #     `ListSubpropertySyncConfig` must match the call that provided the page
+            #     token.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/analytics/admin/v1alpha"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Admin::V1alpha::ListSubpropertySyncConfigsRequest.new
+            #
+            #   # Call the list_subproperty_sync_configs method.
+            #   result = client.list_subproperty_sync_configs request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
+            #     # Each element is of type ::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig.
+            #     p item
+            #   end
+            #
+            def list_subproperty_sync_configs request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListSubpropertySyncConfigsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.list_subproperty_sync_configs.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.list_subproperty_sync_configs.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.list_subproperty_sync_configs.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @analytics_admin_service_stub.call_rpc :list_subproperty_sync_configs, request, options: options do |response, operation|
+                response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_subproperty_sync_configs, request, response, operation, options
+                yield response, operation if block_given?
+                throw :response, response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Updates a Subproperty Sync Config.
+            #
+            # @overload update_subproperty_sync_config(request, options = nil)
+            #   Pass arguments to `update_subproperty_sync_config` via a request object, either of type
+            #   {::Google::Analytics::Admin::V1alpha::UpdateSubpropertySyncConfigRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Analytics::Admin::V1alpha::UpdateSubpropertySyncConfigRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload update_subproperty_sync_config(subproperty_sync_config: nil, update_mask: nil)
+            #   Pass arguments to `update_subproperty_sync_config` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param subproperty_sync_config [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig, ::Hash]
+            #     Required. The SubpropertySyncConfig to update.
+            #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     Optional. The list of fields to update. Field names must be in snake case
+            #     (for example, "field_to_update"). Omitted fields will not be updated. To
+            #     replace the entire entity, use one path with the string "*" to match all
+            #     fields.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/analytics/admin/v1alpha"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Admin::V1alpha::UpdateSubpropertySyncConfigRequest.new
+            #
+            #   # Call the update_subproperty_sync_config method.
+            #   result = client.update_subproperty_sync_config request
+            #
+            #   # The returned object is of type Google::Analytics::Admin::V1alpha::SubpropertySyncConfig.
+            #   p result
+            #
+            def update_subproperty_sync_config request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateSubpropertySyncConfigRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.update_subproperty_sync_config.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.subproperty_sync_config&.name
+                header_params["subproperty_sync_config.name"] = request.subproperty_sync_config.name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.update_subproperty_sync_config.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.update_subproperty_sync_config.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @analytics_admin_service_stub.call_rpc :update_subproperty_sync_config, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Lookup for a single Subproperty Sync Config.
+            #
+            # @overload get_subproperty_sync_config(request, options = nil)
+            #   Pass arguments to `get_subproperty_sync_config` via a request object, either of type
+            #   {::Google::Analytics::Admin::V1alpha::GetSubpropertySyncConfigRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Analytics::Admin::V1alpha::GetSubpropertySyncConfigRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload get_subproperty_sync_config(name: nil)
+            #   Pass arguments to `get_subproperty_sync_config` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. Resource name of the SubpropertySyncConfig to lookup.
+            #     Format:
+            #     properties/\\{ordinary_property_id}/subpropertySyncConfigs/\\{subproperty_id}
+            #     Example: properties/1234/subpropertySyncConfigs/5678
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Analytics::Admin::V1alpha::SubpropertySyncConfig]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/analytics/admin/v1alpha"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Admin::V1alpha::GetSubpropertySyncConfigRequest.new
+            #
+            #   # Call the get_subproperty_sync_config method.
+            #   result = client.get_subproperty_sync_config request
+            #
+            #   # The returned object is of type Google::Analytics::Admin::V1alpha::SubpropertySyncConfig.
+            #   p result
+            #
+            def get_subproperty_sync_config request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetSubpropertySyncConfigRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.get_subproperty_sync_config.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.get_subproperty_sync_config.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_subproperty_sync_config.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @analytics_admin_service_stub.call_rpc :get_subproperty_sync_config, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the AnalyticsAdminService API.
             #
@@ -15506,6 +15791,21 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :submit_user_deletion
+                ##
+                # RPC-specific configuration for `list_subproperty_sync_configs`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :list_subproperty_sync_configs
+                ##
+                # RPC-specific configuration for `update_subproperty_sync_config`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :update_subproperty_sync_config
+                ##
+                # RPC-specific configuration for `get_subproperty_sync_config`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_subproperty_sync_config
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -15821,6 +16121,12 @@ module Google
                   @delete_reporting_data_annotation = ::Gapic::Config::Method.new delete_reporting_data_annotation_config
                   submit_user_deletion_config = parent_rpcs.submit_user_deletion if parent_rpcs.respond_to? :submit_user_deletion
                   @submit_user_deletion = ::Gapic::Config::Method.new submit_user_deletion_config
+                  list_subproperty_sync_configs_config = parent_rpcs.list_subproperty_sync_configs if parent_rpcs.respond_to? :list_subproperty_sync_configs
+                  @list_subproperty_sync_configs = ::Gapic::Config::Method.new list_subproperty_sync_configs_config
+                  update_subproperty_sync_config_config = parent_rpcs.update_subproperty_sync_config if parent_rpcs.respond_to? :update_subproperty_sync_config
+                  @update_subproperty_sync_config = ::Gapic::Config::Method.new update_subproperty_sync_config_config
+                  get_subproperty_sync_config_config = parent_rpcs.get_subproperty_sync_config if parent_rpcs.respond_to? :get_subproperty_sync_config
+                  @get_subproperty_sync_config = ::Gapic::Config::Method.new get_subproperty_sync_config_config
 
                   yield self if block_given?
                 end

data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb

@@ -611,6 +611,23 @@ module Google
               "properties/#{property}/subpropertyEventFilters/#{sub_property_event_filter}"
             end
 
+            ##
+            # Create a fully-qualified SubpropertySyncConfig resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `properties/{property}/subpropertySyncConfigs/{subproperty_sync_config}`
+            #
+            # @param property [String]
+            # @param subproperty_sync_config [String]
+            #
+            # @return [::String]
+            def subproperty_sync_config_path property:, subproperty_sync_config:
+              raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
+
+              "properties/#{property}/subpropertySyncConfigs/#{subproperty_sync_config}"
+            end
+
             extend self
           end
         end