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

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

Overview

REST client for the GbpAccountsService service.

The service facilitates the management of a merchant's Google Business Profile (GBP) account settings. This API defines the following resource model:

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path

Constructor Details

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

Create a new GbpAccountsService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the GbpAccountsService client.

Yield Parameters:



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
173
174
175
 
# File 'lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/rest/client.rb', line 135

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

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

  @gbp_accounts_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 GbpAccountsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all GbpAccountsService clients
::Google::Shopping::Merchant::Accounts::V1::GbpAccountsService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/rest/client.rb', line 68

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

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

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



105
106
107
108
 
# File 'lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/rest/client.rb', line 105

def configure
  yield @config if block_given?
  @config
end

#link_gbp_account(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::LinkGbpAccountResponse #link_gbp_account(parent: nil, gbp_email: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::LinkGbpAccountResponse

Link the specified merchant to a GBP account for all countries.

To run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message User is not an administrator of account {ACCOUNT_ID}.

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

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

# Call the link_gbp_account method.
result = client. request

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

Overloads:

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

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

    Parameters:

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

  • #link_gbp_account(parent: nil, gbp_email: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::LinkGbpAccountResponse

    Pass arguments to link_gbp_account 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 name of the parent resource to which the GBP account is linked. Format: accounts/{account}.

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

      Required. The email address of the Business Profile 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.



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/rest/client.rb', line 335

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

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

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

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

  @gbp_accounts_service_stub. 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_gbp_accounts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1::GbpAccount> #list_gbp_accounts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1::GbpAccount>

List the GBP accounts for a given merchant.

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

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

# Call the list_gbp_accounts method.
result = client.list_gbp_accounts 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::Accounts::V1::GbpAccount.
  p item
end

Overloads:

  • #list_gbp_accounts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1::GbpAccount>

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1::ListGbpAccountsRequest, ::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_gbp_accounts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1::GbpAccount>

    Pass arguments to list_gbp_accounts 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 name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

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

      Optional. A page token, received from a previous ListGbpAccounts call. Provide the page token to retrieve the subsequent page.

      When paginating, all other parameters provided to ListGbpAccounts must match the call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
280
281
282
283
 
# File 'lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/rest/client.rb', line 248

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

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

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

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

  @gbp_accounts_service_stub.list_gbp_accounts request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @gbp_accounts_service_stub, :list_gbp_accounts, "gbp_accounts", 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) 


182
183
184
 
# File 'lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/rest/client.rb', line 182

def logger
  @gbp_accounts_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


115
116
117
 
# File 'lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/rest/client.rb', line 115

def universe_domain
  @gbp_accounts_service_stub.universe_domain
end