Class: Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb

Overview

REST client for the AdReviewCenterAdService service.

Provides methods for handling AdReviewCenterAd objects.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#ad_review_center_ad_path, #web_property_path

Constructor Details

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

Create a new AdReviewCenterAdService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the AdReviewCenterAdService client.

Yield Parameters:



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
169
170
171
172
173
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 126

def initialize
  # 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 = ::Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @ad_review_center_ad_service_stub = ::Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @ad_review_center_ad_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#operations_client ⇒ ::Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Operations (readonly)

Get the associated client for long-running operations.



180
181
182
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 180

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the AdReviewCenterAdService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all AdReviewCenterAdService clients
::Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Ads", "AdManager", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_allow_ad_review_center_ads(request, options = nil) ⇒ ::Gapic::Operation #batch_allow_ad_review_center_ads(parent: nil, names: nil) ⇒ ::Gapic::Operation

API to batch allow AdReviewCenterAds. This method supports partial success. Some operations may succeed while others fail. Callers should check the failedRequests field in the response to determine which operations failed.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::BatchAllowAdReviewCenterAdsRequest.new

# Call the batch_allow_ad_review_center_ads method.
result = client.batch_allow_ad_review_center_ads 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:

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

    Pass arguments to batch_allow_ad_review_center_ads via a request object, either of type BatchAllowAdReviewCenterAdsRequest or an equivalent Hash.

  • #batch_allow_ad_review_center_ads(parent: nil, names: nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_allow_ad_review_center_ads 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).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



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
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 386

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::BatchAllowAdReviewCenterAdsRequest

  # 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
  call_metadata = @config.rpcs.batch_allow_ad_review_center_ads.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_allow_ad_review_center_ads.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_allow_ad_review_center_ads.retry_policy

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

  @ad_review_center_ad_service_stub.batch_allow_ad_review_center_ads request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_block_ad_review_center_ads(request, options = nil) ⇒ ::Gapic::Operation #batch_block_ad_review_center_ads(parent: nil, names: nil) ⇒ ::Gapic::Operation

API to batch block AdReviewCenterAds. This method supports partial success. Some operations may succeed while others fail. Callers should check the failedRequests field in the response to determine which operations failed.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::BatchBlockAdReviewCenterAdsRequest.new

# Call the batch_block_ad_review_center_ads method.
result = client.batch_block_ad_review_center_ads 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:

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

    Pass arguments to batch_block_ad_review_center_ads via a request object, either of type BatchBlockAdReviewCenterAdsRequest or an equivalent Hash.

  • #batch_block_ad_review_center_ads(parent: nil, names: nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_block_ad_review_center_ads 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).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



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
522
523
524
525
526
527
528
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 493

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::BatchBlockAdReviewCenterAdsRequest

  # 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
  call_metadata = @config.rpcs.batch_block_ad_review_center_ads.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_block_ad_review_center_ads.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_block_ad_review_center_ads.retry_policy

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

  @ad_review_center_ad_service_stub.batch_block_ad_review_center_ads request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the AdReviewCenterAdService 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:



96
97
98
99
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.



187
188
189
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 187

def logger
  @ad_review_center_ad_service_stub.logger
end

#search_ad_review_center_ads(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::AdReviewCenterAd> #search_ad_review_center_ads(parent: nil, page_size: nil, page_token: nil, status: nil, ad_review_center_ad_id: nil, date_time_range: nil, search_text: nil, buyer_account_id: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::AdReviewCenterAd>

API to search for AdReviewCenterAds.

Examples:

Basic example

require "google/ads/ad_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::AdManager::V1::AdReviewCenterAdService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::AdManager::V1::SearchAdReviewCenterAdsRequest.new

# Call the search_ad_review_center_ads method.
result = client.search_ad_review_center_ads 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::Ads::AdManager::V1::AdReviewCenterAd.
  p item
end

Overloads:

  • #search_ad_review_center_ads(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::AdReviewCenterAd>

    Pass arguments to search_ad_review_center_ads via a request object, either of type SearchAdReviewCenterAdsRequest or an equivalent Hash.

  • #search_ad_review_center_ads(parent: nil, page_size: nil, page_token: nil, status: nil, ad_review_center_ad_id: nil, date_time_range: nil, search_text: nil, buyer_account_id: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Ads::AdManager::V1::AdReviewCenterAd>

    Pass arguments to search_ad_review_center_ads 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).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



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
306
307
308
309
310
311
312
313
314
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 279

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::AdManager::V1::SearchAdReviewCenterAdsRequest

  # 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
  call_metadata = @config.rpcs.search_ad_review_center_ads.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::AdManager::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_ad_review_center_ads.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_ad_review_center_ads.retry_policy

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

  @ad_review_center_ad_service_stub.search_ad_review_center_ads request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @ad_review_center_ad_service_stub, :search_ad_review_center_ads, "ad_review_center_ads", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain



106
107
108
 
# File 'lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb', line 106

def universe_domain
  @ad_review_center_ad_service_stub.universe_domain
end