# frozen_string_literal: true # Copyright 2022 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! # require "google/ads/google_ads/error" require "google/ads/google_ads/v11/services/campaign_experiment_service_pb" module Google module Ads module GoogleAds module V11 module Services module CampaignExperimentService ## # Client for the CampaignExperimentService service. # # CampaignExperimentService manages the life cycle of campaign experiments. # It is used to create new experiments from drafts, modify experiment # properties, promote changes in an experiment back to its base campaign, # graduate experiments into new stand-alone campaigns, and to remove an # experiment. # # An experiment consists of two variants or arms - the base campaign and the # experiment campaign, directing a fixed share of traffic to each arm. # A campaign experiment is created from a draft of changes to the base campaign # and will be a snapshot of changes in the draft at the time of creation. # class Client include Paths # @private attr_reader :campaign_experiment_service_stub ## # Configure the CampaignExperimentService Client class. # # See {::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all CampaignExperimentService clients # ::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin default_config = Client::Configuration.new default_config.timeout = 14_400.0 default_config.retry_policy = { initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config end yield @configure if block_given? @configure end ## # Configure the CampaignExperimentService Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new CampaignExperimentService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new # # # Create a client using a custom configuration # client = ::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the CampaignExperimentService client. # @yieldparam config [Client::Configuration] # def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/ads/google_ads/v11/services/campaign_experiment_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @campaign_experiment_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end ## # Get the associated client for long-running operations. # # @return [::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Operations] # attr_reader :operations_client # Service calls ## # Creates a campaign experiment based on a campaign draft. The draft campaign # will be forked into a real campaign (called the experiment campaign) that # will begin serving ads if successfully created. # # The campaign experiment is created immediately with status INITIALIZING. # This method return a long running operation that tracks the forking of the # draft campaign. If the forking fails, a list of errors can be retrieved # using the ListCampaignExperimentAsyncErrors method. The operation's # metadata will be a StringValue containing the resource name of the created # campaign experiment. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [CampaignExperimentError]() # [DatabaseError]() # [DateError]() # [DateRangeError]() # [FieldError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RangeError]() # [RequestError]() # # @overload create_campaign_experiment(request, options = nil) # Pass arguments to `create_campaign_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V11::Services::CreateCampaignExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V11::Services::CreateCampaignExperimentRequest, ::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 create_campaign_experiment(customer_id: nil, campaign_experiment: nil, validate_only: nil) # Pass arguments to `create_campaign_experiment` 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 customer_id [::String] # Required. The ID of the customer whose campaign experiment is being created. # @param campaign_experiment [::Google::Ads::GoogleAds::V11::Resources::CampaignExperiment, ::Hash] # Required. The campaign experiment to be created. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v11/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V11::Services::CreateCampaignExperimentRequest.new # # # Call the create_campaign_experiment method. # result = client.create_campaign_experiment request # # # The returned object is of type Gapic::Operation. You can use this # # object to check the status of an operation, cancel it, or wait # # for results. Here is how to block until completion: # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "Error!" # end # def create_campaign_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V11::Services::CreateCampaignExperimentRequest # 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.create_campaign_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.customer_id header_params["customer_id"] = request.customer_id 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.create_campaign_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.create_campaign_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @campaign_experiment_service_stub.call_rpc :create_campaign_experiment, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Updates campaign experiments. Operation statuses are returned. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [CampaignExperimentError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload mutate_campaign_experiments(request, options = nil) # Pass arguments to `mutate_campaign_experiments` via a request object, either of type # {::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsRequest, ::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 mutate_campaign_experiments(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) # Pass arguments to `mutate_campaign_experiments` 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 customer_id [::String] # Required. The ID of the customer whose campaign experiments are being modified. # @param operations [::Array<::Google::Ads::GoogleAds::V11::Services::CampaignExperimentOperation, ::Hash>] # Required. The list of operations to perform on individual campaign experiments. # @param partial_failure [::Boolean] # If true, successful operations will be carried out and invalid # operations will return errors. If false, all operations will be carried # out in one transaction if and only if they are all valid. # Default is false. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # @param response_content_type [::Google::Ads::GoogleAds::V11::Enums::ResponseContentTypeEnum::ResponseContentType] # The response content type setting. Determines whether the mutable resource # or just the resource name should be returned post mutation. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v11/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsRequest.new # # # Call the mutate_campaign_experiments method. # result = client.mutate_campaign_experiments request # # # The returned object is of type Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsResponse. # p result # def mutate_campaign_experiments request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V11::Services::MutateCampaignExperimentsRequest # 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.mutate_campaign_experiments.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.customer_id header_params["customer_id"] = request.customer_id 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.mutate_campaign_experiments.timeout, metadata: metadata, retry_policy: @config.rpcs.mutate_campaign_experiments.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @campaign_experiment_service_stub.call_rpc :mutate_campaign_experiments, request, options: options do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Graduates a campaign experiment to a full campaign. The base and experiment # campaigns will start running independently with their own budgets. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [CampaignExperimentError]() # [HeaderError]() # [InternalError]() # [MutateError]() # [QuotaError]() # [RequestError]() # # @overload graduate_campaign_experiment(request, options = nil) # Pass arguments to `graduate_campaign_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentRequest, ::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 graduate_campaign_experiment(campaign_experiment: nil, campaign_budget: nil, validate_only: nil) # Pass arguments to `graduate_campaign_experiment` 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 campaign_experiment [::String] # Required. The resource name of the campaign experiment to graduate. # @param campaign_budget [::String] # Required. Resource name of the budget to attach to the campaign graduated from the # experiment. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v11/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentRequest.new # # # Call the graduate_campaign_experiment method. # result = client.graduate_campaign_experiment request # # # The returned object is of type Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentResponse. # p result # def graduate_campaign_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V11::Services::GraduateCampaignExperimentRequest # 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.graduate_campaign_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.campaign_experiment header_params["campaign_experiment"] = request.campaign_experiment 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.graduate_campaign_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.graduate_campaign_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @campaign_experiment_service_stub.call_rpc :graduate_campaign_experiment, request, options: options do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Promotes the changes in a experiment campaign back to the base campaign. # # The campaign experiment is updated immediately with status PROMOTING. # This method return a long running operation that tracks the promoting of # the experiment campaign. If the promoting fails, a list of errors can be # retrieved using the ListCampaignExperimentAsyncErrors method. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload promote_campaign_experiment(request, options = nil) # Pass arguments to `promote_campaign_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V11::Services::PromoteCampaignExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V11::Services::PromoteCampaignExperimentRequest, ::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 promote_campaign_experiment(campaign_experiment: nil, validate_only: nil) # Pass arguments to `promote_campaign_experiment` 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 campaign_experiment [::String] # Required. The resource name of the campaign experiment to promote. # @param validate_only [::Boolean] # If true, the request is validated but no Long Running Operation is created. # Only errors are returned. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v11/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V11::Services::PromoteCampaignExperimentRequest.new # # # Call the promote_campaign_experiment method. # result = client.promote_campaign_experiment request # # # The returned object is of type Gapic::Operation. You can use this # # object to check the status of an operation, cancel it, or wait # # for results. Here is how to block until completion: # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "Error!" # end # def promote_campaign_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V11::Services::PromoteCampaignExperimentRequest # 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.promote_campaign_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.campaign_experiment header_params["campaign_experiment"] = request.campaign_experiment 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.promote_campaign_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.promote_campaign_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @campaign_experiment_service_stub.call_rpc :promote_campaign_experiment, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Immediately ends a campaign experiment, changing the experiment's scheduled # end date and without waiting for end of day. End date is updated to be the # time of the request. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [CampaignExperimentError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload end_campaign_experiment(request, options = nil) # Pass arguments to `end_campaign_experiment` via a request object, either of type # {::Google::Ads::GoogleAds::V11::Services::EndCampaignExperimentRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V11::Services::EndCampaignExperimentRequest, ::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 end_campaign_experiment(campaign_experiment: nil, validate_only: nil) # Pass arguments to `end_campaign_experiment` 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 campaign_experiment [::String] # Required. The resource name of the campaign experiment to end. # @param validate_only [::Boolean] # If true, the request is validated but not executed. Only errors are # returned, not results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v11/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V11::Services::EndCampaignExperimentRequest.new # # # Call the end_campaign_experiment method. # result = client.end_campaign_experiment request # # # The returned object is of type Google::Protobuf::Empty. # p result # def end_campaign_experiment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V11::Services::EndCampaignExperimentRequest # 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.end_campaign_experiment.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.campaign_experiment header_params["campaign_experiment"] = request.campaign_experiment 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.end_campaign_experiment.timeout, metadata: metadata, retry_policy: @config.rpcs.end_campaign_experiment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @campaign_experiment_service_stub.call_rpc :end_campaign_experiment, request, options: options do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Returns all errors that occurred during CampaignExperiment create or # promote (whichever occurred last). # Supports standard list paging. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload list_campaign_experiment_async_errors(request, options = nil) # Pass arguments to `list_campaign_experiment_async_errors` via a request object, either of type # {::Google::Ads::GoogleAds::V11::Services::ListCampaignExperimentAsyncErrorsRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V11::Services::ListCampaignExperimentAsyncErrorsRequest, ::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_campaign_experiment_async_errors(resource_name: nil, page_token: nil, page_size: nil) # Pass arguments to `list_campaign_experiment_async_errors` 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 resource_name [::String] # Required. The name of the campaign experiment from which to retrieve the async # errors. # @param page_token [::String] # Token of the page to retrieve. If not specified, the first # page of results will be returned. Use the value obtained from # `next_page_token` in the previous response in order to request # the next page of results. # @param page_size [::Integer] # Number of elements to retrieve in a single page. # When a page request is too large, the server may decide to # further limit the number of returned resources. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Rpc::Status>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Rpc::Status>] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v11/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V11::Services::ListCampaignExperimentAsyncErrorsRequest.new # # # Call the list_campaign_experiment_async_errors method. # result = client.list_campaign_experiment_async_errors request # # # The returned object is of type Gapic::PagedEnumerable. You can # # iterate over all elements by calling #each, and the enumerable # # will lazily make API calls to fetch subsequent pages. Other # # methods are also available for managing paging directly. # result.each do |response| # # Each element is of type ::Google::Rpc::Status. # p response # end # def list_campaign_experiment_async_errors request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V11::Services::ListCampaignExperimentAsyncErrorsRequest # 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_campaign_experiment_async_errors.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Ads::GoogleAds::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource_name header_params["resource_name"] = request.resource_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.list_campaign_experiment_async_errors.timeout, metadata: metadata, retry_policy: @config.rpcs.list_campaign_experiment_async_errors.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @campaign_experiment_service_stub.call_rpc :list_campaign_experiment_async_errors, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @campaign_experiment_service_stub, :list_campaign_experiment_async_errors, request, response, operation, options yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end ## # Configuration class for the CampaignExperimentService API. # # This class represents the configuration for CampaignExperimentService, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # create_campaign_experiment to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_campaign_experiment.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Ads::GoogleAds::V11::Services::CampaignExperimentService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_campaign_experiment.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"googleads.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config config_attr :endpoint, "googleads.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the CampaignExperimentService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_campaign_experiment` # @return [::Gapic::Config::Method] # attr_reader :create_campaign_experiment ## # RPC-specific configuration for `mutate_campaign_experiments` # @return [::Gapic::Config::Method] # attr_reader :mutate_campaign_experiments ## # RPC-specific configuration for `graduate_campaign_experiment` # @return [::Gapic::Config::Method] # attr_reader :graduate_campaign_experiment ## # RPC-specific configuration for `promote_campaign_experiment` # @return [::Gapic::Config::Method] # attr_reader :promote_campaign_experiment ## # RPC-specific configuration for `end_campaign_experiment` # @return [::Gapic::Config::Method] # attr_reader :end_campaign_experiment ## # RPC-specific configuration for `list_campaign_experiment_async_errors` # @return [::Gapic::Config::Method] # attr_reader :list_campaign_experiment_async_errors # @private def initialize parent_rpcs = nil create_campaign_experiment_config = parent_rpcs.create_campaign_experiment if parent_rpcs.respond_to? :create_campaign_experiment @create_campaign_experiment = ::Gapic::Config::Method.new create_campaign_experiment_config mutate_campaign_experiments_config = parent_rpcs.mutate_campaign_experiments if parent_rpcs.respond_to? :mutate_campaign_experiments @mutate_campaign_experiments = ::Gapic::Config::Method.new mutate_campaign_experiments_config graduate_campaign_experiment_config = parent_rpcs.graduate_campaign_experiment if parent_rpcs.respond_to? :graduate_campaign_experiment @graduate_campaign_experiment = ::Gapic::Config::Method.new graduate_campaign_experiment_config promote_campaign_experiment_config = parent_rpcs.promote_campaign_experiment if parent_rpcs.respond_to? :promote_campaign_experiment @promote_campaign_experiment = ::Gapic::Config::Method.new promote_campaign_experiment_config end_campaign_experiment_config = parent_rpcs.end_campaign_experiment if parent_rpcs.respond_to? :end_campaign_experiment @end_campaign_experiment = ::Gapic::Config::Method.new end_campaign_experiment_config list_campaign_experiment_async_errors_config = parent_rpcs.list_campaign_experiment_async_errors if parent_rpcs.respond_to? :list_campaign_experiment_async_errors @list_campaign_experiment_async_errors = ::Gapic::Config::Method.new list_campaign_experiment_async_errors_config yield self if block_given? end end end end end end end end end end