class Google::Ads::GoogleAds::V8::Services::GoogleAdsFieldService::Client
Client
for the GoogleAdsFieldService
service.
Attributes
@private
Public Class Methods
Configure the GoogleAdsFieldService
Client
class.
See {::Google::Ads::GoogleAds::V8::Services::GoogleAdsFieldService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all GoogleAdsFieldService clients ::Google::Ads::GoogleAds::V8::Services::GoogleAdsFieldService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/ads/google_ads/v8/services/google_ads_field_service/client.rb, line 57 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
Create a new GoogleAdsFieldService
client object.
@example
# Create a client using the default configuration client = ::Google::Ads::GoogleAds::V8::Services::GoogleAdsFieldService::Client.new # Create a client using a custom configuration client = ::Google::Ads::GoogleAds::V8::Services::GoogleAdsFieldService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the GoogleAdsFieldService
client. @yieldparam config [Client::Configuration]
# File lib/google/ads/google_ads/v8/services/google_ads_field_service/client.rb, line 108 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/v8/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 == Client.configure.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::V8::Services::GoogleAdsFieldService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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 {Client.configure}.
See {::Google::Ads::GoogleAds::V8::Services::GoogleAdsFieldService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/ads/google_ads/v8/services/google_ads_field_service/client.rb, line 87 def configure yield @config if block_given? @config end
Returns just the requested field.
List of thrown errors:
[AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
@overload get_google_ads_field
(request, options = nil)
Pass arguments to `get_google_ads_field` via a request object, either of type {::Google::Ads::GoogleAds::V8::Services::GetGoogleAdsFieldRequest} or an equivalent Hash. @param request [::Google::Ads::GoogleAds::V8::Services::GetGoogleAdsFieldRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_google_ads_field
(resource_name: nil)
Pass arguments to `get_google_ads_field` 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). @param resource_name [::String] Required. The resource name of the field to get.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Resources::GoogleAdsField] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Ads::GoogleAds::V8::Resources::GoogleAdsField]
@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
# File lib/google/ads/google_ads/v8/services/google_ads_field_service/client.rb, line 183 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::V8::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 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_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
Returns all fields that match the search query.
List of thrown errors:
[AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
@overload search_google_ads_fields
(request, options = nil)
Pass arguments to `search_google_ads_fields` via a request object, either of type {::Google::Ads::GoogleAds::V8::Services::SearchGoogleAdsFieldsRequest} or an equivalent Hash. @param request [::Google::Ads::GoogleAds::V8::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload search_google_ads_fields
(query: nil, page_token: nil, page_size: nil)
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). @param query [::String] Required. The query string. @param page_token [::String] 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. @param page_size [::Integer] 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.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V8::Resources::GoogleAdsField>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V8::Resources::GoogleAdsField>]
@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
# File lib/google/ads/google_ads/v8/services/google_ads_field_service/client.rb, line 270 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::V8::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 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 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