Class: Google::Ads::GoogleAds::V6::Services::ReachPlanService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V6::Services::ReachPlanService::Client
- Defined in:
- lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb
Overview
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.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
- #reach_plan_service_stub ⇒ Object readonly
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ReachPlanService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ReachPlanService Client instance.
-
#generate_product_mix_ideas(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V6::Services::GenerateProductMixIdeasResponse
Generates a product mix ideas given a set of preferences.
-
#generate_reach_forecast(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V6::Services::GenerateReachForecastResponse
Generates a reach forecast for a given targeting / product mix.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ReachPlanService client object.
-
#list_plannable_locations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::ListPlannableLocationsResponse
Returns the list of plannable locations (for example, countries & DMAs).
-
#list_plannable_products(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V6::Services::ListPlannableProductsResponse
Returns the list of per-location plannable YouTube ad formats with allowed targeting.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ReachPlanService client object.
## Examples
To create a new ReachPlanService client with the default configuration:
client = ::Google::Ads::GoogleAds::V6::Services::ReachPlanService::Client.new
To create a new ReachPlanService client with a custom configuration:
client = ::Google::Ads::GoogleAds::V6::Services::ReachPlanService::Client.new do |config|
config.timeout = 10.0
end
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 118 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/v6/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 credentials ||= Credentials.default scope: @config.scope 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::V6::Services::ReachPlanService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#reach_plan_service_stub ⇒ Object (readonly)
39 40 41 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 39 def reach_plan_service_stub @reach_plan_service_stub end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ReachPlanService Client class.
See Configuration for a description of the configuration fields.
## Example
To modify the configuration for all ReachPlanService clients:
::Google::Ads::GoogleAds::V6::Services::ReachPlanService::Client.configure do |config|
config.timeout = 10.0
end
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 60 def self.configure @configure ||= begin default_config = Client::Configuration.new default_config.timeout = 3600.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 |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
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 configure.
See Configuration for a description of the configuration fields.
93 94 95 96 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 93 def configure yield @config if block_given? @config end |
#generate_product_mix_ideas(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::GenerateProductMixIdeasResponse #generate_product_mix_ideas(customer_id: nil, plannable_location_id: nil, currency_code: nil, budget_micros: nil, preferences: nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::GenerateProductMixIdeasResponse
Generates a product mix ideas given a set of preferences. This method helps the advertiser to obtain a good mix of ad formats and budget allocations based on its preferences.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 309 def generate_product_mix_ideas request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V6::Services::GenerateProductMixIdeasRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.generate_product_mix_ideas..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "customer_id" => request.customer_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.generate_product_mix_ideas.timeout, metadata: , retry_policy: @config.rpcs.generate_product_mix_ideas.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @reach_plan_service_stub.call_rpc :generate_product_mix_ideas, request, 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 |
#generate_reach_forecast(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::GenerateReachForecastResponse #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, targeting: nil, planned_products: nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::GenerateReachForecastResponse
Generates a reach forecast for a given targeting / product mix.
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 415 def generate_reach_forecast request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V6::Services::GenerateReachForecastRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.generate_reach_forecast..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "customer_id" => request.customer_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.generate_reach_forecast.timeout, metadata: , retry_policy: @config.rpcs.generate_reach_forecast.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @reach_plan_service_stub.call_rpc :generate_reach_forecast, request, 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 |
#list_plannable_locations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::ListPlannableLocationsResponse
Returns the list of plannable locations (for example, countries & DMAs).
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 172 def list_plannable_locations request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V6::Services::ListPlannableLocationsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_plannable_locations..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_plannable_locations.timeout, metadata: , retry_policy: @config.rpcs.list_plannable_locations.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @reach_plan_service_stub.call_rpc :list_plannable_locations, request, 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 |
#list_plannable_products(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::ListPlannableProductsResponse #list_plannable_products(plannable_location_id: nil) ⇒ ::Google::Ads::GoogleAds::V6::Services::ListPlannableProductsResponse
Returns the list of per-location plannable YouTube ad formats with allowed targeting.
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/google/ads/google_ads/v6/services/reach_plan_service/client.rb', line 234 def list_plannable_products request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V6::Services::ListPlannableProductsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_plannable_products..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_plannable_products.timeout, metadata: , retry_policy: @config.rpcs.list_plannable_products.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @reach_plan_service_stub.call_rpc :list_plannable_products, request, 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 |