google-shopping-merchant-accounts 0.a → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dd298933ec12483cd2afabcd73d4e599e570a664beffbbc7bc40ba0f294e3c99
4
- data.tar.gz: 163414e8817fa31bceaa012dbf83ceae9b6040aee7ff6c07a2a3f5e921621db4
3
+ metadata.gz: 5655f6afa1645feae472b634c8f10d17f34aed945587213ebb5f21ee9b0029ac
4
+ data.tar.gz: 50edcc4e7defef5af8033ad6e8629da9e3f962da240642adeff83b0b71447d46
5
5
  SHA512:
6
- metadata.gz: 0130aa73db9987a4da89562ed645b27fc70410b4eefa0b3e15fc6de85c35f7182747a4bcbb1a590fb07a98dba7c399659160d67d5112a319c065b6012ef38470
7
- data.tar.gz: a6f29db038bd171855986a537cac36fe70ce95818095fd4b25431545a6bdf6499a9fdb925b198bc9a1a20b1c6be5ee84e5f5ea51842d51dc2c8ed3b941341f44
6
+ metadata.gz: f7647e7493062ac671f2944177b3002be977a6f5d5b2e33795bd41b2629a5957268056bb05ed54a89b5d631afc7669f2a97ef094a38fbc9ecd9256e8e4c69ee0
7
+ data.tar.gz: 7a54afd791ce9baee2adeaa1b43e1be013bf0a3e9b165fc06b881825286ea0ad676bf71bc5aafde8dd54fb07c3afe2706c940d2d76c1d4a955c336fcaa4ca579
data/.yardopts ADDED
@@ -0,0 +1,11 @@
1
+ --no-private
2
+ --title="Merchant API"
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ -
9
+ README.md
10
+ AUTHENTICATION.md
11
+ LICENSE.md
data/AUTHENTICATION.md ADDED
@@ -0,0 +1,122 @@
1
+ # Authentication
2
+
3
+ The recommended way to authenticate to the google-shopping-merchant-accounts library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
6
+
7
+ ## Quickstart
8
+
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
11
+
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
14
+
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
17
+
18
+ ```sh
19
+ gcloud auth application-default login
20
+ ```
21
+
22
+ 3. Write code as if already authenticated.
23
+
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
26
+
27
+ ## Credential Lookup
28
+
29
+ The google-shopping-merchant-accounts library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
33
+
34
+ Credentials are accepted in the following ways, in the following order or precedence:
35
+
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
41
+
42
+ ### Configuration
43
+
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
49
+
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
53
+
54
+ To configure a credentials file for an individual client initialization:
55
+
56
+ ```ruby
57
+ require "google/shopping/merchant/accounts"
58
+
59
+ client = Google::Shopping::Merchant::Accounts.account_tax_service do |config|
60
+ config.credentials = "path/to/credentialfile.json"
61
+ end
62
+ ```
63
+
64
+ To configure a credentials file globally for all clients:
65
+
66
+ ```ruby
67
+ require "google/shopping/merchant/accounts"
68
+
69
+ Google::Shopping::Merchant::Accounts.configure do |config|
70
+ config.credentials = "path/to/credentialfile.json"
71
+ end
72
+
73
+ client = Google::Shopping::Merchant::Accounts.account_tax_service
74
+ ```
75
+
76
+ ### Environment Variables
77
+
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
82
+
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
87
+
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-shopping-merchant-accounts
93
+ checks for credentials are:
94
+
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
97
+
98
+ ```ruby
99
+ require "google/shopping/merchant/accounts"
100
+
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102
+
103
+ client = Google::Shopping::Merchant::Accounts.account_tax_service
104
+ ```
105
+
106
+ ### Local ADC file
107
+
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
111
+
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
113
+
114
+ ### Google Cloud Platform environments
115
+
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
120
+
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -1,8 +1,104 @@
1
- # Placeholder for Ruby gem google-shopping-merchant-accounts
2
-
3
- This is a placeholder for the future Google-authored gem google-shopping-merchant-accounts.
4
- This placeholder is being released on 2024-06-04 in order to reserve the name.
5
- The final gem should be available shortly after that date. If it has not been
6
- released in a timely manner, or if this placeholder interferes with your work,
7
- you can contact the Google Ruby team by opening an issue in the GitHub
8
- repository https://github.com/googleapis/google-cloud-ruby.
1
+ # Ruby Client for the Merchant API
2
+
3
+ Programmatically manage your Merchant Center accounts.
4
+
5
+ Programmatically manage your Merchant Center accounts.
6
+
7
+ Actual client classes for the various versions of this API are defined in
8
+ _versioned_ client gems, with names of the form `google-shopping-merchant-accounts-v*`.
9
+ The gem `google-shopping-merchant-accounts` is the main client library that brings the
10
+ verisoned gems in as dependencies, and provides high-level methods for
11
+ constructing clients. More information on versioned clients can be found below
12
+ in the section titled *Which client should I use?*.
13
+
14
+ View the [Client Library Documentation](https://rubydoc.info/gems/google-shopping-merchant-accounts)
15
+ for this library, google-shopping-merchant-accounts, to see the convenience methods for
16
+ constructing client objects. Reference documentation for the client objects
17
+ themselves can be found in the client library documentation for the versioned
18
+ client gems:
19
+ [google-shopping-merchant-accounts-v1beta](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta).
20
+
21
+ See also the [Product Documentation](https://developers.google.com/merchant/api)
22
+ for more usage information.
23
+
24
+ ## Quick Start
25
+
26
+ ```
27
+ $ gem install google-shopping-merchant-accounts
28
+ ```
29
+
30
+ In order to use this library, you first need to go through the following steps:
31
+
32
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
33
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
34
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/merchantapi.googleapis.com)
35
+ 1. {file:AUTHENTICATION.md Set up authentication.}
36
+
37
+ ## Supported Ruby Versions
38
+
39
+ This library is supported on Ruby 2.7+.
40
+
41
+ Google provides official support for Ruby versions that are actively supported
42
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
43
+ in security maintenance, and not end of life. Older versions of Ruby _may_
44
+ still work, but are unsupported and not recommended. See
45
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
46
+ support schedule.
47
+
48
+ ## Which client should I use?
49
+
50
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
51
+ client library with a name such as `google-shopping-merchant-accounts`,
52
+ and lower-level _versioned_ client libraries with names such as
53
+ `google-shopping-merchant-accounts-v1beta`.
54
+ _In most cases, you should install the main client._
55
+
56
+ ### What's the difference between the main client and a versioned client?
57
+
58
+ A _versioned client_ provides a basic set of data types and client classes for
59
+ a _single version_ of a specific service. (That is, for a service with multiple
60
+ versions, there might be a separate versioned client for each service version.)
61
+ Most versioned clients are written and maintained by a code generator.
62
+
63
+ The _main client_ is designed to provide you with the _recommended_ client
64
+ interfaces for the service. There will be only one main client for any given
65
+ service, even a service with multiple versions. The main client includes
66
+ factory methods for constructing the client objects we recommend for most
67
+ users. In some cases, those will be classes provided by an underlying versioned
68
+ client; in other cases, they will be handwritten higher-level client objects
69
+ with additional capabilities, convenience methods, or best practices built in.
70
+ Generally, the main client will default to a recommended service version,
71
+ although in some cases you can override this if you need to talk to a specific
72
+ service version.
73
+
74
+ ### Why would I want to use the main client?
75
+
76
+ We recommend that most users install the main client gem for a service. You can
77
+ identify this gem as the one _without_ a version in its name, e.g.
78
+ `google-shopping-merchant-accounts`.
79
+ The main client is recommended because it will embody the best practices for
80
+ accessing the service, and may also provide more convenient interfaces or
81
+ tighter integration into frameworks and third-party libraries. In addition, the
82
+ documentation and samples published by Google will generally demonstrate use of
83
+ the main client.
84
+
85
+ ### Why would I want to use a versioned client?
86
+
87
+ You can use a versioned client if you are content with a possibly lower-level
88
+ class interface, you explicitly want to avoid features provided by the main
89
+ client, or you want to access a specific service version not be covered by the
90
+ main client. You can identify versioned client gems because the service version
91
+ is part of the name, e.g. `google-shopping-merchant-accounts-v1beta`.
92
+
93
+ ### What about the google-apis-<name> clients?
94
+
95
+ Client library gems with names that begin with `google-apis-` are based on an
96
+ older code generation technology. They talk to a REST/JSON backend (whereas
97
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
98
+ not offer the same performance, features, and ease of use provided by more
99
+ modern clients.
100
+
101
+ The `google-apis-` clients have wide coverage across Google services, so you
102
+ might need to use one if there is no modern client available for the service.
103
+ However, if a modern client is available, we generally recommend it over the
104
+ older `google-apis-` clients.
@@ -1,10 +1,12 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Copyright 2024 Google LLC
2
4
  #
3
5
  # Licensed under the Apache License, Version 2.0 (the "License");
4
6
  # you may not use this file except in compliance with the License.
5
7
  # You may obtain a copy of the License at
6
8
  #
7
- # http://www.apache.org/licenses/LICENSE-2.0
9
+ # https://www.apache.org/licenses/LICENSE-2.0
8
10
  #
9
11
  # Unless required by applicable law or agreed to in writing, software
10
12
  # distributed under the License is distributed on an "AS IS" BASIS,
@@ -12,11 +14,14 @@
12
14
  # See the License for the specific language governing permissions and
13
15
  # limitations under the License.
14
16
 
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
15
20
  module Google
16
21
  module Shopping
17
22
  module Merchant
18
23
  module Accounts
19
- VERSION = "0.a"
24
+ VERSION = "0.1.0"
20
25
  end
21
26
  end
22
27
  end
@@ -0,0 +1,539 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # Require this file early so that the version constant gets defined before
20
+ # requiring "google/cloud". This is because google-cloud-core will load the
21
+ # entrypoint (gem name) file, which in turn re-requires this file (hence
22
+ # causing a require cycle) unless the version constant is already defined.
23
+ require "google/shopping/merchant/accounts/version"
24
+
25
+ require "googleauth"
26
+
27
+ module Google
28
+ module Shopping
29
+ module Merchant
30
+ module Accounts
31
+ ##
32
+ # Create a new client object for AccountTaxService.
33
+ #
34
+ # By default, this returns an instance of
35
+ # [Google::Shopping::Merchant::Accounts::V1beta::AccountTaxService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/AccountTaxService/Client)
36
+ # for a gRPC client for version V1beta of the API.
37
+ # However, you can specify a different API version by passing it in the
38
+ # `version` parameter. If the AccountTaxService service is
39
+ # supported by that API version, and the corresponding gem is available, the
40
+ # appropriate versioned client will be returned.
41
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
42
+ # the `transport` parameter.
43
+ #
44
+ # ## About AccountTaxService
45
+ #
46
+ # Manages account level tax setting data.
47
+ #
48
+ # This API defines the following resource model:
49
+ #
50
+ # - [AccountTax][google.shopping.merchant.accounts.v1main.AccountTax]
51
+ #
52
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
53
+ # Defaults to `:v1beta`.
54
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
55
+ # @return [::Object] A client object for the specified version.
56
+ #
57
+ def self.account_tax_service version: :v1beta, transport: :grpc, &block
58
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
59
+
60
+ package_name = Google::Shopping::Merchant::Accounts
61
+ .constants
62
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
63
+ .first
64
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:AccountTaxService)
65
+ service_module = service_module.const_get(:Rest) if transport == :rest
66
+ service_module.const_get(:Client).new(&block)
67
+ end
68
+
69
+ ##
70
+ # Create a new client object for AccountIssueService.
71
+ #
72
+ # By default, this returns an instance of
73
+ # [Google::Shopping::Merchant::Accounts::V1beta::AccountIssueService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/AccountIssueService/Client)
74
+ # for a gRPC client for version V1beta of the API.
75
+ # However, you can specify a different API version by passing it in the
76
+ # `version` parameter. If the AccountIssueService service is
77
+ # supported by that API version, and the corresponding gem is available, the
78
+ # appropriate versioned client will be returned.
79
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
80
+ # the `transport` parameter.
81
+ #
82
+ # ## About AccountIssueService
83
+ #
84
+ # Service to support `AccountIssueService` API.
85
+ #
86
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
87
+ # Defaults to `:v1beta`.
88
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
89
+ # @return [::Object] A client object for the specified version.
90
+ #
91
+ def self.account_issue_service version: :v1beta, transport: :grpc, &block
92
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
93
+
94
+ package_name = Google::Shopping::Merchant::Accounts
95
+ .constants
96
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
97
+ .first
98
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:AccountIssueService)
99
+ service_module = service_module.const_get(:Rest) if transport == :rest
100
+ service_module.const_get(:Client).new(&block)
101
+ end
102
+
103
+ ##
104
+ # Create a new client object for UserService.
105
+ #
106
+ # By default, this returns an instance of
107
+ # [Google::Shopping::Merchant::Accounts::V1beta::UserService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/UserService/Client)
108
+ # for a gRPC client for version V1beta of the API.
109
+ # However, you can specify a different API version by passing it in the
110
+ # `version` parameter. If the UserService service is
111
+ # supported by that API version, and the corresponding gem is available, the
112
+ # appropriate versioned client will be returned.
113
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
114
+ # the `transport` parameter.
115
+ #
116
+ # ## About UserService
117
+ #
118
+ # Service to support user API.
119
+ #
120
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
121
+ # Defaults to `:v1beta`.
122
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
123
+ # @return [::Object] A client object for the specified version.
124
+ #
125
+ def self.user_service version: :v1beta, transport: :grpc, &block
126
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
127
+
128
+ package_name = Google::Shopping::Merchant::Accounts
129
+ .constants
130
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
131
+ .first
132
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:UserService)
133
+ service_module = service_module.const_get(:Rest) if transport == :rest
134
+ service_module.const_get(:Client).new(&block)
135
+ end
136
+
137
+ ##
138
+ # Create a new client object for AccountsService.
139
+ #
140
+ # By default, this returns an instance of
141
+ # [Google::Shopping::Merchant::Accounts::V1beta::AccountsService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/AccountsService/Client)
142
+ # for a gRPC client for version V1beta of the API.
143
+ # However, you can specify a different API version by passing it in the
144
+ # `version` parameter. If the AccountsService service is
145
+ # supported by that API version, and the corresponding gem is available, the
146
+ # appropriate versioned client will be returned.
147
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
148
+ # the `transport` parameter.
149
+ #
150
+ # ## About AccountsService
151
+ #
152
+ # Service to support Accounts API.
153
+ #
154
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
155
+ # Defaults to `:v1beta`.
156
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
157
+ # @return [::Object] A client object for the specified version.
158
+ #
159
+ def self.accounts_service version: :v1beta, transport: :grpc, &block
160
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
161
+
162
+ package_name = Google::Shopping::Merchant::Accounts
163
+ .constants
164
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
165
+ .first
166
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:AccountsService)
167
+ service_module = service_module.const_get(:Rest) if transport == :rest
168
+ service_module.const_get(:Client).new(&block)
169
+ end
170
+
171
+ ##
172
+ # Create a new client object for BusinessIdentityService.
173
+ #
174
+ # By default, this returns an instance of
175
+ # [Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentityService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/BusinessIdentityService/Client)
176
+ # for a gRPC client for version V1beta of the API.
177
+ # However, you can specify a different API version by passing it in the
178
+ # `version` parameter. If the BusinessIdentityService service is
179
+ # supported by that API version, and the corresponding gem is available, the
180
+ # appropriate versioned client will be returned.
181
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
182
+ # the `transport` parameter.
183
+ #
184
+ # ## About BusinessIdentityService
185
+ #
186
+ # Service to support [business
187
+ # identity](https://support.google.com/merchants/answer/12564247) API.
188
+ #
189
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
190
+ # Defaults to `:v1beta`.
191
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
192
+ # @return [::Object] A client object for the specified version.
193
+ #
194
+ def self.business_identity_service version: :v1beta, transport: :grpc, &block
195
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
196
+
197
+ package_name = Google::Shopping::Merchant::Accounts
198
+ .constants
199
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
200
+ .first
201
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:BusinessIdentityService)
202
+ service_module = service_module.const_get(:Rest) if transport == :rest
203
+ service_module.const_get(:Client).new(&block)
204
+ end
205
+
206
+ ##
207
+ # Create a new client object for BusinessInfoService.
208
+ #
209
+ # By default, this returns an instance of
210
+ # [Google::Shopping::Merchant::Accounts::V1beta::BusinessInfoService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/BusinessInfoService/Client)
211
+ # for a gRPC client for version V1beta of the API.
212
+ # However, you can specify a different API version by passing it in the
213
+ # `version` parameter. If the BusinessInfoService service is
214
+ # supported by that API version, and the corresponding gem is available, the
215
+ # appropriate versioned client will be returned.
216
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
217
+ # the `transport` parameter.
218
+ #
219
+ # ## About BusinessInfoService
220
+ #
221
+ # Service to support business info API.
222
+ #
223
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
224
+ # Defaults to `:v1beta`.
225
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
226
+ # @return [::Object] A client object for the specified version.
227
+ #
228
+ def self.business_info_service version: :v1beta, transport: :grpc, &block
229
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
230
+
231
+ package_name = Google::Shopping::Merchant::Accounts
232
+ .constants
233
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
234
+ .first
235
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:BusinessInfoService)
236
+ service_module = service_module.const_get(:Rest) if transport == :rest
237
+ service_module.const_get(:Client).new(&block)
238
+ end
239
+
240
+ ##
241
+ # Create a new client object for EmailPreferencesService.
242
+ #
243
+ # By default, this returns an instance of
244
+ # [Google::Shopping::Merchant::Accounts::V1beta::EmailPreferencesService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/EmailPreferencesService/Client)
245
+ # for a gRPC client for version V1beta of the API.
246
+ # However, you can specify a different API version by passing it in the
247
+ # `version` parameter. If the EmailPreferencesService service is
248
+ # supported by that API version, and the corresponding gem is available, the
249
+ # appropriate versioned client will be returned.
250
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
251
+ # the `transport` parameter.
252
+ #
253
+ # ## About EmailPreferencesService
254
+ #
255
+ # Service to support the `EmailPreferences` API.
256
+ #
257
+ # This service only permits retrieving and updating email preferences for the
258
+ # authenticated user.
259
+ #
260
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
261
+ # Defaults to `:v1beta`.
262
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
263
+ # @return [::Object] A client object for the specified version.
264
+ #
265
+ def self.email_preferences_service version: :v1beta, transport: :grpc, &block
266
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
267
+
268
+ package_name = Google::Shopping::Merchant::Accounts
269
+ .constants
270
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
271
+ .first
272
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:EmailPreferencesService)
273
+ service_module = service_module.const_get(:Rest) if transport == :rest
274
+ service_module.const_get(:Client).new(&block)
275
+ end
276
+
277
+ ##
278
+ # Create a new client object for HomepageService.
279
+ #
280
+ # By default, this returns an instance of
281
+ # [Google::Shopping::Merchant::Accounts::V1beta::HomepageService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/HomepageService/Client)
282
+ # for a gRPC client for version V1beta of the API.
283
+ # However, you can specify a different API version by passing it in the
284
+ # `version` parameter. If the HomepageService service is
285
+ # supported by that API version, and the corresponding gem is available, the
286
+ # appropriate versioned client will be returned.
287
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
288
+ # the `transport` parameter.
289
+ #
290
+ # ## About HomepageService
291
+ #
292
+ # Service to support an API for a store's homepage.
293
+ #
294
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
295
+ # Defaults to `:v1beta`.
296
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
297
+ # @return [::Object] A client object for the specified version.
298
+ #
299
+ def self.homepage_service version: :v1beta, transport: :grpc, &block
300
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
301
+
302
+ package_name = Google::Shopping::Merchant::Accounts
303
+ .constants
304
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
305
+ .first
306
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:HomepageService)
307
+ service_module = service_module.const_get(:Rest) if transport == :rest
308
+ service_module.const_get(:Client).new(&block)
309
+ end
310
+
311
+ ##
312
+ # Create a new client object for OnlineReturnPolicyService.
313
+ #
314
+ # By default, this returns an instance of
315
+ # [Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicyService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/OnlineReturnPolicyService/Client)
316
+ # for a gRPC client for version V1beta of the API.
317
+ # However, you can specify a different API version by passing it in the
318
+ # `version` parameter. If the OnlineReturnPolicyService service is
319
+ # supported by that API version, and the corresponding gem is available, the
320
+ # appropriate versioned client will be returned.
321
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
322
+ # the `transport` parameter.
323
+ #
324
+ # ## About OnlineReturnPolicyService
325
+ #
326
+ # The service facilitates the management of a merchant's remorse return policy
327
+ # configuration, encompassing return policies for both ads and free listings
328
+ # ## programs. This API defines the following resource model:
329
+ #
330
+ # [OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]
331
+ #
332
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
333
+ # Defaults to `:v1beta`.
334
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
335
+ # @return [::Object] A client object for the specified version.
336
+ #
337
+ def self.online_return_policy_service version: :v1beta, transport: :grpc, &block
338
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
339
+
340
+ package_name = Google::Shopping::Merchant::Accounts
341
+ .constants
342
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
343
+ .first
344
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:OnlineReturnPolicyService)
345
+ service_module = service_module.const_get(:Rest) if transport == :rest
346
+ service_module.const_get(:Client).new(&block)
347
+ end
348
+
349
+ ##
350
+ # Create a new client object for ProgramsService.
351
+ #
352
+ # By default, this returns an instance of
353
+ # [Google::Shopping::Merchant::Accounts::V1beta::ProgramsService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/ProgramsService/Client)
354
+ # for a gRPC client for version V1beta of the API.
355
+ # However, you can specify a different API version by passing it in the
356
+ # `version` parameter. If the ProgramsService service is
357
+ # supported by that API version, and the corresponding gem is available, the
358
+ # appropriate versioned client will be returned.
359
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
360
+ # the `transport` parameter.
361
+ #
362
+ # ## About ProgramsService
363
+ #
364
+ # Service for program management.
365
+ #
366
+ # Programs provide a mechanism for adding functionality to merchant accounts. A
367
+ # typical example of this is the [Free product
368
+ # listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU)
369
+ # program, which enables products from a merchant's store to be shown across
370
+ # Google for free.
371
+ #
372
+ # This service exposes methods to retrieve a merchant's
373
+ # participation in all available programs, in addition to methods for
374
+ # explicitly enabling or disabling participation in each program.
375
+ #
376
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
377
+ # Defaults to `:v1beta`.
378
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
379
+ # @return [::Object] A client object for the specified version.
380
+ #
381
+ def self.programs_service version: :v1beta, transport: :grpc, &block
382
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
383
+
384
+ package_name = Google::Shopping::Merchant::Accounts
385
+ .constants
386
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
387
+ .first
388
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:ProgramsService)
389
+ service_module = service_module.const_get(:Rest) if transport == :rest
390
+ service_module.const_get(:Client).new(&block)
391
+ end
392
+
393
+ ##
394
+ # Create a new client object for RegionsService.
395
+ #
396
+ # By default, this returns an instance of
397
+ # [Google::Shopping::Merchant::Accounts::V1beta::RegionsService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/RegionsService/Client)
398
+ # for a gRPC client for version V1beta of the API.
399
+ # However, you can specify a different API version by passing it in the
400
+ # `version` parameter. If the RegionsService service is
401
+ # supported by that API version, and the corresponding gem is available, the
402
+ # appropriate versioned client will be returned.
403
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
404
+ # the `transport` parameter.
405
+ #
406
+ # ## About RegionsService
407
+ #
408
+ # Manages regions configuration.
409
+ #
410
+ # This API defines the following resource model:
411
+ #
412
+ # - [Region][google.shopping.merchant.accounts.v1main.Region]
413
+ #
414
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
415
+ # Defaults to `:v1beta`.
416
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
417
+ # @return [::Object] A client object for the specified version.
418
+ #
419
+ def self.regions_service version: :v1beta, transport: :grpc, &block
420
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
421
+
422
+ package_name = Google::Shopping::Merchant::Accounts
423
+ .constants
424
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
425
+ .first
426
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:RegionsService)
427
+ service_module = service_module.const_get(:Rest) if transport == :rest
428
+ service_module.const_get(:Client).new(&block)
429
+ end
430
+
431
+ ##
432
+ # Create a new client object for ShippingSettingsService.
433
+ #
434
+ # By default, this returns an instance of
435
+ # [Google::Shopping::Merchant::Accounts::V1beta::ShippingSettingsService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/ShippingSettingsService/Client)
436
+ # for a gRPC client for version V1beta of the API.
437
+ # However, you can specify a different API version by passing it in the
438
+ # `version` parameter. If the ShippingSettingsService service is
439
+ # supported by that API version, and the corresponding gem is available, the
440
+ # appropriate versioned client will be returned.
441
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
442
+ # the `transport` parameter.
443
+ #
444
+ # ## About ShippingSettingsService
445
+ #
446
+ # Service to get method call shipping setting information per Merchant API
447
+ # method.
448
+ #
449
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
450
+ # Defaults to `:v1beta`.
451
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
452
+ # @return [::Object] A client object for the specified version.
453
+ #
454
+ def self.shipping_settings_service version: :v1beta, transport: :grpc, &block
455
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
456
+
457
+ package_name = Google::Shopping::Merchant::Accounts
458
+ .constants
459
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
460
+ .first
461
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:ShippingSettingsService)
462
+ service_module = service_module.const_get(:Rest) if transport == :rest
463
+ service_module.const_get(:Client).new(&block)
464
+ end
465
+
466
+ ##
467
+ # Create a new client object for TermsOfServiceService.
468
+ #
469
+ # By default, this returns an instance of
470
+ # [Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/TermsOfServiceService/Client)
471
+ # for a gRPC client for version V1beta of the API.
472
+ # However, you can specify a different API version by passing it in the
473
+ # `version` parameter. If the TermsOfServiceService service is
474
+ # supported by that API version, and the corresponding gem is available, the
475
+ # appropriate versioned client will be returned.
476
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
477
+ # the `transport` parameter.
478
+ #
479
+ # ## About TermsOfServiceService
480
+ #
481
+ # Service to support `TermsOfService` API.
482
+ #
483
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
484
+ # Defaults to `:v1beta`.
485
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
486
+ # @return [::Object] A client object for the specified version.
487
+ #
488
+ def self.terms_of_service_service version: :v1beta, transport: :grpc, &block
489
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
490
+
491
+ package_name = Google::Shopping::Merchant::Accounts
492
+ .constants
493
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
494
+ .first
495
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:TermsOfServiceService)
496
+ service_module = service_module.const_get(:Rest) if transport == :rest
497
+ service_module.const_get(:Client).new(&block)
498
+ end
499
+
500
+ ##
501
+ # Create a new client object for TermsOfServiceAgreementStateService.
502
+ #
503
+ # By default, this returns an instance of
504
+ # [Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceAgreementStateService::Client](https://rubydoc.info/gems/google-shopping-merchant-accounts-v1beta/Google/Shopping/Merchant/Accounts/V1beta/TermsOfServiceAgreementStateService/Client)
505
+ # for a gRPC client for version V1beta of the API.
506
+ # However, you can specify a different API version by passing it in the
507
+ # `version` parameter. If the TermsOfServiceAgreementStateService service is
508
+ # supported by that API version, and the corresponding gem is available, the
509
+ # appropriate versioned client will be returned.
510
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
511
+ # the `transport` parameter.
512
+ #
513
+ # ## About TermsOfServiceAgreementStateService
514
+ #
515
+ # Service to support `TermsOfServiceAgreementState` API.
516
+ #
517
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
518
+ # Defaults to `:v1beta`.
519
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
520
+ # @return [::Object] A client object for the specified version.
521
+ #
522
+ def self.terms_of_service_agreement_state_service version: :v1beta, transport: :grpc, &block
523
+ require "google/shopping/merchant/accounts/#{version.to_s.downcase}"
524
+
525
+ package_name = Google::Shopping::Merchant::Accounts
526
+ .constants
527
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
528
+ .first
529
+ service_module = Google::Shopping::Merchant::Accounts.const_get(package_name).const_get(:TermsOfServiceAgreementStateService)
530
+ service_module = service_module.const_get(:Rest) if transport == :rest
531
+ service_module.const_get(:Client).new(&block)
532
+ end
533
+ end
534
+ end
535
+ end
536
+ end
537
+
538
+ helper_path = ::File.join __dir__, "accounts", "helpers.rb"
539
+ require "google/shopping/merchant/accounts/helpers" if ::File.file? helper_path
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/shopping/merchant/accounts" unless defined? Google::Shopping::Merchant::Accounts::VERSION
metadata CHANGED
@@ -1,27 +1,61 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-shopping-merchant-accounts
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.a
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-06-04 00:00:00.000000000 Z
12
- dependencies: []
13
- description: Placeholder for the future Google-authored gem google-shopping-merchant-accounts.
14
- This placeholder is being released on 2024-06-04 in order to reserve the name. The
15
- final gem should be available shortly after that date. If it has not been released
16
- in a timely manner, or if this placeholder interferes with your work, you can contact
17
- the Google Ruby team by opening an issue in the GitHub repository https://github.com/googleapis/google-cloud-ruby.
11
+ date: 2024-06-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-cloud-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.6'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: google-shopping-merchant-accounts-v1beta
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0.0'
34
+ - - "<"
35
+ - !ruby/object:Gem::Version
36
+ version: 2.a
37
+ type: :runtime
38
+ prerelease: false
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: '0.0'
44
+ - - "<"
45
+ - !ruby/object:Gem::Version
46
+ version: 2.a
47
+ description: Programmatically manage your Merchant Center accounts.
18
48
  email: googleapis-packages@google.com
19
49
  executables: []
20
50
  extensions: []
21
51
  extra_rdoc_files: []
22
52
  files:
53
+ - ".yardopts"
54
+ - AUTHENTICATION.md
23
55
  - LICENSE.md
24
56
  - README.md
57
+ - lib/google-shopping-merchant-accounts.rb
58
+ - lib/google/shopping/merchant/accounts.rb
25
59
  - lib/google/shopping/merchant/accounts/version.rb
26
60
  homepage: https://github.com/googleapis/google-cloud-ruby
27
61
  licenses:
@@ -35,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
35
69
  requirements:
36
70
  - - ">="
37
71
  - !ruby/object:Gem::Version
38
- version: '3.0'
72
+ version: '2.7'
39
73
  required_rubygems_version: !ruby/object:Gem::Requirement
40
74
  requirements:
41
75
  - - ">="
@@ -45,5 +79,5 @@ requirements: []
45
79
  rubygems_version: 3.5.6
46
80
  signing_key:
47
81
  specification_version: 4
48
- summary: Placeholder for the future Google-authored gem google-shopping-merchant-accounts
82
+ summary: Programmatically manage your Merchant Center accounts.
49
83
  test_files: []