Module: Google::Shopping::Merchant::Accounts

Defined in:
lib/google/shopping/merchant/accounts.rb,
lib/google/shopping/merchant/accounts/version.rb

Constant Summary collapse

VERSION =
"0.2.0"

Class Method Summary collapse

Class Method Details

.account_issue_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AccountIssueService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::AccountIssueService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the AccountIssueService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About AccountIssueService

Service to support AccountIssueService API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



91
92
93
94
95
96
97
98
99
100
101
# File 'lib/google/shopping/merchant/accounts.rb', line 91

def self. version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:AccountIssueService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.account_tax_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AccountTaxService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::AccountTaxService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the AccountTaxService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About AccountTaxService

Manages account level tax setting data.

This API defines the following resource model:

  • [AccountTax][google.shopping.merchant.accounts.v1main.AccountTax]

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



57
58
59
60
61
62
63
64
65
66
67
# File 'lib/google/shopping/merchant/accounts.rb', line 57

def self. version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:AccountTaxService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.accounts_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AccountsService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::AccountsService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the AccountsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About AccountsService

Service to support Accounts API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



159
160
161
162
163
164
165
166
167
168
169
# File 'lib/google/shopping/merchant/accounts.rb', line 159

def self.accounts_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:AccountsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.autofeed_settings_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AutofeedSettingsService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::AutofeedSettingsService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the AutofeedSettingsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About AutofeedSettingsService

Service to support autofeed setting.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



194
195
196
197
198
199
200
201
202
203
204
# File 'lib/google/shopping/merchant/accounts.rb', line 194

def self.autofeed_settings_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:AutofeedSettingsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.business_identity_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for BusinessIdentityService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentityService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the BusinessIdentityService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About BusinessIdentityService

Service to support business identity API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



229
230
231
232
233
234
235
236
237
238
239
# File 'lib/google/shopping/merchant/accounts.rb', line 229

def self.business_identity_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:BusinessIdentityService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.business_info_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for BusinessInfoService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::BusinessInfoService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the BusinessInfoService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About BusinessInfoService

Service to support business info API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



263
264
265
266
267
268
269
270
271
272
273
# File 'lib/google/shopping/merchant/accounts.rb', line 263

def self.business_info_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:BusinessInfoService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.email_preferences_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for EmailPreferencesService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::EmailPreferencesService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the EmailPreferencesService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About EmailPreferencesService

Service to support the EmailPreferences API.

This service only permits retrieving and updating email preferences for the authenticated user.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



300
301
302
303
304
305
306
307
308
309
310
# File 'lib/google/shopping/merchant/accounts.rb', line 300

def self.email_preferences_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:EmailPreferencesService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.homepage_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for HomepageService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::HomepageService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the HomepageService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About HomepageService

Service to support an API for a store's homepage.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



334
335
336
337
338
339
340
341
342
343
344
# File 'lib/google/shopping/merchant/accounts.rb', line 334

def self.homepage_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:HomepageService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.online_return_policy_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for OnlineReturnPolicyService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicyService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the OnlineReturnPolicyService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About OnlineReturnPolicyService

The service facilitates the management of a merchant's remorse return policy configuration, encompassing return policies for both ads and free listings

programs. This API defines the following resource model:

[OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



372
373
374
375
376
377
378
379
380
381
382
# File 'lib/google/shopping/merchant/accounts.rb', line 372

def self.online_return_policy_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:OnlineReturnPolicyService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.programs_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ProgramsService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::ProgramsService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the ProgramsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ProgramsService

Service for program management.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.

This service exposes methods to retrieve a merchant's participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



416
417
418
419
420
421
422
423
424
425
426
# File 'lib/google/shopping/merchant/accounts.rb', line 416

def self.programs_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:ProgramsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.regions_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for RegionsService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the RegionsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About RegionsService

Manages regions configuration.

This API defines the following resource model:

  • [Region][google.shopping.merchant.accounts.v1main.Region]

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



454
455
456
457
458
459
460
461
462
463
464
# File 'lib/google/shopping/merchant/accounts.rb', line 454

def self.regions_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:RegionsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.shipping_settings_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for ShippingSettingsService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::ShippingSettingsService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the ShippingSettingsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ShippingSettingsService

Service to get method call shipping setting information per Merchant API method.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



489
490
491
492
493
494
495
496
497
498
499
# File 'lib/google/shopping/merchant/accounts.rb', line 489

def self.shipping_settings_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:ShippingSettingsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.terms_of_service_agreement_state_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for TermsOfServiceAgreementStateService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceAgreementStateService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the TermsOfServiceAgreementStateService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About TermsOfServiceAgreementStateService

Service to support TermsOfServiceAgreementState API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



557
558
559
560
561
562
563
564
565
566
567
# File 'lib/google/shopping/merchant/accounts.rb', line 557

def self.terms_of_service_agreement_state_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:TermsOfServiceAgreementStateService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.terms_of_service_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for TermsOfServiceService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the TermsOfServiceService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About TermsOfServiceService

Service to support TermsOfService API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



523
524
525
526
527
528
529
530
531
532
533
# File 'lib/google/shopping/merchant/accounts.rb', line 523

def self.terms_of_service_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:TermsOfServiceService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.user_service(version: :v1beta, transport: :grpc, &block) ⇒ ::Object

Create a new client object for UserService.

By default, this returns an instance of Google::Shopping::Merchant::Accounts::V1beta::UserService::Client for a gRPC client for version V1beta of the API. However, you can specify a different API version by passing it in the version parameter. If the UserService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About UserService

Service to support user API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1beta)

    The API version to connect to. Optional. Defaults to :v1beta.

  • transport (:grpc, :rest) (defaults to: :grpc)

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object)

    A client object for the specified version.



125
126
127
128
129
130
131
132
133
134
135
# File 'lib/google/shopping/merchant/accounts.rb', line 125

def self.user_service version: :v1beta, transport: :grpc, &block
  require "google/shopping/merchant/accounts/#{version.to_s.downcase}"

  package_name = Google::Shopping::Merchant::Accounts
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:UserService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end