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

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

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ReachPlanService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Ads::GoogleAds::V16::Services::ReachPlanService::Client.new

# Create a client using a custom configuration
client = ::Google::Ads::GoogleAds::V16::Services::ReachPlanService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ReachPlanService client.

Yield Parameters:



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
154
155
156
157
158
159
160
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 122

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/v16/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::V16::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

Instance Attribute Details

#reach_plan_service_stub ⇒ Object (readonly) 



42
43
44
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 42

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.

Examples:


# Modify the configuration for all ReachPlanService clients
::Google::Ads::GoogleAds::V16::Services::ReachPlanService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 62

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

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:



92
93
94
95
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 92

def configure
  yield @config if block_given?
  @config
end

#generate_reach_forecast(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::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, effective_frequency_limit: nil, targeting: nil, planned_products: nil, forecast_metric_options: nil, customer_reach_group: nil) ⇒ ::Google::Ads::GoogleAds::V16::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]()

Examples:

Basic example

require "google/ads/google_ads/v16/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V16::Services::ReachPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V16::Services::GenerateReachForecastRequest.new

# Call the generate_reach_forecast method.
result = client.generate_reach_forecast request

# The returned object is of type Google::Ads::GoogleAds::V16::Services::GenerateReachForecastResponse.
p result

Overloads:

  • #generate_reach_forecast(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::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::V16::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, effective_frequency_limit: nil, targeting: nil, planned_products: nil, forecast_metric_options: nil, customer_reach_group: nil) ⇒ ::Google::Ads::GoogleAds::V16::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::V16::Services::CampaignDuration, ::Hash) (defaults to: nil) —

      Required. Campaign duration.

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

      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.

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

      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.

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

      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.

    • effective_frequency_limit (::Google::Ads::GoogleAds::V16::Services::EffectiveFrequencyLimit, ::Hash) (defaults to: nil) —

      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.

    • targeting (::Google::Ads::GoogleAds::V16::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, consult an implementation specialist.

      See specific metrics for details on how targeting affects them.

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

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

    • forecast_metric_options (::Google::Ads::GoogleAds::V16::Services::ForecastMetricOptions, ::Hash) (defaults to: nil) —

      Controls the forecast metrics returned in the response.

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

      The name of the customer being planned for. This is a user-defined value.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 442

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::V16::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 = {}
  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

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

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

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v16/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V16::Services::ReachPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V16::Services::ListPlannableLocationsRequest.new

# Call the list_plannable_locations method.
result = client.list_plannable_locations request

# The returned object is of type Google::Ads::GoogleAds::V16::Services::ListPlannableLocationsResponse.
p result

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

Parameters:

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 208

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

#list_plannable_products(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::ListPlannableProductsResponse #list_plannable_products(plannable_location_id: nil) ⇒ ::Google::Ads::GoogleAds::V16::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]()

Examples:

Basic example

require "google/ads/google_ads/v16/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V16::Services::ReachPlanService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V16::Services::ListPlannableProductsRequest.new

# Call the list_plannable_products method.
result = client.list_plannable_products request

# The returned object is of type Google::Ads::GoogleAds::V16::Services::ListPlannableProductsResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 298

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


102
103
104
 
# File 'lib/google/ads/google_ads/v16/services/reach_plan_service/client.rb', line 102

def universe_domain
  @reach_plan_service_stub.universe_domain
end