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

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

Overview

REST client for the AccountRelationshipsService service.

Service to support AccountRelationship API.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #account_relationship_path

Constructor Details

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

Create a new AccountRelationshipsService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the AccountRelationshipsService 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/account_relationships_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

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

  @account_relationships_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 AccountRelationshipsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all AccountRelationshipsService clients
::Google::Shopping::Merchant::Accounts::V1::AccountRelationshipsService::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/account_relationships_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

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

Configure the AccountRelationshipsService 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/account_relationships_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

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

Retrieve an account relationship.

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

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

# Call the get_account_relationship method.
result = client. request

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

Overloads:

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

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

    Parameters:

    • request (::Google::Shopping::Merchant::Accounts::V1::GetAccountRelationshipRequest, ::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_account_relationship(name: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::AccountRelationship

    Pass arguments to get_account_relationship 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 resource name of the account relationship to get. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
263
 
# File 'lib/google/shopping/merchant/accounts/v1/account_relationships_service/rest/client.rb', line 230

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

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

  # 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

  @account_relationships_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_account_relationships(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1::AccountRelationship> #list_account_relationships(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1::AccountRelationship>

List account relationships for the specified account.

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

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

# Call the list_account_relationships method.
result = client. 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::AccountRelationship.
  p item
end

Overloads:

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

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

    Parameters:

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

    Pass arguments to list_account_relationships 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 parent account of the account relationship to filter by. Format: accounts/{account}

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

      Optional. The token returned by the previous list request.

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

      Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value. The maximum allowed value is 1000.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



405
406
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
 
# File 'lib/google/shopping/merchant/accounts/v1/account_relationships_service/rest/client.rb', line 405

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

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

  # 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

  @account_relationships_service_stub. request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @account_relationships_service_stub, :list_account_relationships, "account_relationships", 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/accounts/v1/account_relationships_service/rest/client.rb', line 179

def logger
  @account_relationships_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

def universe_domain
  @account_relationships_service_stub.universe_domain
end

#update_account_relationship(request, options = nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::AccountRelationship #update_account_relationship(account_relationship: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Accounts::V1::AccountRelationship

Updates the account relationship. 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::AccountRelationshipsService::Rest::Client.new

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

# Call the update_account_relationship method.
result = client. request

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



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
348
349
 
# File 'lib/google/shopping/merchant/accounts/v1/account_relationships_service/rest/client.rb', line 316

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

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

  # 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

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