Class: Google::Ads::GoogleAds::V5::Services::RecommendationService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V5::Services::RecommendationService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v5/services/recommendation_service/client.rb
Overview
Client for the RecommendationService service.
Service to manage recommendations.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService Client class.
Instance Method Summary collapse
-
#apply_recommendation(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V5::Services::ApplyRecommendationResponse
Applies given recommendations with corresponding apply parameters.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService Client instance.
-
#dismiss_recommendation(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V5::Services::DismissRecommendationResponse
Dismisses given recommendations.
-
#get_recommendation(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V5::Resources::Recommendation
Returns the requested recommendation in full detail.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new RecommendationService client object.
Methods included from Paths
#ad_group_path, #ad_path, #campaign_budget_path, #campaign_path, #recommendation_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new RecommendationService client object.
## Examples
To create a new RecommendationService client with the default configuration:
client = ::Google::Ads::GoogleAds::V5::Services::RecommendationService::Client.new
To create a new RecommendationService client with a custom configuration:
client = ::Google::Ads::GoogleAds::V5::Services::RecommendationService::Client.new do |config|
config.timeout = 10.0
end
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/google/ads/google_ads/v5/services/recommendation_service/client.rb', line 116 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/v5/services/recommendation_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 credentials ||= Credentials.default scope: @config.scope 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 @recommendation_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V5::Services::RecommendationService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#recommendation_service_stub ⇒ Object (readonly)
37 38 39 |
# File 'lib/google/ads/google_ads/v5/services/recommendation_service/client.rb', line 37 def recommendation_service_stub @recommendation_service_stub end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService Client class.
See Configuration for a description of the configuration fields.
## Example
To modify the configuration for all RecommendationService clients:
::Google::Ads::GoogleAds::V5::Services::RecommendationService::Client.configure do |config|
config.timeout = 10.0
end
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/google/ads/google_ads/v5/services/recommendation_service/client.rb', line 58 def self.configure @configure ||= begin default_config = Client::Configuration.new default_config.timeout = 3600.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
#apply_recommendation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::ApplyRecommendationResponse #apply_recommendation(customer_id: nil, operations: nil, partial_failure: nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::ApplyRecommendationResponse
Applies given recommendations with corresponding apply parameters.
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 |
# File 'lib/google/ads/google_ads/v5/services/recommendation_service/client.rb', line 253 def apply_recommendation request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::ApplyRecommendationRequest # 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.apply_recommendation..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "customer_id" => request.customer_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.apply_recommendation.timeout, metadata: , retry_policy: @config.rpcs.apply_recommendation.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @recommendation_service_stub.call_rpc :apply_recommendation, 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 |
#configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService 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.
91 92 93 94 |
# File 'lib/google/ads/google_ads/v5/services/recommendation_service/client.rb', line 91 def configure yield @config if block_given? @config end |
#dismiss_recommendation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::DismissRecommendationResponse #dismiss_recommendation(customer_id: nil, operations: nil, partial_failure: nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::DismissRecommendationResponse
Dismisses given recommendations.
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'lib/google/ads/google_ads/v5/services/recommendation_service/client.rb', line 328 def dismiss_recommendation request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::DismissRecommendationRequest # 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.dismiss_recommendation..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "customer_id" => request.customer_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.dismiss_recommendation.timeout, metadata: , retry_policy: @config.rpcs.dismiss_recommendation.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @recommendation_service_stub.call_rpc :dismiss_recommendation, 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 |
#get_recommendation(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::Recommendation #get_recommendation(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::Recommendation
Returns the requested recommendation in full detail.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/google/ads/google_ads/v5/services/recommendation_service/client.rb', line 178 def get_recommendation request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::GetRecommendationRequest # 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.get_recommendation..to_h # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id header_params = { "resource_name" => request.resource_name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_recommendation.timeout, metadata: , retry_policy: @config.rpcs.get_recommendation.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @recommendation_service_stub.call_rpc :get_recommendation, 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 |