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

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/google_ads/v5/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

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

To create a new CampaignDraftService client with the default configuration:

client = ::Google::Ads::GoogleAds::V5::Services::CampaignDraftService::Client.new

To create a new CampaignDraftService client with a custom configuration:

client = ::Google::Ads::GoogleAds::V5::Services::CampaignDraftService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CampaignDraftService client.

Yield Parameters:



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
 
# File 'lib/google/ads/google_ads/v5/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/v5/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
  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

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

  @campaign_draft_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V5::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/v5/services/campaign_draft_service/client.rb', line 37

def campaign_draft_service_stub
  @campaign_draft_service_stub
end

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

Get the associated client for long-running operations.

Returns:



157
158
159
 
# File 'lib/google/ads/google_ads/v5/services/campaign_draft_service/client.rb', line 157

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::V5::Services::CampaignDraftService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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/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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



91
92
93
94
 
# File 'lib/google/ads/google_ads/v5/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::V5::Resources::CampaignDraft #get_campaign_draft(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::CampaignDraft

Returns the requested campaign draft in full detail.

Overloads:

  • #get_campaign_draft(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::CampaignDraft

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

    Parameters:

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

  • #get_campaign_draft(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::CampaignDraft

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/google/ads/google_ads/v5/services/campaign_draft_service/client.rb', line 190

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::GetCampaignDraftRequest

  # 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.get_campaign_draft.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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-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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

  @campaign_draft_service_stub.call_rpc :get_campaign_draft, 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

#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.

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::V5::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.



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/google/ads/google_ads/v5/services/campaign_draft_service/client.rb', line 422

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::V5::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 and x-goog-user-project 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-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("&")
  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 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::V5::Services::MutateCampaignDraftsResponse #mutate_campaign_drafts(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::MutateCampaignDraftsResponse

Creates, updates, or removes campaign drafts. Operation statuses are returned.

Overloads:

  • #mutate_campaign_drafts(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::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::V5::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::V5::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::V5::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::V5::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.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/google/ads/google_ads/v5/services/campaign_draft_service/client.rb', line 270

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::V5::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 and x-goog-user-project 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-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("&")
  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 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) ⇒ ::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.

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::V5::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) ⇒ ::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.

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.



344
345
346
347
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
 
# File 'lib/google/ads/google_ads/v5/services/campaign_draft_service/client.rb', line 344

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::V5::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 and x-goog-user-project 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-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("&")
  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 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