Class: Google::Ads::GoogleAds::V11::Services::AudienceInsightsService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb

Overview

Client for the AudienceInsightsService service.

Audience Insights Service helps users find information about groups of people and how they can be reached with Google Ads.

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 AudienceInsightsService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the AudienceInsightsService client.

Yield Parameters:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb', line 107

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/audience_insights_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

  @audience_insights_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V11::Services::AudienceInsightsService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#audience_insights_service_stub ⇒ Object (readonly) 



36
37
38
 
# File 'lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb', line 36

def audience_insights_service_stub
  @audience_insights_service_stub
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the AudienceInsightsService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb', line 56

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



86
87
88
89
 
# File 'lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb', line 86

def configure
  yield @config if block_given?
  @config
end

#generate_audience_composition_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsResponse #generate_audience_composition_insights(customer_id: nil, audience: nil, data_month: nil, dimensions: nil, customer_insights_group: nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsResponse

Returns a collection of attributes that are represented in an audience of interest, with metrics that compare each attribute’s share of the audience with its share of a baseline audience.

List of thrown errors:

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

Examples:

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::AudienceInsightsService::Client.new

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

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

# The returned object is of type Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

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

    if the RPC is aborted.



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
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb', line 421

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsRequest

  # 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_audience_composition_insights.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_audience_composition_insights.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_audience_composition_insights.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @audience_insights_service_stub.call_rpc :generate_audience_composition_insights, 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_insights_finder_report(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GenerateInsightsFinderReportResponse #generate_insights_finder_report(customer_id: nil, baseline_audience: nil, specific_audience: nil, customer_insights_group: nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::GenerateInsightsFinderReportResponse

Creates a saved report that can be viewed in the Insights Finder tool.

List of thrown errors:

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

Examples:

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::AudienceInsightsService::Client.new

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

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

# The returned object is of type Google::Ads::GoogleAds::V11::Services::GenerateInsightsFinderReportResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

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

    if the RPC is aborted.



207
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
242
243
244
245
246
247
248
 
# File 'lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb', line 207

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V11::Services::GenerateInsightsFinderReportRequest

  # 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_insights_finder_report.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_insights_finder_report.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_insights_finder_report.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @audience_insights_service_stub.call_rpc :generate_insights_finder_report, 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_audience_insights_attributes(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::ListAudienceInsightsAttributesResponse #list_audience_insights_attributes(customer_id: nil, dimensions: nil, query_text: nil, customer_insights_group: nil) ⇒ ::Google::Ads::GoogleAds::V11::Services::ListAudienceInsightsAttributesResponse

Searches for audience attributes that can be used to generate insights.

List of thrown errors:

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

Examples:

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::AudienceInsightsService::Client.new

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

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

# The returned object is of type Google::Ads::GoogleAds::V11::Services::ListAudienceInsightsAttributesResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

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

    if the RPC is aborted.



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
345
346
347
348
349
350
351
352
 
# File 'lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb', line 311

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V11::Services::ListAudienceInsightsAttributesRequest

  # 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_audience_insights_attributes.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.list_audience_insights_attributes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_audience_insights_attributes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @audience_insights_service_stub.call_rpc :list_audience_insights_attributes, 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