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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/ads/google_ads/v20/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. Accessible to allowlisted customers only.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

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

Examples:


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

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

Yields:

  • (config) —

    Configure the AudienceInsightsService client.

Yield Parameters:



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
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 123

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/v20/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.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

  @audience_insights_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V20::Services::AudienceInsightsService::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,
    logger: @config.logger
  )

  @audience_insights_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#audience_insights_service_stub ⇒ Object (readonly) 



43
44
45
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 43

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::V20::Services::AudienceInsightsService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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:

Returns:



93
94
95
96
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#generate_audience_composition_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceCompositionInsightsResponse #generate_audience_composition_insights(customer_id: nil, audience: nil, baseline_audience: nil, data_month: nil, dimensions: nil, customer_insights_group: nil, insights_application_info: nil) ⇒ ::Google::Ads::GoogleAds::V20::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/v20/services"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V20::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::V20::Services::GenerateAudienceCompositionInsightsResponse.
p result

Overloads:

  • #generate_audience_composition_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceCompositionInsightsResponse

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

    Parameters:

  • #generate_audience_composition_insights(customer_id: nil, audience: nil, baseline_audience: nil, data_month: nil, dimensions: nil, customer_insights_group: nil, insights_application_info: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceCompositionInsightsResponse

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

    • audience (::Google::Ads::GoogleAds::V20::Services::InsightsAudience, ::Hash) (defaults to: nil) —

      Required. The audience of interest for which insights are being requested.

    • baseline_audience (::Google::Ads::GoogleAds::V20::Services::InsightsAudience, ::Hash) (defaults to: nil) —

      The baseline audience to which the audience of interest is being compared.

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

      The one-month range of historical data to use for insights, in the format “yyyy-mm”. If unset, insights will be returned for the last thirty days of data.

    • dimensions (::Array<::Google::Ads::GoogleAds::V20::Enums::AudienceInsightsDimensionEnum::AudienceInsightsDimension>) (defaults to: nil) —

      Required. The audience dimensions for which composition insights should be returned. Supported dimensions are KNOWLEDGE_GRAPH, GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_CHANNEL, YOUTUBE_LINEUP, AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS, INCOME_RANGE, AGE_RANGE, and GENDER.

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

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

    • insights_application_info (::Google::Ads::GoogleAds::V20::Common::AdditionalApplicationInfo, ::Hash) (defaults to: nil) —

      Optional. Additional information on the application issuing the request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 580

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::V20::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, 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_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?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#generate_audience_overlap_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceOverlapInsightsResponse #generate_audience_overlap_insights(customer_id: nil, country_location: nil, primary_attribute: nil, dimensions: nil, customer_insights_group: nil, insights_application_info: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceOverlapInsightsResponse

Returns a collection of audience attributes along with estimates of the overlap between their potential YouTube reach and that of a given input attribute.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v20/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V20::Services::GenerateAudienceOverlapInsightsResponse.
p result

Overloads:

  • #generate_audience_overlap_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceOverlapInsightsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V20::Services::GenerateAudienceOverlapInsightsRequest, ::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_audience_overlap_insights(customer_id: nil, country_location: nil, primary_attribute: nil, dimensions: nil, customer_insights_group: nil, insights_application_info: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceOverlapInsightsResponse

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

    • country_location (::Google::Ads::GoogleAds::V20::Common::LocationInfo, ::Hash) (defaults to: nil) —

      Required. The country in which to calculate the sizes and overlaps of audiences.

    • primary_attribute (::Google::Ads::GoogleAds::V20::Common::AudienceInsightsAttribute, ::Hash) (defaults to: nil) —

      Required. The audience attribute that should be intersected with all other eligible audiences. This must be an Affinity or In-Market UserInterest, an AgeRange or a Gender.

    • dimensions (::Array<::Google::Ads::GoogleAds::V20::Enums::AudienceInsightsDimensionEnum::AudienceInsightsDimension>) (defaults to: nil) —

      Required. The types of attributes of which to calculate the overlap with the primary_attribute. The values must be a subset of AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.

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

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

    • insights_application_info (::Google::Ads::GoogleAds::V20::Common::AdditionalApplicationInfo, ::Hash) (defaults to: nil) —

      Optional. Additional information on the application issuing the request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 806

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V20::Services::GenerateAudienceOverlapInsightsRequest

  # 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_overlap_insights.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_audience_overlap_insights.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_audience_overlap_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_overlap_insights, request,
                                           options: options do |response, operation|
    yield response, operation if block_given?
  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::V20::Services::GenerateInsightsFinderReportResponse #generate_insights_finder_report(customer_id: nil, baseline_audience: nil, specific_audience: nil, customer_insights_group: nil, insights_application_info: nil) ⇒ ::Google::Ads::GoogleAds::V20::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/v20/services"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V20::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::V20::Services::GenerateInsightsFinderReportResponse.
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.



250
251
252
253
254
255
256
257
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
290
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 250

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::V20::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, 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_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?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#generate_suggested_targeting_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateSuggestedTargetingInsightsResponse #generate_suggested_targeting_insights(customer_id: nil, customer_insights_group: nil, insights_application_info: nil, audience_definition: nil, audience_description: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateSuggestedTargetingInsightsResponse

Returns a collection of targeting insights (e.g. targetable audiences) that are relevant to the requested audience.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v20/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V20::Services::GenerateSuggestedTargetingInsightsResponse.
p result

