Class: Google::Ads::GoogleAds::V17::Services::AudienceInsightsService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V17::Services::AudienceInsightsService::Client
- Defined in:
- lib/google/ads/google_ads/v17/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
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the AudienceInsightsService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the AudienceInsightsService Client instance.
-
#generate_audience_composition_insights(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V17::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.
-
#generate_audience_overlap_insights(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V17::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.
-
#generate_insights_finder_report(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V17::Services::GenerateInsightsFinderReportResponse
Creates a saved report that can be viewed in the Insights Finder tool.
-
#generate_suggested_targeting_insights(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V17::Services::GenerateSuggestedTargetingInsightsResponse
Returns a collection of targeting insights (e.g. targetable audiences) that are relevant to the requested audience.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new AudienceInsightsService client object.
-
#list_audience_insights_attributes(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V17::Services::ListAudienceInsightsAttributesResponse
Searches for audience attributes that can be used to generate insights.
-
#list_insights_eligible_dates(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::ListInsightsEligibleDatesResponse
Lists date ranges for which audience insights data can be requested.
-
#universe_domain ⇒ String
The effective universe domain.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new AudienceInsightsService client object.
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 |
# File 'lib/google/ads/google_ads/v17/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/v17/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::V17::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 ) end |
Instance Attribute Details
#audience_insights_service_stub ⇒ Object (readonly)
43 44 45 |
# File 'lib/google/ads/google_ads/v17/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.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/google/ads/google_ads/v17/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.
93 94 95 96 |
# File 'lib/google/ads/google_ads/v17/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::V17::Services::GenerateAudienceCompositionInsightsResponse #generate_audience_composition_insights(customer_id: nil, audience: nil, baseline_audience: nil, data_month: nil, dimensions: nil, customer_insights_group: nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 |
# File 'lib/google/ads/google_ads/v17/services/audience_insights_service/client.rb', line 545 def generate_audience_composition_insights request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::GenerateAudienceCompositionInsightsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.generate_audience_composition_insights..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.generate_audience_composition_insights.timeout, metadata: , retry_policy: @config.rpcs.generate_audience_composition_insights.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @audience_insights_service_stub.call_rpc :generate_audience_composition_insights, request, options: do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |
#generate_audience_overlap_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::GenerateAudienceOverlapInsightsResponse #generate_audience_overlap_insights(customer_id: nil, country_location: nil, primary_attribute: nil, dimensions: nil, customer_insights_group: nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 |
# File 'lib/google/ads/google_ads/v17/services/audience_insights_service/client.rb', line 771 def generate_audience_overlap_insights request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::GenerateAudienceOverlapInsightsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.generate_audience_overlap_insights..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.generate_audience_overlap_insights.timeout, metadata: , retry_policy: @config.rpcs.generate_audience_overlap_insights.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @audience_insights_service_stub.call_rpc :generate_audience_overlap_insights, request, options: do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |
#generate_insights_finder_report(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::GenerateInsightsFinderReportResponse #generate_insights_finder_report(customer_id: nil, baseline_audience: nil, specific_audience: nil, customer_insights_group: nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/google/ads/google_ads/v17/services/audience_insights_service/client.rb', line 228 def generate_insights_finder_report request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::GenerateInsightsFinderReportRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.generate_insights_finder_report..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.generate_insights_finder_report.timeout, metadata: , retry_policy: @config.rpcs.generate_insights_finder_report.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @audience_insights_service_stub.call_rpc :generate_insights_finder_report, request, options: do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |
#generate_suggested_targeting_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::GenerateSuggestedTargetingInsightsResponse #generate_suggested_targeting_insights(customer_id: nil, audience: nil, baseline_audience: nil, data_month: nil, customer_insights_group: nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 |
# File 'lib/google/ads/google_ads/v17/services/audience_insights_service/client.rb', line 657 def generate_suggested_targeting_insights request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::GenerateSuggestedTargetingInsightsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.generate_suggested_targeting_insights..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.generate_suggested_targeting_insights.timeout, metadata: , retry_policy: @config.rpcs.generate_suggested_targeting_insights.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @audience_insights_service_stub.call_rpc :generate_suggested_targeting_insights, request, options: do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |
#list_audience_insights_attributes(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::ListAudienceInsightsAttributesResponse #list_audience_insights_attributes(customer_id: nil, dimensions: nil, query_text: nil, customer_insights_group: nil, location_country_filters: nil, youtube_reach_location: nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()
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 382 383 384 385 386 387 388 389 390 |
# File 'lib/google/ads/google_ads/v17/services/audience_insights_service/client.rb', line 348 def list_audience_insights_attributes request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::ListAudienceInsightsAttributesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_audience_insights_attributes..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_audience_insights_attributes.timeout, metadata: , retry_policy: @config.rpcs.list_audience_insights_attributes.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @audience_insights_service_stub.call_rpc :list_audience_insights_attributes, request, options: do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |
#list_insights_eligible_dates(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()
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 463 464 465 466 467 468 469 470 471 472 |
# File 'lib/google/ads/google_ads/v17/services/audience_insights_service/client.rb', line 438 def list_insights_eligible_dates request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V17::Services::ListInsightsEligibleDatesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_insights_eligible_dates..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_insights_eligible_dates.timeout, metadata: , retry_policy: @config.rpcs.list_insights_eligible_dates.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @audience_insights_service_stub.call_rpc :list_insights_eligible_dates, request, options: do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |
#universe_domain ⇒ String
The effective universe domain
103 104 105 |
# File 'lib/google/ads/google_ads/v17/services/audience_insights_service/client.rb', line 103 def universe_domain @audience_insights_service_stub.universe_domain end |