google-shopping-merchant-lfp 0.a → 0.2.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: 1741422996a84435927f87a1a5a2573092cdba015be6008889d4a1734f8f01a6
4
- data.tar.gz: 6d258c0a530687264ed7670dc9825091e2a3d073b738eff8733697f9c6258583
3
+ metadata.gz: 89f331f6c89e9aaccf5db957faf6209bfbabe17047f38a3762ad383f32a13629
4
+ data.tar.gz: 5d5e0f65c1083ca6980d8aa6119e0d90f862e3fffc4d2912499a3ce89fcc3588
5
5
  SHA512:
6
- metadata.gz: c345caaf365c36988447db19ade9f1d56c00de22654e78ffb9f7dd43f7d79f633a9b4513ac46a11bb8a08c4b54f20ab9dec2b943cf31be527fd6875fdce90a4b
7
- data.tar.gz: 6b5717176c9cb05647215618f0016bb175d39f93d4a11fcb29331337e215302b1c0dc381bd30ab5168c402e38b677ea6c80cdb3e697702733cd8b43a60a02e32
6
+ metadata.gz: 35f192b85c8e524600f79e7816ec846a4892f41d357bb3017ebc4b7d98d6ab5547a49dda1649c1037cb6c7263727a9ec16baae8483e2e4f5850f7482c9067d44
7
+ data.tar.gz: f8c6e1be234372bd5b215369102004d30c5fd6b45301dfee0d106c96dfe498217f9393ca7cfda0b6c2837a436a9315ecaeee0599d39e094a39cdd4bf8fdff198
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-lfp 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-lfp 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/lfp"
58
+
59
+ client = Google::Shopping::Merchant::Lfp.lfp_inventory_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/lfp"
68
+
69
+ Google::Shopping::Merchant::Lfp.configure do |config|
70
+ config.credentials = "path/to/credentialfile.json"
71
+ end
72
+
73
+ client = Google::Shopping::Merchant::Lfp.lfp_inventory_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-lfp
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/lfp"
100
+
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102
+
103
+ client = Google::Shopping::Merchant::Lfp.lfp_inventory_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,133 @@
1
- # Placeholder for Ruby gem google-shopping-merchant-lfp
2
-
3
- This is a placeholder for the future Google-authored gem google-shopping-merchant-lfp.
4
- This placeholder is being released on 2024-04-23 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
+
6
+ Actual client classes for the various versions of this API are defined in
7
+ _versioned_ client gems, with names of the form `google-shopping-merchant-lfp-v*`.
8
+ The gem `google-shopping-merchant-lfp` is the main client library that brings the
9
+ verisoned gems in as dependencies, and provides high-level methods for
10
+ constructing clients. More information on versioned clients can be found below
11
+ in the section titled *Which client should I use?*.
12
+
13
+ View the [Client Library Documentation](https://rubydoc.info/gems/google-shopping-merchant-lfp)
14
+ for this library, google-shopping-merchant-lfp, to see the convenience methods for
15
+ constructing client objects. Reference documentation for the client objects
16
+ themselves can be found in the client library documentation for the versioned
17
+ client gems:
18
+ [google-shopping-merchant-lfp-v1beta](https://rubydoc.info/gems/google-shopping-merchant-lfp-v1beta).
19
+
20
+ See also the [Product Documentation](https://developers.google.com/merchant/api)
21
+ for more usage information.
22
+
23
+ ## Quick Start
24
+
25
+ ```
26
+ $ gem install google-shopping-merchant-lfp
27
+ ```
28
+
29
+ In order to use this library, you first need to go through the following steps:
30
+
31
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
32
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
33
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/merchantapi.googleapis.com)
34
+ 1. {file:AUTHENTICATION.md Set up authentication.}
35
+
36
+ ## Debug Logging
37
+
38
+ This library comes with opt-in Debug Logging that can help you troubleshoot
39
+ your application's integration with the API. When logging is activated, key
40
+ events such as requests and responses, along with data payloads and metadata
41
+ such as headers and client configuration, are logged to the standard error
42
+ stream.
43
+
44
+ **WARNING:** Client Library Debug Logging includes your data payloads in
45
+ plaintext, which could include sensitive data such as PII for yourself or your
46
+ customers, private keys, or other security data that could be compromising if
47
+ leaked. Always practice good data hygiene with your application logs, and follow
48
+ the principle of least access. Google also recommends that Client Library Debug
49
+ Logging be enabled only temporarily during active debugging, and not used
50
+ permanently in production.
51
+
52
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
53
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
54
+ list of client library gem names. This will select the default logging behavior,
55
+ which writes logs to the standard error stream. On a local workstation, this may
56
+ result in logs appearing on the console. When running on a Google Cloud hosting
57
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
58
+ results in logs appearing alongside your application logs in the
59
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
60
+
61
+ Debug logging also requires that the versioned clients for this service be
62
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
63
+ working, try updating the versioned clients in your bundle or installed gems:
64
+ [google-shopping-merchant-lfp-v1beta](https://rubydoc.info/gems/google-shopping-merchant-lfp-v1beta).
65
+
66
+ ## Supported Ruby Versions
67
+
68
+ This library is supported on Ruby 3.0+.
69
+
70
+ Google provides official support for Ruby versions that are actively supported
71
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
72
+ in security maintenance, and not end of life. Older versions of Ruby _may_
73
+ still work, but are unsupported and not recommended. See
74
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
75
+ support schedule.
76
+
77
+ ## Which client should I use?
78
+
79
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
80
+ client library with a name such as `google-shopping-merchant-lfp`,
81
+ and lower-level _versioned_ client libraries with names such as
82
+ `google-shopping-merchant-lfp-v1beta`.
83
+ _In most cases, you should install the main client._
84
+
85
+ ### What's the difference between the main client and a versioned client?
86
+
87
+ A _versioned client_ provides a basic set of data types and client classes for
88
+ a _single version_ of a specific service. (That is, for a service with multiple
89
+ versions, there might be a separate versioned client for each service version.)
90
+ Most versioned clients are written and maintained by a code generator.
91
+
92
+ The _main client_ is designed to provide you with the _recommended_ client
93
+ interfaces for the service. There will be only one main client for any given
94
+ service, even a service with multiple versions. The main client includes
95
+ factory methods for constructing the client objects we recommend for most
96
+ users. In some cases, those will be classes provided by an underlying versioned
97
+ client; in other cases, they will be handwritten higher-level client objects
98
+ with additional capabilities, convenience methods, or best practices built in.
99
+ Generally, the main client will default to a recommended service version,
100
+ although in some cases you can override this if you need to talk to a specific
101
+ service version.
102
+
103
+ ### Why would I want to use the main client?
104
+
105
+ We recommend that most users install the main client gem for a service. You can
106
+ identify this gem as the one _without_ a version in its name, e.g.
107
+ `google-shopping-merchant-lfp`.
108
+ The main client is recommended because it will embody the best practices for
109
+ accessing the service, and may also provide more convenient interfaces or
110
+ tighter integration into frameworks and third-party libraries. In addition, the
111
+ documentation and samples published by Google will generally demonstrate use of
112
+ the main client.
113
+
114
+ ### Why would I want to use a versioned client?
115
+
116
+ You can use a versioned client if you are content with a possibly lower-level
117
+ class interface, you explicitly want to avoid features provided by the main
118
+ client, or you want to access a specific service version not be covered by the
119
+ main client. You can identify versioned client gems because the service version
120
+ is part of the name, e.g. `google-shopping-merchant-lfp-v1beta`.
121
+
122
+ ### What about the google-apis-<name> clients?
123
+
124
+ Client library gems with names that begin with `google-apis-` are based on an
125
+ older code generation technology. They talk to a REST/JSON backend (whereas
126
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
127
+ not offer the same performance, features, and ease of use provided by more
128
+ modern clients.
129
+
130
+ The `google-apis-` clients have wide coverage across Google services, so you
131
+ might need to use one if there is no modern client available for the service.
132
+ However, if a modern client is available, we generally recommend it over the
133
+ 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 Lfp
19
- VERSION = "0.a"
24
+ VERSION = "0.2.0"
20
25
  end
21
26
  end
22
27
  end
@@ -0,0 +1,252 @@
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/lfp/version"
24
+
25
+ require "googleauth"
26
+
27
+ module Google
28
+ module Shopping
29
+ module Merchant
30
+ module Lfp
31
+ ##
32
+ # Create a new client object for LfpInventoryService.
33
+ #
34
+ # By default, this returns an instance of
35
+ # [Google::Shopping::Merchant::Lfp::V1beta::LfpInventoryService::Client](https://rubydoc.info/gems/google-shopping-merchant-lfp-v1beta/Google/Shopping/Merchant/Lfp/V1beta/LfpInventoryService/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 LfpInventoryService 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
+ # Raises an exception if the currently installed versioned client gem for the
45
+ # given API version does not support the given transport of the LfpInventoryService service.
46
+ # You can determine whether the method will succeed by calling
47
+ # {Google::Shopping::Merchant::Lfp.lfp_inventory_service_available?}.
48
+ #
49
+ # ## About LfpInventoryService
50
+ #
51
+ # Service for a [LFP
52
+ # partner](https://support.google.com/merchants/answer/7676652) to submit local
53
+ # inventories for a merchant.
54
+ #
55
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
56
+ # Defaults to `:v1beta`.
57
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
58
+ # @return [::Object] A client object for the specified version.
59
+ #
60
+ def self.lfp_inventory_service version: :v1beta, transport: :grpc, &block
61
+ require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
62
+
63
+ package_name = Google::Shopping::Merchant::Lfp
64
+ .constants
65
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
66
+ .first
67
+ service_module = Google::Shopping::Merchant::Lfp.const_get(package_name).const_get(:LfpInventoryService)
68
+ service_module = service_module.const_get(:Rest) if transport == :rest
69
+ service_module.const_get(:Client).new(&block)
70
+ end
71
+
72
+ ##
73
+ # Determines whether the LfpInventoryService service is supported by the current client.
74
+ # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Lfp.lfp_inventory_service}.
75
+ # If false, that method will raise an exception. This could happen if the given
76
+ # API version does not exist or does not support the LfpInventoryService service,
77
+ # or if the versioned client gem needs an update to support the LfpInventoryService service.
78
+ #
79
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
80
+ # Defaults to `:v1beta`.
81
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
82
+ # @return [boolean] Whether the service is available.
83
+ #
84
+ def self.lfp_inventory_service_available? version: :v1beta, transport: :grpc
85
+ require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
86
+ package_name = Google::Shopping::Merchant::Lfp
87
+ .constants
88
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
89
+ .first
90
+ return false unless package_name
91
+ service_module = Google::Shopping::Merchant::Lfp.const_get package_name
92
+ return false unless service_module.const_defined? :LfpInventoryService
93
+ service_module = service_module.const_get :LfpInventoryService
94
+ if transport == :rest
95
+ return false unless service_module.const_defined? :Rest
96
+ service_module = service_module.const_get :Rest
97
+ end
98
+ service_module.const_defined? :Client
99
+ rescue ::LoadError
100
+ false
101
+ end
102
+
103
+ ##
104
+ # Create a new client object for LfpSaleService.
105
+ #
106
+ # By default, this returns an instance of
107
+ # [Google::Shopping::Merchant::Lfp::V1beta::LfpSaleService::Client](https://rubydoc.info/gems/google-shopping-merchant-lfp-v1beta/Google/Shopping/Merchant/Lfp/V1beta/LfpSaleService/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 LfpSaleService 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
+ # Raises an exception if the currently installed versioned client gem for the
117
+ # given API version does not support the given transport of the LfpSaleService service.
118
+ # You can determine whether the method will succeed by calling
119
+ # {Google::Shopping::Merchant::Lfp.lfp_sale_service_available?}.
120
+ #
121
+ # ## About LfpSaleService
122
+ #
123
+ # Service for a [LFP
124
+ # partner](https://support.google.com/merchants/answer/7676652) to submit sales
125
+ # data for a merchant.
126
+ #
127
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
128
+ # Defaults to `:v1beta`.
129
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
130
+ # @return [::Object] A client object for the specified version.
131
+ #
132
+ def self.lfp_sale_service version: :v1beta, transport: :grpc, &block
133
+ require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
134
+
135
+ package_name = Google::Shopping::Merchant::Lfp
136
+ .constants
137
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
138
+ .first
139
+ service_module = Google::Shopping::Merchant::Lfp.const_get(package_name).const_get(:LfpSaleService)
140
+ service_module = service_module.const_get(:Rest) if transport == :rest
141
+ service_module.const_get(:Client).new(&block)
142
+ end
143
+
144
+ ##
145
+ # Determines whether the LfpSaleService service is supported by the current client.
146
+ # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Lfp.lfp_sale_service}.
147
+ # If false, that method will raise an exception. This could happen if the given
148
+ # API version does not exist or does not support the LfpSaleService service,
149
+ # or if the versioned client gem needs an update to support the LfpSaleService service.
150
+ #
151
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
152
+ # Defaults to `:v1beta`.
153
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
154
+ # @return [boolean] Whether the service is available.
155
+ #
156
+ def self.lfp_sale_service_available? version: :v1beta, transport: :grpc
157
+ require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
158
+ package_name = Google::Shopping::Merchant::Lfp
159
+ .constants
160
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
161
+ .first
162
+ return false unless package_name
163
+ service_module = Google::Shopping::Merchant::Lfp.const_get package_name
164
+ return false unless service_module.const_defined? :LfpSaleService
165
+ service_module = service_module.const_get :LfpSaleService
166
+ if transport == :rest
167
+ return false unless service_module.const_defined? :Rest
168
+ service_module = service_module.const_get :Rest
169
+ end
170
+ service_module.const_defined? :Client
171
+ rescue ::LoadError
172
+ false
173
+ end
174
+
175
+ ##
176
+ # Create a new client object for LfpStoreService.
177
+ #
178
+ # By default, this returns an instance of
179
+ # [Google::Shopping::Merchant::Lfp::V1beta::LfpStoreService::Client](https://rubydoc.info/gems/google-shopping-merchant-lfp-v1beta/Google/Shopping/Merchant/Lfp/V1beta/LfpStoreService/Client)
180
+ # for a gRPC client for version V1beta of the API.
181
+ # However, you can specify a different API version by passing it in the
182
+ # `version` parameter. If the LfpStoreService service is
183
+ # supported by that API version, and the corresponding gem is available, the
184
+ # appropriate versioned client will be returned.
185
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
186
+ # the `transport` parameter.
187
+ #
188
+ # Raises an exception if the currently installed versioned client gem for the
189
+ # given API version does not support the given transport of the LfpStoreService service.
190
+ # You can determine whether the method will succeed by calling
191
+ # {Google::Shopping::Merchant::Lfp.lfp_store_service_available?}.
192
+ #
193
+ # ## About LfpStoreService
194
+ #
195
+ # Service for a [LFP
196
+ # partner](https://support.google.com/merchants/answer/7676652) to submit local
197
+ # stores for a merchant.
198
+ #
199
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
200
+ # Defaults to `:v1beta`.
201
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
202
+ # @return [::Object] A client object for the specified version.
203
+ #
204
+ def self.lfp_store_service version: :v1beta, transport: :grpc, &block
205
+ require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
206
+
207
+ package_name = Google::Shopping::Merchant::Lfp
208
+ .constants
209
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
210
+ .first
211
+ service_module = Google::Shopping::Merchant::Lfp.const_get(package_name).const_get(:LfpStoreService)
212
+ service_module = service_module.const_get(:Rest) if transport == :rest
213
+ service_module.const_get(:Client).new(&block)
214
+ end
215
+
216
+ ##
217
+ # Determines whether the LfpStoreService service is supported by the current client.
218
+ # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Lfp.lfp_store_service}.
219
+ # If false, that method will raise an exception. This could happen if the given
220
+ # API version does not exist or does not support the LfpStoreService service,
221
+ # or if the versioned client gem needs an update to support the LfpStoreService service.
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 [boolean] Whether the service is available.
227
+ #
228
+ def self.lfp_store_service_available? version: :v1beta, transport: :grpc
229
+ require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
230
+ package_name = Google::Shopping::Merchant::Lfp
231
+ .constants
232
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
233
+ .first
234
+ return false unless package_name
235
+ service_module = Google::Shopping::Merchant::Lfp.const_get package_name
236
+ return false unless service_module.const_defined? :LfpStoreService
237
+ service_module = service_module.const_get :LfpStoreService
238
+ if transport == :rest
239
+ return false unless service_module.const_defined? :Rest
240
+ service_module = service_module.const_get :Rest
241
+ end
242
+ service_module.const_defined? :Client
243
+ rescue ::LoadError
244
+ false
245
+ end
246
+ end
247
+ end
248
+ end
249
+ end
250
+
251
+ helper_path = ::File.join __dir__, "lfp", "helpers.rb"
252
+ require "google/shopping/merchant/lfp/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/lfp" unless defined? Google::Shopping::Merchant::Lfp::VERSION
metadata CHANGED
@@ -1,33 +1,65 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-shopping-merchant-lfp
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.a
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-04-23 00:00:00.000000000 Z
12
- dependencies: []
13
- description: Placeholder for the future Google-authored gem google-shopping-merchant-lfp.
14
- This placeholder is being released on 2024-04-23 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.
10
+ date: 2025-01-29 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: google-cloud-core
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '1.6'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '1.6'
26
+ - !ruby/object:Gem::Dependency
27
+ name: google-shopping-merchant-lfp-v1beta
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: '0.0'
33
+ - - "<"
34
+ - !ruby/object:Gem::Version
35
+ version: 2.a
36
+ type: :runtime
37
+ prerelease: false
38
+ version_requirements: !ruby/object:Gem::Requirement
39
+ requirements:
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: '0.0'
43
+ - - "<"
44
+ - !ruby/object:Gem::Version
45
+ version: 2.a
46
+ description: Programmatically manage your Merchant Center accounts.
18
47
  email: googleapis-packages@google.com
19
48
  executables: []
20
49
  extensions: []
21
50
  extra_rdoc_files: []
22
51
  files:
52
+ - ".yardopts"
53
+ - AUTHENTICATION.md
23
54
  - LICENSE.md
24
55
  - README.md
56
+ - lib/google-shopping-merchant-lfp.rb
57
+ - lib/google/shopping/merchant/lfp.rb
25
58
  - lib/google/shopping/merchant/lfp/version.rb
26
59
  homepage: https://github.com/googleapis/google-cloud-ruby
27
60
  licenses:
28
61
  - Apache-2.0
29
62
  metadata: {}
30
- post_install_message:
31
63
  rdoc_options: []
32
64
  require_paths:
33
65
  - lib
@@ -42,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
42
74
  - !ruby/object:Gem::Version
43
75
  version: '0'
44
76
  requirements: []
45
- rubygems_version: 3.5.6
46
- signing_key:
77
+ rubygems_version: 3.6.2
47
78
  specification_version: 4
48
- summary: Placeholder for the future Google-authored gem google-shopping-merchant-lfp
79
+ summary: Programmatically manage your Merchant Center accounts.
49
80
  test_files: []