Class: Google::Ads::GoogleAds::V16::Services::AdService::Client

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

Overview

Client for the AdService service.

Service to manage ads.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#ad_path

Constructor Details

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

Create a new AdService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the AdService client.

Yield Parameters:



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
157
158
 
# File 'lib/google/ads/google_ads/v16/services/ad_service/client.rb', line 120

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/v16/services/ad_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

  @ad_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V16::Services::AdService::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

#ad_service_stub ⇒ Object (readonly) 



40
41
42
 
# File 'lib/google/ads/google_ads/v16/services/ad_service/client.rb', line 40

def ad_service_stub
  @ad_service_stub
end

Class Method Details

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

Configure the AdService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all AdService clients
::Google::Ads::GoogleAds::V16::Services::AdService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/google/ads/google_ads/v16/services/ad_service/client.rb', line 60

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 AdService 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:



90
91
92
93
 
# File 'lib/google/ads/google_ads/v16/services/ad_service/client.rb', line 90

def configure
  yield @config if block_given?
  @config
end

#get_ad(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Resources::Ad #get_ad(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V16::Resources::Ad

Returns the requested ad in full detail.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V16::Resources::Ad.
p result

Overloads:

  • #get_ad(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Resources::Ad

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V16::Services::GetAdRequest, ::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_ad(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V16::Resources::Ad

    Pass arguments to ‘get_ad` 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 ad 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.



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
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/google/ads/google_ads/v16/services/ad_service/client.rb', line 214

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::GetAdRequest

  # 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_ad.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 = {}
  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.get_ad.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_ad.retry_policy

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

  @ad_service_stub.call_rpc :get_ad, 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

#mutate_ads(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::MutateAdsResponse #mutate_ads(customer_id: nil, operations: nil, partial_failure: nil, response_content_type: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::MutateAdsResponse

Updates ads. Operation statuses are returned. Updating ads is not supported for TextAd, ExpandedDynamicSearchAd, GmailAd and ImageAd.

List of thrown errors:

[AdCustomizerError]()
[AdError]()
[AdSharingError]()
[AdxError]()
[AssetError]()
[AssetLinkError]()
[AuthenticationError]()
[AuthorizationError]()
[CollectionSizeError]()
[DatabaseError]()
[DateError]()
[DistinctError]()
[FeedAttributeReferenceError]()
[FieldError]()
[FieldMaskError]()
[FunctionError]()
[FunctionParsingError]()
[HeaderError]()
[IdError]()
[ImageError]()
[InternalError]()
[ListOperationError]()
[MediaBundleError]()
[MediaFileError]()
[MutateError]()
[NewResourceCreationError]()
[NotEmptyError]()
[NullError]()
[OperatorError]()
[PolicyFindingError]()
[PolicyViolationError]()
[QuotaError]()
[RangeError]()
[RequestError]()
[SizeLimitError]()
[StringFormatError]()
[StringLengthError]()
[UrlFieldError]()

Examples:

Basic example

require "google/ads/google_ads/v16/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V16::Services::MutateAdsResponse.
p result

Overloads:

  • #mutate_ads(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::MutateAdsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V16::Services::MutateAdsRequest, ::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_ads(customer_id: nil, operations: nil, partial_failure: nil, response_content_type: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::MutateAdsResponse

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

    Parameters:

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

      Required. The ID of the customer whose ads are being modified.

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

      Required. The list of operations to perform on individual ads.

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

    • response_content_type (::Google::Ads::GoogleAds::V16::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.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/google/ads/google_ads/v16/services/ad_service/client.rb', line 353

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V16::Services::MutateAdsRequest

  # 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_ads.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 = {}
  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_ads.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_ads.retry_policy

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

  @ad_service_stub.call_rpc :mutate_ads, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


100
101
102
 
# File 'lib/google/ads/google_ads/v16/services/ad_service/client.rb', line 100

def universe_domain
  @ad_service_stub.universe_domain
end