Overloads:

  • #generate_suggested_targeting_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateSuggestedTargetingInsightsResponse

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

    Parameters:

  • #generate_suggested_targeting_insights(customer_id: nil, customer_insights_group: nil, insights_application_info: nil, audience_definition: nil, audience_description: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateSuggestedTargetingInsightsResponse

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

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

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

    • insights_application_info (::Google::Ads::GoogleAds::V20::Common::AdditionalApplicationInfo, ::Hash) (defaults to: nil) —

      Optional. Additional information on the application issuing the request.

    • audience_definition (::Google::Ads::GoogleAds::V20::Services::InsightsAudienceDefinition, ::Hash) (defaults to: nil) —

      Provide a seed audience to get suggestions for.

      Note: The following parameters are mutually exclusive: ‘audience_definition`, `audience_description`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • audience_description (::Google::Ads::GoogleAds::V20::Services::InsightsAudienceDescription, ::Hash) (defaults to: nil) —

      Provide a text description of an audience to get AI-generated targeting suggestions. This can take around 5 or more seconds to complete.

      Note: The following parameters are mutually exclusive: ‘audience_description`, `audience_definition`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 692

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V20::Services::GenerateSuggestedTargetingInsightsRequest

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

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

  @audience_insights_service_stub.call_rpc :generate_suggested_targeting_insights, request,
                                           options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#generate_targeting_suggestion_metrics(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateTargetingSuggestionMetricsResponse #generate_targeting_suggestion_metrics(customer_id: nil, audiences: nil, customer_insights_group: nil, insights_application_info: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::GenerateTargetingSuggestionMetricsResponse

Returns potential reach metrics for targetable audiences.

This method helps answer questions like “How many Men aged 18+ interested in Camping can be reached on YouTube?”

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v20/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V20::Services::GenerateTargetingSuggestionMetricsResponse.
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.



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 913

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V20::Services::GenerateTargetingSuggestionMetricsRequest

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

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

  @audience_insights_service_stub.call_rpc :generate_targeting_suggestion_metrics, request,
                                           options: options do |response, operation|
    yield response, operation if block_given?
  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::V20::Services::ListAudienceInsightsAttributesResponse #list_audience_insights_attributes(customer_id: nil, dimensions: nil, query_text: nil, customer_insights_group: nil, insights_application_info: nil, location_country_filters: nil, youtube_reach_location: nil) ⇒ ::Google::Ads::GoogleAds::V20::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/v20/services"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V20::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::V20::Services::ListAudienceInsightsAttributesResponse.
p result

Overloads:

  • #list_audience_insights_attributes(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::ListAudienceInsightsAttributesResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V20::Services::ListAudienceInsightsAttributesRequest, ::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_audience_insights_attributes(customer_id: nil, dimensions: nil, query_text: nil, customer_insights_group: nil, insights_application_info: nil, location_country_filters: nil, youtube_reach_location: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::ListAudienceInsightsAttributesResponse

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

    • dimensions (::Array<::Google::Ads::GoogleAds::V20::Enums::AudienceInsightsDimensionEnum::AudienceInsightsDimension>) (defaults to: nil) —

      Required. The types of attributes to be returned. Supported dimensions are CATEGORY, KNOWLEDGE_GRAPH, DEVICE, GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_LINEUP, AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS, INCOME_RANGE, AGE_RANGE, and GENDER.

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

      Required. A free text query. If the requested dimensions include Attributes CATEGORY or KNOWLEDGE_GRAPH, then the attributes returned for those dimensions will match or be related to this string. For other dimensions, this field is ignored and all available attributes are returned.

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

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

    • insights_application_info (::Google::Ads::GoogleAds::V20::Common::AdditionalApplicationInfo, ::Hash) (defaults to: nil) —

      Optional. Additional information on the application issuing the request.

    • location_country_filters (::Array<::Google::Ads::GoogleAds::V20::Common::LocationInfo, ::Hash>) (defaults to: nil) —

      If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and this field is present, then the SUB_COUNTRY_LOCATION attributes returned will be located in these countries. If this field is absent, then location attributes are not filtered by country. Setting this field when SUB_COUNTRY_LOCATION attributes are not requested will return an error.

    • youtube_reach_location (::Google::Ads::GoogleAds::V20::Common::LocationInfo, ::Hash) (defaults to: nil) —

      If present, potential YouTube reach estimates within the specified market will be returned for attributes for which they are available. Reach is only available for the AGE_RANGE, GENDER, AFFINITY_USER_INTEREST and IN_MARKET_USER_INTEREST dimensions, and may not be available for every attribute of those dimensions in every market.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 374

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::V20::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, 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.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?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#list_insights_eligible_dates(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::ListInsightsEligibleDatesResponse #list_insights_eligible_dates(insights_application_info: nil) ⇒ ::Google::Ads::GoogleAds::V20::Services::ListInsightsEligibleDatesResponse

Lists date ranges for which audience insights data can be requested.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v20/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V20::Services::ListInsightsEligibleDatesResponse.
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.



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
498
499
500
501
502
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 470

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V20::Services::ListInsightsEligibleDatesRequest

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

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

  @audience_insights_service_stub.call_rpc :list_insights_eligible_dates, request,
                                           options: options do |response, operation|
    yield response, operation if block_given?
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


179
180
181
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 179

def logger
  @audience_insights_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


103
104
105
 
# File 'lib/google/ads/google_ads/v20/services/audience_insights_service/client.rb', line 103

def universe_domain
  @audience_insights_service_stub.universe_domain
end