Class: Google::Shopping::Css::V1::AccountLabelsService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/css/v1/account_labels_service/client.rb

Overview

Client for the AccountLabelsService service.

Manages Merchant Center and CSS accounts labels.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_label_path, #account_path

Constructor Details

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

Create a new AccountLabelsService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Css::V1::AccountLabelsService::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Css::V1::AccountLabelsService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the AccountLabelsService 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
176
177
178
179
180
181
182
183
184
 
# File 'lib/google/shopping/css/v1/account_labels_service/client.rb', line 135

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/shopping/css/v1/accounts_labels_services_pb"

  # 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_labels_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Shopping::Css::V1::AccountLabelsService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @account_labels_service_stub.stub_logger&.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 AccountLabelsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all AccountLabelsService clients
::Google::Shopping::Css::V1::AccountLabelsService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
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/css/v1/account_labels_service/client.rb', line 62

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

    default_config.rpcs..timeout = 60.0

    default_config.rpcs..timeout = 60.0

    default_config.rpcs..timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the AccountLabelsService 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/css/v1/account_labels_service/client.rb', line 105

def configure
  yield @config if block_given?
  @config
end

#create_account_label(request, options = nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel #create_account_label(parent: nil, account_label: nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel

Creates a new label, not assigned to any account.

Examples:

Basic example

require "google/shopping/css/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Css::V1::AccountLabelsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Css::V1::CreateAccountLabelRequest.new

# Call the create_account_label method.
result = client. request

# The returned object is of type Google::Shopping::Css::V1::AccountLabel.
p result

Overloads:

  • #create_account_label(request, options = nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel

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

    Parameters:

    • request (::Google::Shopping::Css::V1::CreateAccountLabelRequest, ::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.

  • #create_account_label(parent: nil, account_label: nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel

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

    • account_label (::Google::Shopping::Css::V1::AccountLabel, ::Hash) (defaults to: nil) —

      Required. The label to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/google/shopping/css/v1/account_labels_service/client.rb', line 347

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Css::V1::CreateAccountLabelRequest

  # 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
  metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Css::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @account_labels_service_stub.call_rpc :create_account_label, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_account_label(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_account_label(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a label and removes it from all accounts to which it was assigned.

Examples:

Basic example

require "google/shopping/css/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Css::V1::AccountLabelsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Css::V1::DeleteAccountLabelRequest.new

# Call the delete_account_label method.
result = client. request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_account_label(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Shopping::Css::V1::DeleteAccountLabelRequest, ::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.

  • #delete_account_label(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_account_label 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 label to delete. Format: accounts/{account}/labels/{label}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/google/shopping/css/v1/account_labels_service/client.rb', line 518

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Css::V1::DeleteAccountLabelRequest

  # 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
  metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Css::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @account_labels_service_stub.call_rpc :delete_account_label, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_account_labels(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Css::V1::AccountLabel> #list_account_labels(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Css::V1::AccountLabel>

Lists the labels owned by an account.

Examples:

Basic example

require "google/shopping/css/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Css::V1::AccountLabelsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Css::V1::ListAccountLabelsRequest.new

# Call the list_account_labels 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::Css::V1::AccountLabel.
  p item
end

Overloads:

  • #list_account_labels(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Css::V1::AccountLabel>

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

    Parameters:

    • request (::Google::Shopping::Css::V1::ListAccountLabelsRequest, ::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_labels(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Css::V1::AccountLabel>

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

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

      The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

      A page token, received from a previous ListAccountLabels call. Provide this to retrieve the subsequent page.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/google/shopping/css/v1/account_labels_service/client.rb', line 257

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Css::V1::ListAccountLabelsRequest

  # 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
  metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Css::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @account_labels_service_stub.call_rpc :list_account_labels, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @account_labels_service_stub, :list_account_labels, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


191
192
193
 
# File 'lib/google/shopping/css/v1/account_labels_service/client.rb', line 191

def logger
  @account_labels_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


115
116
117
 
# File 'lib/google/shopping/css/v1/account_labels_service/client.rb', line 115

def universe_domain
  @account_labels_service_stub.universe_domain
end

#update_account_label(request, options = nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel #update_account_label(account_label: nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel

Updates a label.

Examples:

Basic example

require "google/shopping/css/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Css::V1::AccountLabelsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Css::V1::UpdateAccountLabelRequest.new

# Call the update_account_label method.
result = client. request

# The returned object is of type Google::Shopping::Css::V1::AccountLabel.
p result

Overloads:

  • #update_account_label(request, options = nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel

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

    Parameters:

    • request (::Google::Shopping::Css::V1::UpdateAccountLabelRequest, ::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.

  • #update_account_label(account_label: nil) ⇒ ::Google::Shopping::Css::V1::AccountLabel

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/google/shopping/css/v1/account_labels_service/client.rb', line 432

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Css::V1::UpdateAccountLabelRequest

  # 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
  metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Css::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.&.name
    header_params["account_label.name"] = request..name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @account_labels_service_stub.call_rpc :update_account_label, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end