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

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

Overview

Client for the GoogleAdsFieldService service.

Service to fetch Google Ads API fields.

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

#google_ads_field_path

Constructor Details

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

Create a new GoogleAdsFieldService client object.

Examples:


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

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

Yields:

  • (config) —

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

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



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

def google_ads_field_service_stub
  @google_ads_field_service_stub
end

Class Method Details

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

Configure the GoogleAdsFieldService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all GoogleAdsFieldService clients
::Google::Ads::GoogleAds::V17::Services::GoogleAdsFieldService::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/google_ads_field_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 GoogleAdsFieldService 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/google_ads_field_service/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#get_google_ads_field(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Resources::GoogleAdsField #get_google_ads_field(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V17::Resources::GoogleAdsField

Returns just the requested field.

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::GoogleAdsFieldService::Client.new

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Resources::GoogleAdsField.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
254
255
256
257
258
259
 
# File 'lib/google/ads/google_ads/v17/services/google_ads_field_service/client.rb', line 217

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

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

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

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

  @google_ads_field_service_stub.call_rpc :get_google_ads_field, 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

#search_google_ads_fields(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Resources::GoogleAdsField> #search_google_ads_fields(query: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Resources::GoogleAdsField>

Returns all fields that match the search query.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QueryError]()
[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::GoogleAdsFieldService::Client.new

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

# Call the search_google_ads_fields method.
result = client.search_google_ads_fields 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::GoogleAds::V17::Resources::GoogleAdsField.
  p item
end

Overloads:

  • #search_google_ads_fields(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Resources::GoogleAdsField>

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

    Parameters:

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

  • #search_google_ads_fields(query: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V17::Resources::GoogleAdsField>

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

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

      Required. The query string.

    • 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 too large a page is requested, 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:

Returns:

Raises:

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

    if the RPC is aborted.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/google/ads/google_ads/v17/services/google_ads_field_service/client.rb', line 326

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

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

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

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

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

def universe_domain
  @google_ads_field_service_stub.universe_domain
end