google-ads-googleads 18.0.0 → 18.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/ChangeLog +3 -0
- data/THIRD-PARTY-LICENCES.txt +1689 -0
- data/lib/google/ads/google_ads/factories/v11/enums.rb +24 -0
- data/lib/google/ads/google_ads/factories/v11/resources.rb +247 -0
- data/lib/google/ads/google_ads/factories/v11/services.rb +3 -1
- data/lib/google/ads/google_ads/v11/common/offline_user_data_pb.rb +14 -0
- data/lib/google/ads/google_ads/v11/common/segments_pb.rb +1 -0
- data/lib/google/ads/google_ads/v11/common/user_lists_pb.rb +13 -0
- data/lib/google/ads/google_ads/v11/enums/audience_insights_dimension_pb.rb +10 -0
- data/lib/google/ads/google_ads/v11/enums/bidding_strategy_system_status_pb.rb +53 -0
- data/lib/google/ads/google_ads/v11/enums/lead_form_field_user_input_type_pb.rb +49 -0
- data/lib/google/ads/google_ads/v11/enums/recommendation_type_pb.rb +2 -0
- data/lib/google/ads/google_ads/v11/enums/user_list_flexible_rule_operator_pb.rb +30 -0
- data/lib/google/ads/google_ads/v11/errors/asset_link_error_pb.rb +1 -0
- data/lib/google/ads/google_ads/v11/errors/audience_insights_error_pb.rb +29 -0
- data/lib/google/ads/google_ads/v11/errors/errors_pb.rb +2 -0
- data/lib/google/ads/google_ads/v11/errors/offline_user_data_job_error_pb.rb +4 -0
- data/lib/google/ads/google_ads/v11/resources/asset_group_pb.rb +2 -0
- data/lib/google/ads/google_ads/v11/resources/campaign_pb.rb +2 -0
- data/lib/google/ads/google_ads/v11/resources/recommendation_pb.rb +8 -0
- data/lib/google/ads/google_ads/v11/services/account_budget_proposal_service/client.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/account_budget_proposal_service.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/account_budget_proposal_service_services_pb.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/account_link_service/client.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/account_link_service_services_pb.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/audience_insights_service/client.rb +117 -0
- data/lib/google/ads/google_ads/v11/services/audience_insights_service_pb.rb +74 -0
- data/lib/google/ads/google_ads/v11/services/audience_insights_service_services_pb.rb +15 -0
- data/lib/google/ads/google_ads/v11/services/batch_job_service/operations.rb +3 -0
- data/lib/google/ads/google_ads/v11/services/batch_job_service/paths.rb +2 -1
- data/lib/google/ads/google_ads/v11/services/campaign_draft_service/operations.rb +3 -0
- data/lib/google/ads/google_ads/v11/services/campaign_experiment_service/operations.rb +3 -0
- data/lib/google/ads/google_ads/v11/services/customer_manager_link_service/client.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/customer_manager_link_service_services_pb.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/experiment_service/operations.rb +3 -0
- data/lib/google/ads/google_ads/v11/services/feed_item_target_service/paths.rb +2 -1
- data/lib/google/ads/google_ads/v11/services/google_ads_service/client.rb +2 -2
- data/lib/google/ads/google_ads/v11/services/google_ads_service/paths.rb +16 -8
- data/lib/google/ads/google_ads/v11/services/google_ads_service_pb.rb +2 -0
- data/lib/google/ads/google_ads/v11/services/google_ads_service_services_pb.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/keyword_plan_idea_service/client.rb +4 -4
- data/lib/google/ads/google_ads/v11/services/keyword_theme_constant_service/client.rb +1 -1
- data/lib/google/ads/google_ads/v11/services/offline_user_data_job_service/operations.rb +3 -0
- data/lib/google/ads/google_ads/v11/services/reach_plan_service/client.rb +9 -6
- data/lib/google/ads/google_ads/v11/services/reach_plan_service_pb.rb +23 -0
- data/lib/google/ads/google_ads/v11/services/user_data_service/client.rb +4 -4
- data/lib/google/ads/google_ads/v11/services/user_data_service.rb +4 -4
- data/lib/google/ads/google_ads/v11/services/user_data_service_services_pb.rb +4 -4
- data/lib/google/ads/google_ads/version.rb +1 -1
- metadata +9 -5
@@ -44,6 +44,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
44
44
|
value :LAST_PURCHASE_TIME_LESS_THAN_ACQUISITION_TIME, 38
|
45
45
|
value :CUSTOMER_IDENTIFIER_NOT_ALLOWED, 39
|
46
46
|
value :INVALID_ITEM_ID, 40
|
47
|
+
value :FIRST_PURCHASE_TIME_GREATER_THAN_LAST_PURCHASE_TIME, 42
|
48
|
+
value :INVALID_LIFECYCLE_STAGE, 43
|
49
|
+
value :INVALID_EVENT_VALUE, 44
|
50
|
+
value :EVENT_ATTRIBUTE_ALL_FIELDS_ARE_REQUIRED, 45
|
47
51
|
end
|
48
52
|
end
|
49
53
|
end
|
@@ -3,6 +3,7 @@
|
|
3
3
|
|
4
4
|
require 'google/protobuf'
|
5
5
|
|
6
|
+
require 'google/ads/google_ads/v11/enums/ad_strength_pb'
|
6
7
|
require 'google/ads/google_ads/v11/enums/asset_group_status_pb'
|
7
8
|
require 'google/api/field_behavior_pb'
|
8
9
|
require 'google/api/resource_pb'
|
@@ -19,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
19
20
|
optional :status, :enum, 6, "google.ads.googleads.v11.enums.AssetGroupStatusEnum.AssetGroupStatus"
|
20
21
|
optional :path1, :string, 7
|
21
22
|
optional :path2, :string, 8
|
23
|
+
optional :ad_strength, :enum, 10, "google.ads.googleads.v11.enums.AdStrengthEnum.AdStrength"
|
22
24
|
end
|
23
25
|
end
|
24
26
|
end
|
@@ -14,6 +14,7 @@ require 'google/ads/google_ads/v11/enums/advertising_channel_type_pb'
|
|
14
14
|
require 'google/ads/google_ads/v11/enums/app_campaign_app_store_pb'
|
15
15
|
require 'google/ads/google_ads/v11/enums/app_campaign_bidding_strategy_goal_type_pb'
|
16
16
|
require 'google/ads/google_ads/v11/enums/asset_field_type_pb'
|
17
|
+
require 'google/ads/google_ads/v11/enums/bidding_strategy_system_status_pb'
|
17
18
|
require 'google/ads/google_ads/v11/enums/bidding_strategy_type_pb'
|
18
19
|
require 'google/ads/google_ads/v11/enums/brand_safety_suitability_pb'
|
19
20
|
require 'google/ads/google_ads/v11/enums/campaign_experiment_type_pb'
|
@@ -38,6 +39,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
38
39
|
proto3_optional :name, :string, 58
|
39
40
|
optional :status, :enum, 5, "google.ads.googleads.v11.enums.CampaignStatusEnum.CampaignStatus"
|
40
41
|
optional :serving_status, :enum, 21, "google.ads.googleads.v11.enums.CampaignServingStatusEnum.CampaignServingStatus"
|
42
|
+
optional :bidding_strategy_system_status, :enum, 78, "google.ads.googleads.v11.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus"
|
41
43
|
optional :ad_serving_optimization_status, :enum, 8, "google.ads.googleads.v11.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus"
|
42
44
|
optional :advertising_channel_type, :enum, 9, "google.ads.googleads.v11.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType"
|
43
45
|
optional :advertising_channel_sub_type, :enum, 10, "google.ads.googleads.v11.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType"
|
@@ -45,6 +45,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
45
45
|
optional :responsive_search_ad_asset_recommendation, :message, 31, "google.ads.googleads.v11.resources.Recommendation.ResponsiveSearchAdAssetRecommendation"
|
46
46
|
optional :upgrade_smart_shopping_campaign_to_performance_max_recommendation, :message, 32, "google.ads.googleads.v11.resources.Recommendation.UpgradeSmartShoppingCampaignToPerformanceMaxRecommendation"
|
47
47
|
optional :responsive_search_ad_improve_ad_strength_recommendation, :message, 33, "google.ads.googleads.v11.resources.Recommendation.ResponsiveSearchAdImproveAdStrengthRecommendation"
|
48
|
+
optional :display_expansion_opt_in_recommendation, :message, 34, "google.ads.googleads.v11.resources.Recommendation.DisplayExpansionOptInRecommendation"
|
49
|
+
optional :upgrade_local_campaign_to_performance_max_recommendation, :message, 35, "google.ads.googleads.v11.resources.Recommendation.UpgradeLocalCampaignToPerformanceMaxRecommendation"
|
48
50
|
end
|
49
51
|
end
|
50
52
|
add_message "google.ads.googleads.v11.resources.Recommendation.RecommendationImpact" do
|
@@ -141,6 +143,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
141
143
|
optional :merchant_id, :int64, 1
|
142
144
|
optional :sales_country_code, :string, 2
|
143
145
|
end
|
146
|
+
add_message "google.ads.googleads.v11.resources.Recommendation.DisplayExpansionOptInRecommendation" do
|
147
|
+
end
|
148
|
+
add_message "google.ads.googleads.v11.resources.Recommendation.UpgradeLocalCampaignToPerformanceMaxRecommendation" do
|
149
|
+
end
|
144
150
|
end
|
145
151
|
end
|
146
152
|
|
@@ -174,6 +180,8 @@ module Google
|
|
174
180
|
Recommendation::ResponsiveSearchAdRecommendation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.resources.Recommendation.ResponsiveSearchAdRecommendation").msgclass
|
175
181
|
Recommendation::UseBroadMatchKeywordRecommendation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.resources.Recommendation.UseBroadMatchKeywordRecommendation").msgclass
|
176
182
|
Recommendation::UpgradeSmartShoppingCampaignToPerformanceMaxRecommendation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.resources.Recommendation.UpgradeSmartShoppingCampaignToPerformanceMaxRecommendation").msgclass
|
183
|
+
Recommendation::DisplayExpansionOptInRecommendation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.resources.Recommendation.DisplayExpansionOptInRecommendation").msgclass
|
184
|
+
Recommendation::UpgradeLocalCampaignToPerformanceMaxRecommendation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.resources.Recommendation.UpgradeLocalCampaignToPerformanceMaxRecommendation").msgclass
|
177
185
|
end
|
178
186
|
end
|
179
187
|
end
|
@@ -28,7 +28,7 @@ module Google
|
|
28
28
|
##
|
29
29
|
# Client for the AccountBudgetProposalService service.
|
30
30
|
#
|
31
|
-
# A service for managing account-level budgets
|
31
|
+
# A service for managing account-level budgets through proposals.
|
32
32
|
#
|
33
33
|
# A proposal is a request to create a new budget or make changes to an
|
34
34
|
# existing one.
|
@@ -32,7 +32,7 @@ module Google
|
|
32
32
|
module V11
|
33
33
|
module Services
|
34
34
|
##
|
35
|
-
# A service for managing account-level budgets
|
35
|
+
# A service for managing account-level budgets through proposals.
|
36
36
|
#
|
37
37
|
# A proposal is a request to create a new budget or make changes to an
|
38
38
|
# existing one.
|
@@ -27,7 +27,7 @@ module Google
|
|
27
27
|
module AccountBudgetProposalService
|
28
28
|
# Proto file describing the AccountBudgetProposal service.
|
29
29
|
#
|
30
|
-
# A service for managing account-level budgets
|
30
|
+
# A service for managing account-level budgets through proposals.
|
31
31
|
#
|
32
32
|
# A proposal is a request to create a new budget or make changes to an
|
33
33
|
# existing one.
|
@@ -248,7 +248,7 @@ module Google
|
|
248
248
|
##
|
249
249
|
# Creates or removes an account link.
|
250
250
|
# From V5, create is not supported through
|
251
|
-
# AccountLinkService.MutateAccountLink.
|
251
|
+
# AccountLinkService.MutateAccountLink. Use
|
252
252
|
# AccountLinkService.CreateAccountLink instead.
|
253
253
|
#
|
254
254
|
# List of thrown errors:
|
@@ -51,7 +51,7 @@ module Google
|
|
51
51
|
rpc :CreateAccountLink, ::Google::Ads::GoogleAds::V11::Services::CreateAccountLinkRequest, ::Google::Ads::GoogleAds::V11::Services::CreateAccountLinkResponse
|
52
52
|
# Creates or removes an account link.
|
53
53
|
# From V5, create is not supported through
|
54
|
-
# AccountLinkService.MutateAccountLink.
|
54
|
+
# AccountLinkService.MutateAccountLink. Use
|
55
55
|
# AccountLinkService.CreateAccountLink instead.
|
56
56
|
#
|
57
57
|
# List of thrown errors:
|
@@ -351,6 +351,116 @@ module Google
|
|
351
351
|
# raise Google::Ads::GoogleAds::Error.new grpc_error.message
|
352
352
|
end
|
353
353
|
|
354
|
+
##
|
355
|
+
# Returns a collection of attributes that are represented in an audience of
|
356
|
+
# interest, with metrics that compare each attribute's share of the audience
|
357
|
+
# with its share of a baseline audience.
|
358
|
+
#
|
359
|
+
# List of thrown errors:
|
360
|
+
# [AudienceInsightsError]()
|
361
|
+
# [AuthenticationError]()
|
362
|
+
# [AuthorizationError]()
|
363
|
+
# [FieldError]()
|
364
|
+
# [HeaderError]()
|
365
|
+
# [InternalError]()
|
366
|
+
# [QuotaError]()
|
367
|
+
# [RangeError]()
|
368
|
+
# [RequestError]()
|
369
|
+
#
|
370
|
+
# @overload generate_audience_composition_insights(request, options = nil)
|
371
|
+
# Pass arguments to `generate_audience_composition_insights` via a request object, either of type
|
372
|
+
# {::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsRequest} or an equivalent Hash.
|
373
|
+
#
|
374
|
+
# @param request [::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsRequest, ::Hash]
|
375
|
+
# A request object representing the call parameters. Required. To specify no
|
376
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
377
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
378
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
379
|
+
#
|
380
|
+
# @overload generate_audience_composition_insights(customer_id: nil, audience: nil, data_month: nil, dimensions: nil, customer_insights_group: nil)
|
381
|
+
# Pass arguments to `generate_audience_composition_insights` via keyword arguments. Note that at
|
382
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
383
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
384
|
+
#
|
385
|
+
# @param customer_id [::String]
|
386
|
+
# Required. The ID of the customer.
|
387
|
+
# @param audience [::Google::Ads::GoogleAds::V11::Services::InsightsAudience, ::Hash]
|
388
|
+
# Required. The audience of interest for which insights are being requested.
|
389
|
+
# @param data_month [::String]
|
390
|
+
# The one-month range of historical data to use for insights, in the format
|
391
|
+
# "yyyy-mm". If unset, insights will be returned for the last thirty days of
|
392
|
+
# data.
|
393
|
+
# @param dimensions [::Array<::Google::Ads::GoogleAds::V11::Enums::AudienceInsightsDimensionEnum::AudienceInsightsDimension>]
|
394
|
+
# Required. The audience dimensions for which composition insights should be returned.
|
395
|
+
# @param customer_insights_group [::String]
|
396
|
+
# The name of the customer being planned for. This is a user-defined value.
|
397
|
+
#
|
398
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
399
|
+
# @yieldparam response [::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsResponse]
|
400
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
401
|
+
#
|
402
|
+
# @return [::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsResponse]
|
403
|
+
#
|
404
|
+
# @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
|
405
|
+
#
|
406
|
+
# @example Basic example
|
407
|
+
# require "google/ads/google_ads/v11/services"
|
408
|
+
#
|
409
|
+
# # Create a client object. The client can be reused for multiple calls.
|
410
|
+
# client = Google::Ads::GoogleAds::V11::Services::AudienceInsightsService::Client.new
|
411
|
+
#
|
412
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
413
|
+
# request = Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsRequest.new
|
414
|
+
#
|
415
|
+
# # Call the generate_audience_composition_insights method.
|
416
|
+
# result = client.generate_audience_composition_insights request
|
417
|
+
#
|
418
|
+
# # The returned object is of type Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsResponse.
|
419
|
+
# p result
|
420
|
+
#
|
421
|
+
def generate_audience_composition_insights request, options = nil
|
422
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
423
|
+
|
424
|
+
request = ::Gapic::Protobuf.coerce request,
|
425
|
+
to: ::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsRequest
|
426
|
+
|
427
|
+
# Converts hash and nil to an options object
|
428
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
429
|
+
|
430
|
+
# Customize the options with defaults
|
431
|
+
metadata = @config.rpcs.generate_audience_composition_insights.metadata.to_h
|
432
|
+
|
433
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
434
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
435
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
436
|
+
gapic_version: ::Google::Ads::GoogleAds::VERSION
|
437
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
438
|
+
|
439
|
+
header_params = {}
|
440
|
+
if request.customer_id
|
441
|
+
header_params["customer_id"] = request.customer_id
|
442
|
+
end
|
443
|
+
|
444
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
445
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
446
|
+
|
447
|
+
options.apply_defaults timeout: @config.rpcs.generate_audience_composition_insights.timeout,
|
448
|
+
metadata: metadata,
|
449
|
+
retry_policy: @config.rpcs.generate_audience_composition_insights.retry_policy
|
450
|
+
|
451
|
+
options.apply_defaults timeout: @config.timeout,
|
452
|
+
metadata: @config.metadata,
|
453
|
+
retry_policy: @config.retry_policy
|
454
|
+
|
455
|
+
@audience_insights_service_stub.call_rpc :generate_audience_composition_insights, request,
|
456
|
+
options: options do |response, operation|
|
457
|
+
yield response, operation if block_given?
|
458
|
+
return response
|
459
|
+
end
|
460
|
+
# rescue GRPC::BadStatus => grpc_error
|
461
|
+
# raise Google::Ads::GoogleAds::Error.new grpc_error.message
|
462
|
+
end
|
463
|
+
|
354
464
|
##
|
355
465
|
# Configuration class for the AudienceInsightsService API.
|
356
466
|
#
|
@@ -497,6 +607,11 @@ module Google
|
|
497
607
|
# @return [::Gapic::Config::Method]
|
498
608
|
#
|
499
609
|
attr_reader :list_audience_insights_attributes
|
610
|
+
##
|
611
|
+
# RPC-specific configuration for `generate_audience_composition_insights`
|
612
|
+
# @return [::Gapic::Config::Method]
|
613
|
+
#
|
614
|
+
attr_reader :generate_audience_composition_insights
|
500
615
|
|
501
616
|
# @private
|
502
617
|
def initialize parent_rpcs = nil
|
@@ -504,6 +619,8 @@ module Google
|
|
504
619
|
@generate_insights_finder_report = ::Gapic::Config::Method.new generate_insights_finder_report_config
|
505
620
|
list_audience_insights_attributes_config = parent_rpcs.list_audience_insights_attributes if parent_rpcs.respond_to? :list_audience_insights_attributes
|
506
621
|
@list_audience_insights_attributes = ::Gapic::Config::Method.new list_audience_insights_attributes_config
|
622
|
+
generate_audience_composition_insights_config = parent_rpcs.generate_audience_composition_insights if parent_rpcs.respond_to? :generate_audience_composition_insights
|
623
|
+
@generate_audience_composition_insights = ::Gapic::Config::Method.new generate_audience_composition_insights_config
|
507
624
|
|
508
625
|
yield self if block_given?
|
509
626
|
end
|
@@ -20,6 +20,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
20
20
|
add_message "google.ads.googleads.v11.services.GenerateInsightsFinderReportResponse" do
|
21
21
|
optional :saved_report_url, :string, 1
|
22
22
|
end
|
23
|
+
add_message "google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsRequest" do
|
24
|
+
optional :customer_id, :string, 1
|
25
|
+
optional :audience, :message, 2, "google.ads.googleads.v11.services.InsightsAudience"
|
26
|
+
optional :data_month, :string, 3
|
27
|
+
repeated :dimensions, :enum, 4, "google.ads.googleads.v11.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension"
|
28
|
+
optional :customer_insights_group, :string, 5
|
29
|
+
end
|
30
|
+
add_message "google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsResponse" do
|
31
|
+
repeated :sections, :message, 1, "google.ads.googleads.v11.services.AudienceCompositionSection"
|
32
|
+
end
|
23
33
|
add_message "google.ads.googleads.v11.services.ListAudienceInsightsAttributesRequest" do
|
24
34
|
optional :customer_id, :string, 1
|
25
35
|
repeated :dimensions, :enum, 2, "google.ads.googleads.v11.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension"
|
@@ -37,6 +47,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
37
47
|
optional :user_interest, :message, 4, "google.ads.googleads.v11.common.UserInterestInfo"
|
38
48
|
optional :entity, :message, 5, "google.ads.googleads.v11.services.AudienceInsightsEntity"
|
39
49
|
optional :category, :message, 6, "google.ads.googleads.v11.services.AudienceInsightsCategory"
|
50
|
+
optional :dynamic_lineup, :message, 7, "google.ads.googleads.v11.services.AudienceInsightsDynamicLineup"
|
51
|
+
optional :parental_status, :message, 8, "google.ads.googleads.v11.common.ParentalStatusInfo"
|
52
|
+
optional :income_range, :message, 9, "google.ads.googleads.v11.common.IncomeRangeInfo"
|
53
|
+
optional :youtube_channel, :message, 10, "google.ads.googleads.v11.common.YouTubeChannelInfo"
|
40
54
|
end
|
41
55
|
end
|
42
56
|
add_message "google.ads.googleads.v11.services.AudienceInsightsTopic" do
|
@@ -51,6 +65,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
51
65
|
add_message "google.ads.googleads.v11.services.AudienceInsightsCategory" do
|
52
66
|
optional :category_id, :string, 1
|
53
67
|
end
|
68
|
+
add_message "google.ads.googleads.v11.services.AudienceInsightsDynamicLineup" do
|
69
|
+
optional :dynamic_lineup_id, :string, 1
|
70
|
+
end
|
54
71
|
add_message "google.ads.googleads.v11.services.BasicInsightsAudience" do
|
55
72
|
repeated :country_location, :message, 1, "google.ads.googleads.v11.common.LocationInfo"
|
56
73
|
repeated :sub_country_locations, :message, 2, "google.ads.googleads.v11.common.LocationInfo"
|
@@ -65,6 +82,52 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
65
82
|
optional :display_name, :string, 3
|
66
83
|
optional :score, :double, 4
|
67
84
|
optional :display_info, :string, 5
|
85
|
+
oneof :dimension_metadata do
|
86
|
+
optional :youtube_channel_metadata, :message, 6, "google.ads.googleads.v11.services.YouTubeChannelAttributeMetadata"
|
87
|
+
optional :dynamic_attribute_metadata, :message, 7, "google.ads.googleads.v11.services.DynamicLineupAttributeMetadata"
|
88
|
+
end
|
89
|
+
end
|
90
|
+
add_message "google.ads.googleads.v11.services.YouTubeChannelAttributeMetadata" do
|
91
|
+
optional :subscriber_count, :int64, 1
|
92
|
+
end
|
93
|
+
add_message "google.ads.googleads.v11.services.DynamicLineupAttributeMetadata" do
|
94
|
+
optional :inventory_country, :message, 1, "google.ads.googleads.v11.common.LocationInfo"
|
95
|
+
proto3_optional :median_monthly_inventory, :int64, 2
|
96
|
+
proto3_optional :channel_count_lower_bound, :int64, 3
|
97
|
+
proto3_optional :channel_count_upper_bound, :int64, 4
|
98
|
+
end
|
99
|
+
add_message "google.ads.googleads.v11.services.InsightsAudience" do
|
100
|
+
repeated :country_locations, :message, 1, "google.ads.googleads.v11.common.LocationInfo"
|
101
|
+
repeated :sub_country_locations, :message, 2, "google.ads.googleads.v11.common.LocationInfo"
|
102
|
+
optional :gender, :message, 3, "google.ads.googleads.v11.common.GenderInfo"
|
103
|
+
repeated :age_ranges, :message, 4, "google.ads.googleads.v11.common.AgeRangeInfo"
|
104
|
+
optional :parental_status, :message, 5, "google.ads.googleads.v11.common.ParentalStatusInfo"
|
105
|
+
repeated :income_ranges, :message, 6, "google.ads.googleads.v11.common.IncomeRangeInfo"
|
106
|
+
repeated :dynamic_lineups, :message, 7, "google.ads.googleads.v11.services.AudienceInsightsDynamicLineup"
|
107
|
+
repeated :topic_audience_combinations, :message, 8, "google.ads.googleads.v11.services.InsightsAudienceAttributeGroup"
|
108
|
+
end
|
109
|
+
add_message "google.ads.googleads.v11.services.InsightsAudienceAttributeGroup" do
|
110
|
+
repeated :attributes, :message, 1, "google.ads.googleads.v11.services.AudienceInsightsAttribute"
|
111
|
+
end
|
112
|
+
add_message "google.ads.googleads.v11.services.AudienceCompositionSection" do
|
113
|
+
optional :dimension, :enum, 1, "google.ads.googleads.v11.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension"
|
114
|
+
repeated :top_attributes, :message, 3, "google.ads.googleads.v11.services.AudienceCompositionAttribute"
|
115
|
+
repeated :clustered_attributes, :message, 4, "google.ads.googleads.v11.services.AudienceCompositionAttributeCluster"
|
116
|
+
end
|
117
|
+
add_message "google.ads.googleads.v11.services.AudienceCompositionAttributeCluster" do
|
118
|
+
optional :cluster_display_name, :string, 1
|
119
|
+
optional :cluster_metrics, :message, 3, "google.ads.googleads.v11.services.AudienceCompositionMetrics"
|
120
|
+
repeated :attributes, :message, 4, "google.ads.googleads.v11.services.AudienceCompositionAttribute"
|
121
|
+
end
|
122
|
+
add_message "google.ads.googleads.v11.services.AudienceCompositionMetrics" do
|
123
|
+
optional :baseline_audience_share, :double, 1
|
124
|
+
optional :audience_share, :double, 2
|
125
|
+
optional :index, :double, 3
|
126
|
+
optional :score, :double, 4
|
127
|
+
end
|
128
|
+
add_message "google.ads.googleads.v11.services.AudienceCompositionAttribute" do
|
129
|
+
optional :attribute_metadata, :message, 1, "google.ads.googleads.v11.services.AudienceInsightsAttributeMetadata"
|
130
|
+
optional :metrics, :message, 2, "google.ads.googleads.v11.services.AudienceCompositionMetrics"
|
68
131
|
end
|
69
132
|
end
|
70
133
|
end
|
@@ -76,14 +139,25 @@ module Google
|
|
76
139
|
module Services
|
77
140
|
GenerateInsightsFinderReportRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.GenerateInsightsFinderReportRequest").msgclass
|
78
141
|
GenerateInsightsFinderReportResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.GenerateInsightsFinderReportResponse").msgclass
|
142
|
+
GenerateAudienceCompositionInsightsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsRequest").msgclass
|
143
|
+
GenerateAudienceCompositionInsightsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsResponse").msgclass
|
79
144
|
ListAudienceInsightsAttributesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.ListAudienceInsightsAttributesRequest").msgclass
|
80
145
|
ListAudienceInsightsAttributesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.ListAudienceInsightsAttributesResponse").msgclass
|
81
146
|
AudienceInsightsAttribute = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceInsightsAttribute").msgclass
|
82
147
|
AudienceInsightsTopic = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceInsightsTopic").msgclass
|
83
148
|
AudienceInsightsEntity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceInsightsEntity").msgclass
|
84
149
|
AudienceInsightsCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceInsightsCategory").msgclass
|
150
|
+
AudienceInsightsDynamicLineup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceInsightsDynamicLineup").msgclass
|
85
151
|
BasicInsightsAudience = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.BasicInsightsAudience").msgclass
|
86
152
|
AudienceInsightsAttributeMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceInsightsAttributeMetadata").msgclass
|
153
|
+
YouTubeChannelAttributeMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.YouTubeChannelAttributeMetadata").msgclass
|
154
|
+
DynamicLineupAttributeMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.DynamicLineupAttributeMetadata").msgclass
|
155
|
+
InsightsAudience = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.InsightsAudience").msgclass
|
156
|
+
InsightsAudienceAttributeGroup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.InsightsAudienceAttributeGroup").msgclass
|
157
|
+
AudienceCompositionSection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceCompositionSection").msgclass
|
158
|
+
AudienceCompositionAttributeCluster = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceCompositionAttributeCluster").msgclass
|
159
|
+
AudienceCompositionMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceCompositionMetrics").msgclass
|
160
|
+
AudienceCompositionAttribute = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v11.services.AudienceCompositionAttribute").msgclass
|
87
161
|
end
|
88
162
|
end
|
89
163
|
end
|
@@ -61,6 +61,21 @@ module Google
|
|
61
61
|
# [RangeError]()
|
62
62
|
# [RequestError]()
|
63
63
|
rpc :ListAudienceInsightsAttributes, ::Google::Ads::GoogleAds::V11::Services::ListAudienceInsightsAttributesRequest, ::Google::Ads::GoogleAds::V11::Services::ListAudienceInsightsAttributesResponse
|
64
|
+
# Returns a collection of attributes that are represented in an audience of
|
65
|
+
# interest, with metrics that compare each attribute's share of the audience
|
66
|
+
# with its share of a baseline audience.
|
67
|
+
#
|
68
|
+
# List of thrown errors:
|
69
|
+
# [AudienceInsightsError]()
|
70
|
+
# [AuthenticationError]()
|
71
|
+
# [AuthorizationError]()
|
72
|
+
# [FieldError]()
|
73
|
+
# [HeaderError]()
|
74
|
+
# [InternalError]()
|
75
|
+
# [QuotaError]()
|
76
|
+
# [RangeError]()
|
77
|
+
# [RequestError]()
|
78
|
+
rpc :GenerateAudienceCompositionInsights, ::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsRequest, ::Google::Ads::GoogleAds::V11::Services::GenerateAudienceCompositionInsightsResponse
|
64
79
|
end
|
65
80
|
|
66
81
|
Stub = Service.rpc_stub_class
|
@@ -1208,7 +1208,8 @@ module Google
|
|
1208
1208
|
# @param feed_item_target_id [String]
|
1209
1209
|
#
|
1210
1210
|
# @return [::String]
|
1211
|
-
def feed_item_target_path customer_id:, feed_id:, feed_item_id:, feed_item_target_type:,
|
1211
|
+
def feed_item_target_path customer_id:, feed_id:, feed_item_id:, feed_item_target_type:,
|
1212
|
+
feed_item_target_id:
|
1212
1213
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
1213
1214
|
raise ::ArgumentError, "feed_id cannot contain /" if feed_id.to_s.include? "/"
|
1214
1215
|
raise ::ArgumentError, "feed_item_id cannot contain /" if feed_item_id.to_s.include? "/"
|
@@ -251,7 +251,7 @@ module Google
|
|
251
251
|
##
|
252
252
|
# Moves a client customer to a new manager customer.
|
253
253
|
# This simplifies the complex request that requires two operations to move
|
254
|
-
# a client customer to a new manager
|
254
|
+
# a client customer to a new manager, for example:
|
255
255
|
# 1. Update operation with Status INACTIVE (previous manager) and,
|
256
256
|
# 2. Update operation with Status ACTIVE (new manager).
|
257
257
|
#
|
@@ -51,7 +51,7 @@ module Google
|
|
51
51
|
rpc :MutateCustomerManagerLink, ::Google::Ads::GoogleAds::V11::Services::MutateCustomerManagerLinkRequest, ::Google::Ads::GoogleAds::V11::Services::MutateCustomerManagerLinkResponse
|
52
52
|
# Moves a client customer to a new manager customer.
|
53
53
|
# This simplifies the complex request that requires two operations to move
|
54
|
-
# a client customer to a new manager
|
54
|
+
# a client customer to a new manager, for example:
|
55
55
|
# 1. Update operation with Status INACTIVE (previous manager) and,
|
56
56
|
# 2. Update operation with Status ACTIVE (new manager).
|
57
57
|
#
|
@@ -92,7 +92,8 @@ module Google
|
|
92
92
|
# @param feed_item_target_id [String]
|
93
93
|
#
|
94
94
|
# @return [::String]
|
95
|
-
def feed_item_target_path customer_id:, feed_id:, feed_item_id:, feed_item_target_type:,
|
95
|
+
def feed_item_target_path customer_id:, feed_id:, feed_item_id:, feed_item_target_type:,
|
96
|
+
feed_item_target_id:
|
96
97
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
97
98
|
raise ::ArgumentError, "feed_id cannot contain /" if feed_id.to_s.include? "/"
|
98
99
|
raise ::ArgumentError, "feed_item_id cannot contain /" if feed_item_id.to_s.include? "/"
|
@@ -397,7 +397,7 @@ module Google
|
|
397
397
|
#
|
398
398
|
# Atomicity makes error handling much easier. If you're making a series of
|
399
399
|
# changes and one fails, it can leave your account in an inconsistent state.
|
400
|
-
# With atomicity, you either reach the
|
400
|
+
# With atomicity, you either reach the chosen state directly, or the request
|
401
401
|
# fails and you can retry.
|
402
402
|
#
|
403
403
|
# ## Temp Resource Names
|
@@ -522,7 +522,7 @@ module Google
|
|
522
522
|
# The response content type setting. Determines whether the mutable resource
|
523
523
|
# or just the resource name should be returned post mutation. The mutable
|
524
524
|
# resource will only be returned if the resource has the appropriate response
|
525
|
-
# field.
|
525
|
+
# field. For example, MutateCampaignResult.campaign.
|
526
526
|
#
|
527
527
|
# @yield [response, operation] Access the result along with the RPC operation
|
528
528
|
# @yieldparam response [::Google::Ads::GoogleAds::V11::Services::MutateGoogleAdsResponse]
|
@@ -160,7 +160,8 @@ module Google
|
|
160
160
|
# @param asset_combination_id_high [String]
|
161
161
|
#
|
162
162
|
# @return [::String]
|
163
|
-
def ad_group_ad_asset_combination_view_path customer_id:, ad_group_id:, ad_id:,
|
163
|
+
def ad_group_ad_asset_combination_view_path customer_id:, ad_group_id:, ad_id:,
|
164
|
+
asset_combination_id_low:, asset_combination_id_high:
|
164
165
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
165
166
|
raise ::ArgumentError, "ad_group_id cannot contain /" if ad_group_id.to_s.include? "/"
|
166
167
|
raise ::ArgumentError, "ad_id cannot contain /" if ad_id.to_s.include? "/"
|
@@ -350,7 +351,8 @@ module Google
|
|
350
351
|
# @param end_date [String]
|
351
352
|
#
|
352
353
|
# @return [::String]
|
353
|
-
def ad_group_criterion_simulation_path customer_id:, ad_group_id:, criterion_id:, type:,
|
354
|
+
def ad_group_criterion_simulation_path customer_id:, ad_group_id:, criterion_id:, type:,
|
355
|
+
modification_method:, start_date:, end_date:
|
354
356
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
355
357
|
raise ::ArgumentError, "ad_group_id cannot contain /" if ad_group_id.to_s.include? "/"
|
356
358
|
raise ::ArgumentError, "criterion_id cannot contain /" if criterion_id.to_s.include? "/"
|
@@ -452,7 +454,8 @@ module Google
|
|
452
454
|
# @param end_date [String]
|
453
455
|
#
|
454
456
|
# @return [::String]
|
455
|
-
def ad_group_simulation_path customer_id:, ad_group_id:, type:, modification_method:, start_date:,
|
457
|
+
def ad_group_simulation_path customer_id:, ad_group_id:, type:, modification_method:, start_date:,
|
458
|
+
end_date:
|
456
459
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
457
460
|
raise ::ArgumentError, "ad_group_id cannot contain /" if ad_group_id.to_s.include? "/"
|
458
461
|
raise ::ArgumentError, "type cannot contain /" if type.to_s.include? "/"
|
@@ -786,7 +789,8 @@ module Google
|
|
786
789
|
# @param end_date [String]
|
787
790
|
#
|
788
791
|
# @return [::String]
|
789
|
-
def bidding_strategy_simulation_path customer_id:, bidding_strategy_id:, type:, modification_method:,
|
792
|
+
def bidding_strategy_simulation_path customer_id:, bidding_strategy_id:, type:, modification_method:,
|
793
|
+
start_date:, end_date:
|
790
794
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
791
795
|
raise ::ArgumentError, "bidding_strategy_id cannot contain /" if bidding_strategy_id.to_s.include? "/"
|
792
796
|
raise ::ArgumentError, "type cannot contain /" if type.to_s.include? "/"
|
@@ -998,7 +1002,8 @@ module Google
|
|
998
1002
|
# @param end_date [String]
|
999
1003
|
#
|
1000
1004
|
# @return [::String]
|
1001
|
-
def campaign_criterion_simulation_path customer_id:, campaign_id:, criterion_id:, type:,
|
1005
|
+
def campaign_criterion_simulation_path customer_id:, campaign_id:, criterion_id:, type:,
|
1006
|
+
modification_method:, start_date:, end_date:
|
1002
1007
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
1003
1008
|
raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
|
1004
1009
|
raise ::ArgumentError, "criterion_id cannot contain /" if criterion_id.to_s.include? "/"
|
@@ -1172,7 +1177,8 @@ module Google
|
|
1172
1177
|
# @param end_date [String]
|
1173
1178
|
#
|
1174
1179
|
# @return [::String]
|
1175
|
-
def campaign_simulation_path customer_id:, campaign_id:, type:, modification_method:, start_date:,
|
1180
|
+
def campaign_simulation_path customer_id:, campaign_id:, type:, modification_method:, start_date:,
|
1181
|
+
end_date:
|
1176
1182
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
1177
1183
|
raise ::ArgumentError, "campaign_id cannot contain /" if campaign_id.to_s.include? "/"
|
1178
1184
|
raise ::ArgumentError, "type cannot contain /" if type.to_s.include? "/"
|
@@ -1773,7 +1779,8 @@ module Google
|
|
1773
1779
|
# @param page_url_fingerprint [String]
|
1774
1780
|
#
|
1775
1781
|
# @return [::String]
|
1776
|
-
def dynamic_search_ads_search_term_view_path customer_id:, ad_group_id:, search_term_fingerprint:,
|
1782
|
+
def dynamic_search_ads_search_term_view_path customer_id:, ad_group_id:, search_term_fingerprint:,
|
1783
|
+
headline_fingerprint:, landing_page_fingerprint:, page_url_fingerprint:
|
1777
1784
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
1778
1785
|
raise ::ArgumentError, "ad_group_id cannot contain /" if ad_group_id.to_s.include? "/"
|
1779
1786
|
raise ::ArgumentError,
|
@@ -1945,7 +1952,8 @@ module Google
|
|
1945
1952
|
# @param feed_item_target_id [String]
|
1946
1953
|
#
|
1947
1954
|
# @return [::String]
|
1948
|
-
def feed_item_target_path customer_id:, feed_id:, feed_item_id:, feed_item_target_type:,
|
1955
|
+
def feed_item_target_path customer_id:, feed_id:, feed_item_id:, feed_item_target_type:,
|
1956
|
+
feed_item_target_id:
|
1949
1957
|
raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
|
1950
1958
|
raise ::ArgumentError, "feed_id cannot contain /" if feed_id.to_s.include? "/"
|
1951
1959
|
raise ::ArgumentError, "feed_item_id cannot contain /" if feed_item_id.to_s.include? "/"
|
@@ -572,6 +572,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
572
572
|
optional :customer_negative_criterion_result, :message, 34, "google.ads.googleads.v11.services.MutateCustomerNegativeCriteriaResult"
|
573
573
|
optional :customer_result, :message, 35, "google.ads.googleads.v11.services.MutateCustomerResult"
|
574
574
|
optional :customizer_attribute_result, :message, 70, "google.ads.googleads.v11.services.MutateCustomizerAttributeResult"
|
575
|
+
optional :experiment_result, :message, 81, "google.ads.googleads.v11.services.MutateExperimentResult"
|
576
|
+
optional :experiment_arm_result, :message, 82, "google.ads.googleads.v11.services.MutateExperimentArmResult"
|
575
577
|
optional :extension_feed_item_result, :message, 36, "google.ads.googleads.v11.services.MutateExtensionFeedItemResult"
|
576
578
|
optional :feed_item_result, :message, 37, "google.ads.googleads.v11.services.MutateFeedItemResult"
|
577
579
|
optional :feed_item_set_result, :message, 53, "google.ads.googleads.v11.services.MutateFeedItemSetResult"
|
@@ -83,7 +83,7 @@ module Google
|
|
83
83
|
#
|
84
84
|
# Atomicity makes error handling much easier. If you're making a series of
|
85
85
|
# changes and one fails, it can leave your account in an inconsistent state.
|
86
|
-
# With atomicity, you either reach the
|
86
|
+
# With atomicity, you either reach the chosen state directly, or the request
|
87
87
|
# fails and you can retry.
|
88
88
|
#
|
89
89
|
# ## Temp Resource Names
|