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

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

Overview

Client for the TravelAssetSuggestionService service.

Service to retrieve Travel asset suggestions.

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

Constructor Details

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

Create a new TravelAssetSuggestionService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the TravelAssetSuggestionService client.

Yield Parameters:



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
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/google/ads/google_ads/v17/services/travel_asset_suggestion_service/client.rb', line 121

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

  @travel_asset_suggestion_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V17::Services::TravelAssetSuggestionService::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,
    logger: @config.logger
  )

  @travel_asset_suggestion_service_stub.stub_logger&.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

#travel_asset_suggestion_service_stub ⇒ Object (readonly) 



41
42
43
 
# File 'lib/google/ads/google_ads/v17/services/travel_asset_suggestion_service/client.rb', line 41

def travel_asset_suggestion_service_stub
  @travel_asset_suggestion_service_stub
end

Class Method Details

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

Configure the TravelAssetSuggestionService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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 TravelAssetSuggestionService 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/v17/services/travel_asset_suggestion_service/client.rb', line 91

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


177
178
179
 
# File 'lib/google/ads/google_ads/v17/services/travel_asset_suggestion_service/client.rb', line 177

def logger
  @travel_asset_suggestion_service_stub.logger
end

#suggest_travel_assets(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::SuggestTravelAssetsResponse #suggest_travel_assets(customer_id: nil, language_option: nil, place_ids: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::SuggestTravelAssetsResponse

Returns Travel Asset suggestions. Asset suggestions are returned on a best-effort basis. There are no guarantees that all possible asset types will be returned for any given hotel property.

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V17::Services::SuggestTravelAssetsResponse.
p result

Overloads:

  • #suggest_travel_assets(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::SuggestTravelAssetsResponse

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

    Parameters:

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

  • #suggest_travel_assets(customer_id: nil, language_option: nil, place_ids: nil) ⇒ ::Google::Ads::GoogleAds::V17::Services::SuggestTravelAssetsResponse

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

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

      Required. The language specifications in BCP 47 format (for example, en-US, zh-CN, etc.) for the asset suggestions. Text will be in this language. Usually matches one of the campaign target languages.

    • place_ids (::Array<::String>) (defaults to: nil) —

      The Google Maps Place IDs of hotels for which assets are requested. See developers.google.com/places/web-service/place-id for more information.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/google/ads/google_ads/v17/services/travel_asset_suggestion_service/client.rb', line 238

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

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

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

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

  @travel_asset_suggestion_service_stub.call_rpc :suggest_travel_assets, request,
                                                 options: options do |response, operation|
    yield response, operation if block_given?
  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) 


101
102
103
 
# File 'lib/google/ads/google_ads/v17/services/travel_asset_suggestion_service/client.rb', line 101

def universe_domain
  @travel_asset_suggestion_service_stub.universe_domain
end