# frozen_string_literal: true # Copyright 2024 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/v17/services/reach_plan_service_pb" module Google module Ads module GoogleAds module V17 module Services module ReachPlanService ## # Client for the ReachPlanService service. # # Reach Plan Service gives users information about audience size that can # be reached through advertisement on YouTube. In particular, # GenerateReachForecast provides estimated number of people of specified # demographics that can be reached by an ad in a given market by a campaign of # certain duration with a defined budget. # class Client # @private API_VERSION = "" # @private DEFAULT_ENDPOINT_TEMPLATE = "googleads.$UNIVERSE_DOMAIN$" # @private attr_reader :reach_plan_service_stub ## # Configure the ReachPlanService Client class. # # See {::Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all ReachPlanService clients # ::Google::Ads::GoogleAds::V17::Services::ReachPlanService::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 ReachPlanService 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::V17::Services::ReachPlanService::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 ## # The effective universe domain # # @return [String] # def universe_domain @reach_plan_service_stub.universe_domain end ## # Create a new ReachPlanService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client.new # # # Create a client using a custom configuration # client = ::Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the ReachPlanService 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/v17/services/reach_plan_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.nil? || (@config.endpoint == Configuration::DEFAULT_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 @reach_plan_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V17::Services::ReachPlanService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end # Service calls ## # Returns the list of plannable locations (for example, countries). # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload list_plannable_locations(request, options = nil) # Pass arguments to `list_plannable_locations` via a request object, either of type # {::Google::Ads::GoogleAds::V17::Services::ListPlannableLocationsRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V17::Services::ListPlannableLocationsRequest, ::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. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Ads::GoogleAds::V17::Services::ListPlannableLocationsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Ads::GoogleAds::V17::Services::ListPlannableLocationsResponse] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v17/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V17::Services::ListPlannableLocationsRequest.new # # # Call the list_plannable_locations method. # result = client.list_plannable_locations request # # # The returned object is of type Google::Ads::GoogleAds::V17::Services::ListPlannableLocationsResponse. # p result # def list_plannable_locations request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::ListPlannableLocationsRequest # 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_plannable_locations.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::Ads::GoogleAds::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_plannable_locations.timeout, metadata: metadata, retry_policy: @config.rpcs.list_plannable_locations.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @reach_plan_service_stub.call_rpc :list_plannable_locations, 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 the list of per-location plannable YouTube ad formats with allowed # targeting. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RequestError]() # # @overload list_plannable_products(request, options = nil) # Pass arguments to `list_plannable_products` via a request object, either of type # {::Google::Ads::GoogleAds::V17::Services::ListPlannableProductsRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V17::Services::ListPlannableProductsRequest, ::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_plannable_products(plannable_location_id: nil) # Pass arguments to `list_plannable_products` 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 plannable_location_id [::String] # Required. The ID of the selected location for planning. To list the # available plannable location IDs use # {::Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client#list_plannable_locations ReachPlanService.ListPlannableLocations}. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Ads::GoogleAds::V17::Services::ListPlannableProductsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Ads::GoogleAds::V17::Services::ListPlannableProductsResponse] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v17/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V17::Services::ListPlannableProductsRequest.new # # # Call the list_plannable_products method. # result = client.list_plannable_products request # # # The returned object is of type Google::Ads::GoogleAds::V17::Services::ListPlannableProductsResponse. # p result # def list_plannable_products request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::ListPlannableProductsRequest # 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_plannable_products.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::Ads::GoogleAds::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_plannable_products.timeout, metadata: metadata, retry_policy: @config.rpcs.list_plannable_products.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @reach_plan_service_stub.call_rpc :list_plannable_products, 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 ## # Generates a reach forecast for a given targeting / product mix. # # List of thrown errors: # [AuthenticationError]() # [AuthorizationError]() # [FieldError]() # [HeaderError]() # [InternalError]() # [QuotaError]() # [RangeError]() # [ReachPlanError]() # [RequestError]() # # @overload generate_reach_forecast(request, options = nil) # Pass arguments to `generate_reach_forecast` via a request object, either of type # {::Google::Ads::GoogleAds::V17::Services::GenerateReachForecastRequest} or an equivalent Hash. # # @param request [::Google::Ads::GoogleAds::V17::Services::GenerateReachForecastRequest, ::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 generate_reach_forecast(customer_id: nil, currency_code: nil, campaign_duration: nil, cookie_frequency_cap: nil, cookie_frequency_cap_setting: nil, min_effective_frequency: nil, effective_frequency_limit: nil, targeting: nil, planned_products: nil, forecast_metric_options: nil, customer_reach_group: nil) # Pass arguments to `generate_reach_forecast` 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. # @param currency_code [::String] # The currency code. # Three-character ISO 4217 currency code. # @param campaign_duration [::Google::Ads::GoogleAds::V17::Services::CampaignDuration, ::Hash] # Required. Campaign duration. # @param cookie_frequency_cap [::Integer] # Chosen cookie frequency cap to be applied to each planned product. # This is equivalent to the frequency cap exposed in Google Ads when creating # a campaign, it represents the maximum number of times an ad can be shown to # the same user. # If not specified, no cap is applied. # # This field is deprecated in v4 and will eventually be removed. # Use cookie_frequency_cap_setting instead. # @param cookie_frequency_cap_setting [::Google::Ads::GoogleAds::V17::Services::FrequencyCap, ::Hash] # Chosen cookie frequency cap to be applied to each planned product. # This is equivalent to the frequency cap exposed in Google Ads when creating # a campaign, it represents the maximum number of times an ad can be shown to # the same user during a specified time interval. # If not specified, a default of 0 (no cap) is applied. # # This field replaces the deprecated cookie_frequency_cap field. # @param min_effective_frequency [::Integer] # Chosen minimum effective frequency (the number of times a person was # exposed to the ad) for the reported reach metrics [1-10]. # This won't affect the targeting, but just the reporting. # If not specified, a default of 1 is applied. # # This field cannot be combined with the effective_frequency_limit field. # @param effective_frequency_limit [::Google::Ads::GoogleAds::V17::Services::EffectiveFrequencyLimit, ::Hash] # The highest minimum effective frequency (the number of times a person was # exposed to the ad) value [1-10] to include in # Forecast.effective_frequency_breakdowns. # If not specified, Forecast.effective_frequency_breakdowns will not be # provided. # # The effective frequency value provided here will also be used as the # minimum effective frequency for the reported reach metrics. # # This field cannot be combined with the min_effective_frequency field. # @param targeting [::Google::Ads::GoogleAds::V17::Services::Targeting, ::Hash] # The targeting to be applied to all products selected in the product mix. # # This is planned targeting: execution details might vary based on the # advertising product, consult an implementation specialist. # # See specific metrics for details on how targeting affects them. # @param planned_products [::Array<::Google::Ads::GoogleAds::V17::Services::PlannedProduct, ::Hash>] # Required. The products to be forecast. # The max number of allowed planned products is 15. # @param forecast_metric_options [::Google::Ads::GoogleAds::V17::Services::ForecastMetricOptions, ::Hash] # Controls the forecast metrics returned in the response. # @param customer_reach_group [::String] # The name of the customer being planned for. This is a user-defined value. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Ads::GoogleAds::V17::Services::GenerateReachForecastResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Ads::GoogleAds::V17::Services::GenerateReachForecastResponse] # # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted. # # @example Basic example # require "google/ads/google_ads/v17/services" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Ads::GoogleAds::V17::Services::GenerateReachForecastRequest.new # # # Call the generate_reach_forecast method. # result = client.generate_reach_forecast request # # # The returned object is of type Google::Ads::GoogleAds::V17::Services::GenerateReachForecastResponse. # p result # def generate_reach_forecast request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::GenerateReachForecastRequest # 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.generate_reach_forecast.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::Ads::GoogleAds::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.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.generate_reach_forecast.timeout, metadata: metadata, retry_policy: @config.rpcs.generate_reach_forecast.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @reach_plan_service_stub.call_rpc :generate_reach_forecast, 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 ## # Configuration class for the ReachPlanService API. # # This class represents the configuration for ReachPlanService, # 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::V17::Services::ReachPlanService::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 # # list_plannable_locations to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_plannable_locations.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Ads::GoogleAds::V17::Services::ReachPlanService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_plannable_locations.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!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://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`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] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :universe_domain, 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 for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the ReachPlanService 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 `list_plannable_locations` # @return [::Gapic::Config::Method] # attr_reader :list_plannable_locations ## # RPC-specific configuration for `list_plannable_products` # @return [::Gapic::Config::Method] # attr_reader :list_plannable_products ## # RPC-specific configuration for `generate_reach_forecast` # @return [::Gapic::Config::Method] # attr_reader :generate_reach_forecast # @private def initialize parent_rpcs = nil list_plannable_locations_config = parent_rpcs.list_plannable_locations if parent_rpcs.respond_to? :list_plannable_locations @list_plannable_locations = ::Gapic::Config::Method.new list_plannable_locations_config list_plannable_products_config = parent_rpcs.list_plannable_products if parent_rpcs.respond_to? :list_plannable_products @list_plannable_products = ::Gapic::Config::Method.new list_plannable_products_config generate_reach_forecast_config = parent_rpcs.generate_reach_forecast if parent_rpcs.respond_to? :generate_reach_forecast @generate_reach_forecast = ::Gapic::Config::Method.new generate_reach_forecast_config yield self if block_given? end end end end end end end end end end