Class: Google::Shopping::Css::V1::AccountsService::Rest::Client

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

Overview

REST client for the AccountsService service.

Service for managing CSS/MC account information.

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 AccountsService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the AccountsService client.

Yield Parameters:



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
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 138

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

  @accounts_service_stub = ::Google::Shopping::Css::V1::AccountsService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

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

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
89
90
91
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 64

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.list_child_accounts.timeout = 60.0
    default_config.rpcs.list_child_accounts.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..retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_labels.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



108
109
110
111
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 108

def configure
  yield @config if block_given?
  @config
end

#get_account(request, options = nil) ⇒ ::Google::Shopping::Css::V1::Account #get_account(name: nil, parent: nil) ⇒ ::Google::Shopping::Css::V1::Account

Retrieves a single CSS/MC account by ID.

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

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

# Call the get_account method.
result = client. request

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

Overloads:

  • #get_account(request, options = nil) ⇒ ::Google::Shopping::Css::V1::Account

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

    Parameters:

    • request (::Google::Shopping::Css::V1::GetAccountRequest, ::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(name: nil, parent: nil) ⇒ ::Google::Shopping::Css::V1::Account

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

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

      Required. The name of the managed CSS/MC account. Format: accounts/{account}

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

      Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{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.



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
369
370
371
372
373
374
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 341

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

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

  # 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::Css::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

  @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_child_accounts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Css::V1::Account> #list_child_accounts(parent: nil, label_id: nil, full_name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Css::V1::Account>

Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.

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

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

# Call the list_child_accounts method.
result = client.list_child_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::Css::V1::Account.
  p item
end

Overloads:

  • #list_child_accounts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Css::V1::Account>

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

    Parameters:

    • request (::Google::Shopping::Css::V1::ListChildAccountsRequest, ::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_child_accounts(parent: nil, label_id: nil, full_name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Css::V1::Account>

    Pass arguments to list_child_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 parent account. Must be a CSS group or domain. Format: accounts/{account}

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

      If set, only the MC accounts with the given label ID will be returned.

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

      If set, only the MC accounts with the given name (case sensitive) will be returned.

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

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

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

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

      When paginating, all other parameters provided to ListChildAccounts 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.



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
284
285
286
287
288
289
290
291
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 256

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

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

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

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

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


185
186
187
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 185

def logger
  @accounts_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


118
119
120
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 118

def universe_domain
  @accounts_service_stub.universe_domain
end

#update_labels(request, options = nil) ⇒ ::Google::Shopping::Css::V1::Account #update_labels(name: nil, label_ids: nil, parent: nil) ⇒ ::Google::Shopping::Css::V1::Account

Updates labels assigned to CSS/MC accounts by a CSS domain.

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

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

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

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

Overloads:

  • #update_labels(request, options = nil) ⇒ ::Google::Shopping::Css::V1::Account

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

    Parameters:

    • request (::Google::Shopping::Css::V1::UpdateAccountLabelsRequest, ::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_labels(name: nil, label_ids: nil, parent: nil) ⇒ ::Google::Shopping::Css::V1::Account

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

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

      Required. The label resource name. Format: accounts/{account}

    • label_ids (::Array<::Integer>) (defaults to: nil) —

      The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.

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

      Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{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.



427
428
429
430
431
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
 
# File 'lib/google/shopping/css/v1/accounts_service/rest/client.rb', line 427

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

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

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

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

  @accounts_service_stub.update_labels 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