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

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/merchant/accounts/v1beta/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::V1beta::HomepageService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::Accounts::V1beta::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
 
# File 'lib/google/shopping/merchant/accounts/v1beta/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::V1beta::HomepageService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
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::V1beta::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/v1beta/homepage_service/rest/client.rb', line 65

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

#claim_homepage(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Homepage #claim_homepage(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::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 merchant 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 will be returned:

  • PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account;
  • FAILED_PRECONDITION:
    • The account is not a Merchant Center account;
    • MC account doesn't have a homepage;
    • claiming failed (in this case the error message will contain more details).

Examples:

Basic example

require "google/shopping/merchant/accounts/v1beta"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1beta::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) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/google/shopping/merchant/accounts/v1beta/homepage_service/rest/client.rb', line 383

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::V1beta::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::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.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?
    return result
  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/v1beta/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::V1beta::Homepage #get_homepage(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Homepage

Retrieves a store's homepage.

Examples:

Basic example

require "google/shopping/merchant/accounts/v1beta"

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

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

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

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

Overloads:

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

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

    Parameters:

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



209
210
211
212
213
214
215
216
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
 
# File 'lib/google/shopping/merchant/accounts/v1beta/homepage_service/rest/client.rb', line 209

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::V1beta::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::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_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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/shopping/merchant/accounts/v1beta"

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

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

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

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

Overloads:

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

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

    Parameters:

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



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/google/shopping/merchant/accounts/v1beta/homepage_service/rest/client.rb', line 463

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::V1beta::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::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.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?
    return result
  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/v1beta/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::V1beta::Homepage #update_homepage(homepage: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Homepage

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

Examples:

Basic example

require "google/shopping/merchant/accounts/v1beta"

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

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

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

# The returned object is of type Google::Shopping::Merchant::Accounts::V1beta::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.



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/google/shopping/merchant/accounts/v1beta/homepage_service/rest/client.rb', line 290

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::V1beta::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::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.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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end