Class: Google::Ads::GoogleAds::V17::Services::CampaignDraftService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/google_ads/v17/services/campaign_draft_service/client.rb

Overview

Client for the CampaignDraftService service.

Service to manage campaign drafts.

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

Methods included from Paths

#campaign_draft_path, #campaign_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new CampaignDraftService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CampaignDraftService 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
 
# File 'lib/google/ads/google_ads/v17/services/campaign_draft_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/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 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

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @campaign_draft_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V17::Services::CampaignDraftService::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

#campaign_draft_service_stub ⇒ Object (readonly) 



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

def campaign_draft_service_stub
  @campaign_draft_service_stub
end

#operations_client ⇒ ::Google::Ads::GoogleAds::V17::Services::CampaignDraftService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



175
176
177
 
# File 'lib/google/ads/google_ads/v17/services/campaign_draft_service/client.rb', line 175

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.

Examples:


# Modify the configuration for all CampaignDraftService clients
::Google::Ads::GoogleAds::V17::Services::CampaignDraftService::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/v17/services/campaign_draft_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 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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

def configure
  yield @config if block_given?
  @config
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]()

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Rpc::Status.
  p item
end

Overloads:

  • #list_campaign_draft_async_errors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::ListCampaignDraftAsyncErrorsRequest, ::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_campaign_draft_async_errors(resource_name: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Rpc::Status>

    Pass arguments to ‘list_campaign_draft_async_errors` 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:

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

      Required. The name of the campaign draft from which to retrieve the async errors.

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

      Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from ‘next_page_token` in the previous response in order to request the next page of results.

    • page_size (::Integer) (defaults to: nil) —

      Number of elements to retrieve in a single page. When a page request is too large, the server may decide to further limit the number of returned resources.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::PagedEnumerable<::Google::Rpc::Status>)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::PagedEnumerable<::Google::Rpc::Status>)

Raises:

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

    if the RPC is aborted.



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
514
515
516
517
518
519
520
521
 
# File 'lib/google/ads/google_ads/v17/services/campaign_draft_service/client.rb', line 477

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::ListCampaignDraftAsyncErrorsRequest

  # 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_campaign_draft_async_errors.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.resource_name
    header_params["resource_name"] = request.resource_name
  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_campaign_draft_async_errors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_campaign_draft_async_errors.retry_policy

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

  @campaign_draft_service_stub.call_rpc :list_campaign_draft_async_errors, request,
                                        options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @campaign_draft_service_stub,
                                            :list_campaign_draft_async_errors, request, response, operation, 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

#mutate_campaign_drafts(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateCampaignDraftsResponse #mutate_campaign_drafts(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V17::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]()

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::MutateCampaignDraftsResponse.
p result

Overloads:

  • #mutate_campaign_drafts(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateCampaignDraftsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::MutateCampaignDraftsRequest, ::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.

  • #mutate_campaign_drafts(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::MutateCampaignDraftsResponse

    Pass arguments to ‘mutate_campaign_drafts` 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 whose campaign drafts are being modified.

    • operations (::Array<::Google::Ads::GoogleAds::V17::Services::CampaignDraftOperation, ::Hash>) (defaults to: nil) —

      Required. The list of operations to perform on individual campaign drafts.

    • partial_failure (::Boolean) (defaults to: nil) —

      If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

    • response_content_type (::Google::Ads::GoogleAds::V17::Enums::ResponseContentTypeEnum::ResponseContentType) (defaults to: nil) —

      The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



249
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
291
 
# File 'lib/google/ads/google_ads/v17/services/campaign_draft_service/client.rb', line 249

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::MutateCampaignDraftsRequest

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

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

  @campaign_draft_service_stub.call_rpc :mutate_campaign_drafts, request,
                                        options: 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]()

Examples:

Basic example

require "google/ads/google_ads/v17/services"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #promote_campaign_draft(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V17::Services::PromoteCampaignDraftRequest, ::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.

  • #promote_campaign_draft(campaign_draft: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to ‘promote_campaign_draft` 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:

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

      Required. The resource name of the campaign draft to promote.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but no Long Running Operation is created. Only errors are returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/google/ads/google_ads/v17/services/campaign_draft_service/client.rb', line 364

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V17::Services::PromoteCampaignDraftRequest

  # 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.promote_campaign_draft.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.campaign_draft
    header_params["campaign_draft"] = request.campaign_draft
  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.promote_campaign_draft.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.promote_campaign_draft.retry_policy

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

  @campaign_draft_service_stub.call_rpc :promote_campaign_draft, request,
                                        options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

def universe_domain
  @campaign_draft_service_stub.universe_domain
end