Class: Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb

Overview

REST client for the PromotionsService service.

Service to manage promotions for products.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#promotion_path

Constructor Details

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

Create a new PromotionsService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the PromotionsService client.

Yield Parameters:



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
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 132

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

  @promotions_service_stub = ::Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @promotions_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

Class Method Details

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

Configure the PromotionsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all PromotionsService clients
::Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Promotions", "V1beta"]
    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.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



102
103
104
105
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#get_promotion(request, options = nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion #get_promotion(name: nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion

Retrieves the promotion from your Merchant Center account.

After inserting or updating a promotion input, it may take several minutes before the updated promotion can be retrieved.

Examples:

Basic example

require "google/shopping/merchant/promotions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Promotions::V1beta::GetPromotionRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Promotions::V1beta::Promotion.
p result

Overloads:

  • #get_promotion(request, options = nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion

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

    Parameters:

    • request (::Google::Shopping::Merchant::Promotions::V1beta::GetPromotionRequest, ::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_promotion(name: nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion

    Pass arguments to get_promotion 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:

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

      Required. The name of the promotion to retrieve. Format: accounts/{account}/promotions/{promotions}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



319
320
321
322
323
324
325
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
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 319

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Promotions::V1beta::GetPromotionRequest

  # 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.get_promotion.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::Shopping::Merchant::Promotions::V1beta::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.get_promotion.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_promotion.retry_policy

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

  @promotions_service_stub.get_promotion request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#insert_promotion(request, options = nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion #insert_promotion(parent: nil, promotion: nil, data_source: nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion

Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead.

Examples:

Basic example

require "google/shopping/merchant/promotions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Promotions::V1beta::InsertPromotionRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Promotions::V1beta::Promotion.
p result

Overloads:

  • #insert_promotion(request, options = nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion

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

    Parameters:

    • request (::Google::Shopping::Merchant::Promotions::V1beta::InsertPromotionRequest, ::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.

  • #insert_promotion(parent: nil, promotion: nil, data_source: nil) ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Promotion

    Pass arguments to insert_promotion 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:

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

      Required. The account where the promotion will be inserted. Format: accounts/{account}

    • promotion (::Google::Shopping::Merchant::Promotions::V1beta::Promotion, ::Hash) (defaults to: nil) —

      Required. The promotion to insert.

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

      Required. The data source of the promotion Format: accounts/{account}/dataSources/{datasource}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



237
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
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 237

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Promotions::V1beta::InsertPromotionRequest

  # 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.insert_promotion.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::Shopping::Merchant::Promotions::V1beta::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.insert_promotion.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.insert_promotion.retry_policy

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

  @promotions_service_stub.insert_promotion request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_promotions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Promotions::V1beta::Promotion> #list_promotions(parent: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Promotions::V1beta::Promotion>

Lists the promotions in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting or updating a promotion, it may take several minutes before the updated processed promotion can be retrieved.

Examples:

Basic example

require "google/shopping/merchant/promotions/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Promotions::V1beta::PromotionsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Promotions::V1beta::ListPromotionsRequest.new

# Call the list_promotions method.
result = client.list_promotions 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::Shopping::Merchant::Promotions::V1beta::Promotion.
  p item
end

Overloads:

  • #list_promotions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Promotions::V1beta::Promotion>

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

    Parameters:

    • request (::Google::Shopping::Merchant::Promotions::V1beta::ListPromotionsRequest, ::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.

  • #list_promotions(parent: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Promotions::V1beta::Promotion>

    Pass arguments to list_promotions 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:

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

      Required. The account to list processed promotions for. Format: accounts/{account}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 407

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Promotions::V1beta::ListPromotionsRequest

  # 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.list_promotions.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::Shopping::Merchant::Promotions::V1beta::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.list_promotions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_promotions.retry_policy

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

  @promotions_service_stub.list_promotions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @promotions_service_stub, :list_promotions, "promotions", 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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


179
180
181
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 179

def logger
  @promotions_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb', line 112

def universe_domain
  @promotions_service_stub.universe_domain
end