Class: Google::Ads::GoogleAds::V8::Services::CampaignDraftService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V8::Services::CampaignDraftService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v8/services/campaign_draft_service/client.rb
Overview
Client for the CampaignDraftService service.
Service to manage campaign drafts.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
- #campaign_draft_service_stub ⇒ Object readonly
-
#operations_client ⇒ ::Google::Ads::GoogleAds::V8::Services::CampaignDraftService::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the CampaignDraftService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the CampaignDraftService Client instance.
-
#get_campaign_draft(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V8::Resources::CampaignDraft
Returns the requested campaign draft in full detail.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new CampaignDraftService client object.
-
#list_campaign_draft_async_errors(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>
Returns all errors that occurred during CampaignDraft promote.
-
#mutate_campaign_drafts(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V8::Services::MutateCampaignDraftsResponse
Creates, updates, or removes campaign drafts.
-
#promote_campaign_draft(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Promotes the changes in a draft back to the base campaign.
Methods included from Paths
#campaign_draft_path, #campaign_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new CampaignDraftService client object.
## Examples
To create a new CampaignDraftService client with the default configuration:
client = ::Google::Ads::GoogleAds::V8::Services::CampaignDraftService::Client.new
To create a new CampaignDraftService client with a custom configuration:
client = ::Google::Ads::GoogleAds::V8::Services::CampaignDraftService::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 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/google/ads/google_ads/v8/services/campaign_draft_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/v8/services/campaign_draft_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 scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @campaign_draft_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V8::Services::CampaignDraftService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#campaign_draft_service_stub ⇒ Object (readonly)
37 38 39 |
# File 'lib/google/ads/google_ads/v8/services/campaign_draft_service/client.rb', line 37 def campaign_draft_service_stub @campaign_draft_service_stub end |
#operations_client ⇒ ::Google::Ads::GoogleAds::V8::Services::CampaignDraftService::Operations (readonly)
Get the associated client for long-running operations.
163 164 165 |
# File 'lib/google/ads/google_ads/v8/services/campaign_draft_service/client.rb', line 163 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the CampaignDraftService Client class.
See Configuration for a description of the configuration fields.
## Example
To modify the configuration for all CampaignDraftService clients:
::Google::Ads::GoogleAds::V8::Services::CampaignDraftService::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/v8/services/campaign_draft_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
#configure {|config| ... } ⇒ Client::Configuration
Configure the CampaignDraftService 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/v8/services/campaign_draft_service/client.rb', line 91 def configure yield @config if block_given? @config end |
#get_campaign_draft(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Resources::CampaignDraft #get_campaign_draft(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V8::Resources::CampaignDraft
Returns the requested campaign draft in full detail.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/google/ads/google_ads/v8/services/campaign_draft_service/client.rb', line 204 def get_campaign_draft request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V8::Services::GetCampaignDraftRequest # 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_campaign_draft..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_campaign_draft.timeout, metadata: , retry_policy: @config.rpcs.get_campaign_draft.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @campaign_draft_service_stub.call_rpc :get_campaign_draft, 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_campaign_draft_async_errors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status> #list_campaign_draft_async_errors(resource_name: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>
Returns all errors that occurred during CampaignDraft promote. Throws an error if called before campaign draft is promoted. Supports standard list paging.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
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 503 504 505 506 507 508 509 510 511 512 513 |
# File 'lib/google/ads/google_ads/v8/services/campaign_draft_service/client.rb', line 474 def list_campaign_draft_async_errors request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V8::Services::ListCampaignDraftAsyncErrorsRequest # 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_campaign_draft_async_errors..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.list_campaign_draft_async_errors.timeout, metadata: , retry_policy: @config.rpcs.list_campaign_draft_async_errors.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @campaign_draft_service_stub.call_rpc :list_campaign_draft_async_errors, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @campaign_draft_service_stub, :list_campaign_draft_async_errors, request, 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 |
#mutate_campaign_drafts(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::MutateCampaignDraftsResponse #mutate_campaign_drafts(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V8::Services::MutateCampaignDraftsResponse
Creates, updates, or removes campaign drafts. Operation statuses are returned.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[CampaignDraftError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[QuotaError]()
[RequestError]()
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/google/ads/google_ads/v8/services/campaign_draft_service/client.rb', line 298 def mutate_campaign_drafts request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V8::Services::MutateCampaignDraftsRequest # 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.mutate_campaign_drafts..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.mutate_campaign_drafts.timeout, metadata: , retry_policy: @config.rpcs.mutate_campaign_drafts.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @campaign_draft_service_stub.call_rpc :mutate_campaign_drafts, 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 |
#promote_campaign_draft(request, options = nil) ⇒ ::Gapic::Operation #promote_campaign_draft(campaign_draft: nil, validate_only: nil) ⇒ ::Gapic::Operation
Promotes the changes in a draft back to the base campaign.
This method returns a Long Running Operation (LRO) indicating if the Promote is done. Use [Operations.GetOperation] to poll the LRO until it is done. Only a done status is returned in the response. See the status in the Campaign Draft resource to determine if the promotion was successful. If the LRO failed, use CampaignDraftService.ListCampaignDraftAsyncErrors to view the list of error reasons.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[CampaignDraftError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
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 415 416 417 418 419 420 421 422 423 424 |
# File 'lib/google/ads/google_ads/v8/services/campaign_draft_service/client.rb', line 386 def promote_campaign_draft request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V8::Services::PromoteCampaignDraftRequest # 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.promote_campaign_draft..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 = { "campaign_draft" => request.campaign_draft } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.promote_campaign_draft.timeout, metadata: , retry_policy: @config.rpcs.promote_campaign_draft.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @campaign_draft_service_stub.call_rpc :promote_campaign_draft, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |