Class: Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/merchant/accounts/v1/homepage_service/rest/client.rb

Overview

REST client for the HomepageService service.

Service to support an API for a store's homepage.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#homepage_path

Constructor Details

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

Create a new HomepageService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the HomepageService 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/accounts/v1/homepage_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

  @homepage_service_stub = ::Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @homepage_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 HomepageService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all HomepageService clients
::Google::Shopping::Merchant::Accounts::V1::HomepageService::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/accounts/v1/homepage_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Accounts", "V1"]
    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

#claim_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage #claim_homepage(name: nil, overwrite: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

Claims a store's homepage. Executing this method requires admin access.

If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim.

In case of failure, a canonical error message is returned:

  • PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account.

  • FAILED_PRECONDITION:

    • The account is not a Merchant Center account.
    • Merchant Center account doesn't have a homepage.
    • Claiming failed (in this case the error message contains more details).

Examples:

Basic example

require "google/shopping/merchant/accounts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Accounts::V1::ClaimHomepageRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Accounts::V1::Homepage.
p result

Overloads:

  • #claim_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1::ClaimHomepageRequest, ::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.

  • #claim_homepage(name: nil, overwrite: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

    Pass arguments to claim_homepage 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 homepage to claim. Format: accounts/{account}/homepage

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

      Optional. When set to true, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
443
444
445
446
447
448
449
450
 
# File 'lib/google/shopping/merchant/accounts/v1/homepage_service/rest/client.rb', line 417

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1::ClaimHomepageRequest

  # 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.claim_homepage.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::Accounts::V1::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.claim_homepage.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.claim_homepage.retry_policy

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

  @homepage_service_stub.claim_homepage 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

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

Configure the HomepageService 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/accounts/v1/homepage_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#get_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage #get_homepage(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

Retrieves a store's homepage.

Examples:

Basic example

require "google/shopping/merchant/accounts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Accounts::V1::GetHomepageRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Accounts::V1::Homepage.
p result

Overloads:

  • #get_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1::GetHomepageRequest, ::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_homepage(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

    Pass arguments to get_homepage 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 homepage to retrieve. Format: accounts/{account}/homepage

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
260
261
262
 
# File 'lib/google/shopping/merchant/accounts/v1/homepage_service/rest/client.rb', line 229

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1::GetHomepageRequest

  # 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_homepage.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::Accounts::V1::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_homepage.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_homepage.retry_policy

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

  @homepage_service_stub.get_homepage 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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


179
180
181
 
# File 'lib/google/shopping/merchant/accounts/v1/homepage_service/rest/client.rb', line 179

def logger
  @homepage_service_stub.logger
end

#unclaim_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage #unclaim_homepage(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

Unclaims a store's homepage. Executing this method requires admin access.

Examples:

Basic example

require "google/shopping/merchant/accounts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Accounts::V1::UnclaimHomepageRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Accounts::V1::Homepage.
p result

Overloads:

  • #unclaim_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1::UnclaimHomepageRequest, ::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.

  • #unclaim_homepage(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

    Pass arguments to unclaim_homepage 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 homepage to unclaim. Format: accounts/{account}/homepage

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/google/shopping/merchant/accounts/v1/homepage_service/rest/client.rb', line 496

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1::UnclaimHomepageRequest

  # 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.unclaim_homepage.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::Accounts::V1::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.unclaim_homepage.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.unclaim_homepage.retry_policy

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

  @homepage_service_stub.unclaim_homepage 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/shopping/merchant/accounts/v1/homepage_service/rest/client.rb', line 112

def universe_domain
  @homepage_service_stub.universe_domain
end

#update_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage #update_homepage(homepage: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::Homepage

Updates a store's homepage. Executing this method requires admin access.

Examples:

Basic example

require "google/shopping/merchant/accounts/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Accounts::V1::UpdateHomepageRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Accounts::V1::Homepage.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



314
315
316
317
318
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
 
# File 'lib/google/shopping/merchant/accounts/v1/homepage_service/rest/client.rb', line 314

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1::UpdateHomepageRequest

  # 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.update_homepage.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::Accounts::V1::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.update_homepage.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_homepage.retry_policy

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

  @homepage_service_stub.update_homepage 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