Class: Google::Ads::GoogleAds::V8::Services::ReachPlanService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/ads/google_ads/v8/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

Class Method Summary collapse

Instance Method Summary collapse

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::V8::Services::ReachPlanService::Client.new

To create a new ReachPlanService client with a custom configuration:

client = ::Google::Ads::GoogleAds::V8::Services::ReachPlanService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ReachPlanService client.

Yield Parameters:



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
148
149
150
151
152
153
 
# File 'lib/google/ads/google_ads/v8/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/v8/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 scope and endpoint are unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
                           @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

  @reach_plan_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V8::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/v8/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::V8::Services::ReachPlanService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/ads/google_ads/v8/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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



93
94
95
96
 
# File 'lib/google/ads/google_ads/v8/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::V8::Services::GenerateProductMixIdeasResponse #generate_product_mix_ideas(customer_id: nil, plannable_location_id: nil, currency_code: nil, budget_micros: nil, preferences: nil) ⇒ ::Google::Ads::GoogleAds::V8::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.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[ReachPlanError]()
[RequestError]()

Overloads:

  • #generate_product_mix_ideas(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::GenerateProductMixIdeasResponse

    Pass arguments to ‘generate_product_mix_ideas` via a request object, either of type GenerateProductMixIdeasRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V8::Services::GenerateProductMixIdeasRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #generate_product_mix_ideas(customer_id: nil, plannable_location_id: nil, currency_code: nil, budget_micros: nil, preferences: nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::GenerateProductMixIdeasResponse

    Pass arguments to ‘generate_product_mix_ideas` 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).

    Parameters:

    • customer_id (::String) (defaults to: nil) —

      Required. The ID of the customer.

    • plannable_location_id (::String) (defaults to: nil) —

      Required. The ID of the location, this is one of the ids returned by ListPlannableLocations.

    • currency_code (::String) (defaults to: nil) —

      Required. Currency code. Three-character ISO 4217 currency code.

    • budget_micros (::Integer) (defaults to: nil) —

      Required. Total budget. Amount in micros. One million is equivalent to one unit.

    • preferences (::Google::Ads::GoogleAds::V8::Services::Preferences, ::Hash) (defaults to: nil) —

      The preferences of the suggested product mix. An unset preference is interpreted as all possible values are allowed, unless explicitly specified.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/google/ads/google_ads/v8/services/reach_plan_service/client.rb', line 344

def generate_product_mix_ideas request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::GenerateProductMixIdeasRequest

  # 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_product_mix_ideas.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 = {
    "customer_id" => request.customer_id
  }
  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_product_mix_ideas.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_product_mix_ideas.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @reach_plan_service_stub.call_rpc :generate_product_mix_ideas, 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

#generate_reach_forecast(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::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::V8::Services::GenerateReachForecastResponse

Generates a reach forecast for a given targeting / product mix.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RangeError]()
[ReachPlanError]()
[RequestError]()

Overloads:

  • #generate_reach_forecast(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::GenerateReachForecastResponse

    Pass arguments to ‘generate_reach_forecast` via a request object, either of type GenerateReachForecastRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V8::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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::V8::Services::GenerateReachForecastResponse

    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).

    Parameters:

    • customer_id (::String) (defaults to: nil) —

      Required. The ID of the customer.

    • currency_code (::String) (defaults to: nil) —

      The currency code. Three-character ISO 4217 currency code.

    • campaign_duration (::Google::Ads::GoogleAds::V8::Services::CampaignDuration, ::Hash) (defaults to: nil) —

      Required. Campaign duration.

    • cookie_frequency_cap (::Integer) (defaults to: nil) —

      Desired cookie frequency cap that will 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. Please use cookie_frequency_cap_setting instead.

    • cookie_frequency_cap_setting (::Google::Ads::GoogleAds::V8::Services::FrequencyCap, ::Hash) (defaults to: nil) —

      Desired cookie frequency cap that will 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, no cap is applied.

      This field replaces the deprecated cookie_frequency_cap field.

    • min_effective_frequency (::Integer) (defaults to: nil) —

      Desired 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.

    • targeting (::Google::Ads::GoogleAds::V8::Services::Targeting, ::Hash) (defaults to: nil) —

      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, please consult an implementation specialist.

      See specific metrics for details on how targeting affects them.

    • planned_products (::Array<::Google::Ads::GoogleAds::V8::Services::PlannedProduct, ::Hash>) (defaults to: nil) —

      Required. The products to be forecast. The max number of allowed planned products is 15.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/google/ads/google_ads/v8/services/reach_plan_service/client.rb', line 460

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::V8::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 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 = {
    "customer_id" => request.customer_id
  }
  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 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

#list_plannable_locations(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::ListPlannableLocationsResponse

Returns the list of plannable locations (for example, countries & DMAs).

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

Pass arguments to ‘list_plannable_locations` via a request object, either of type ListPlannableLocationsRequest or an equivalent Hash.

Parameters:

  • request (::Google::Ads::GoogleAds::V8::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.

  • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/google/ads/google_ads/v8/services/reach_plan_service/client.rb', line 186

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::V8::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 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

  options.apply_defaults timeout:      @config.rpcs.list_plannable_locations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_plannable_locations.retry_policy
  options.apply_defaults 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

#list_plannable_products(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::ListPlannableProductsResponse #list_plannable_products(plannable_location_id: nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::ListPlannableProductsResponse

Returns the list of per-location plannable YouTube ad formats with allowed targeting.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

Overloads:

  • #list_plannable_products(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::ListPlannableProductsResponse

    Pass arguments to ‘list_plannable_products` via a request object, either of type ListPlannableProductsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V8::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_plannable_products(plannable_location_id: nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::ListPlannableProductsResponse

    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).

    Parameters:

    • plannable_location_id (::String) (defaults to: nil) —

      Required. The ID of the selected location for planning. To list the available plannable location ids use ListPlannableLocations.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/google/ads/google_ads/v8/services/reach_plan_service/client.rb', line 258

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::V8::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 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

  options.apply_defaults timeout:      @config.rpcs.list_plannable_products.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_plannable_products.retry_policy
  options.apply_defaults 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