google-shopping-merchant-accounts-v1beta 0.10.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/client.rb +757 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/paths.rb +69 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/rest/client.rb +703 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/rest/service_stub.rb +329 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/rest.rb +55 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service.rb +58 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkoutsettings_pb.rb +60 -0
- data/lib/google/shopping/merchant/accounts/v1beta/checkoutsettings_services_pb.rb +56 -0
- data/lib/google/shopping/merchant/accounts/v1beta/rest.rb +1 -0
- data/lib/google/shopping/merchant/accounts/v1beta/version.rb +1 -1
- data/lib/google/shopping/merchant/accounts/v1beta.rb +1 -0
- data/proto_docs/google/shopping/merchant/accounts/v1beta/checkoutsettings.rb +185 -0
- metadata +13 -3
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2025 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
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Shopping
|
|
22
|
+
module Merchant
|
|
23
|
+
module Accounts
|
|
24
|
+
module V1beta
|
|
25
|
+
# Request message for `GetCheckoutSettings` method.
|
|
26
|
+
# @!attribute [rw] name
|
|
27
|
+
# @return [::String]
|
|
28
|
+
# Required. The name/identifier of the merchant account.
|
|
29
|
+
# Format: `accounts/{account}/programs/{program}/checkoutSettings`
|
|
30
|
+
class GetCheckoutSettingsRequest
|
|
31
|
+
include ::Google::Protobuf::MessageExts
|
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Request message for the `CreateCheckoutSettings` method.
|
|
36
|
+
# @!attribute [rw] parent
|
|
37
|
+
# @return [::String]
|
|
38
|
+
# Required. The merchant account for which the `CheckoutSettings` will be
|
|
39
|
+
# created.
|
|
40
|
+
# @!attribute [rw] checkout_settings
|
|
41
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::CheckoutSettings]
|
|
42
|
+
# Required. The `CheckoutSettings` object to create.
|
|
43
|
+
class CreateCheckoutSettingsRequest
|
|
44
|
+
include ::Google::Protobuf::MessageExts
|
|
45
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Request message for the `UpdateCheckoutSettings` method.
|
|
49
|
+
# @!attribute [rw] checkout_settings
|
|
50
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::CheckoutSettings]
|
|
51
|
+
# Required. The updated version of the `CheckoutSettings`.
|
|
52
|
+
# The `name` field is used to identify the `CheckoutSettings`.
|
|
53
|
+
# Format: `accounts/{account}/programs/{program}/checkoutSettings`
|
|
54
|
+
# @!attribute [rw] update_mask
|
|
55
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
56
|
+
# Required. List of fields being updated.
|
|
57
|
+
# The following fields are supported (in both `snake_case` and
|
|
58
|
+
# `lowerCamelCase`):
|
|
59
|
+
#
|
|
60
|
+
# - `eligible_destinations`
|
|
61
|
+
# - `uri_settings`
|
|
62
|
+
class UpdateCheckoutSettingsRequest
|
|
63
|
+
include ::Google::Protobuf::MessageExts
|
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# Request message for the `DeleteCheckoutSettings` method.
|
|
68
|
+
# @!attribute [rw] name
|
|
69
|
+
# @return [::String]
|
|
70
|
+
# Required. The name/identifier of the merchant account.
|
|
71
|
+
# Format: `accounts/{account}/programs/{program}/checkoutSettings`
|
|
72
|
+
class DeleteCheckoutSettingsRequest
|
|
73
|
+
include ::Google::Protobuf::MessageExts
|
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for
|
|
78
|
+
# a specific merchant.
|
|
79
|
+
# @!attribute [rw] name
|
|
80
|
+
# @return [::String]
|
|
81
|
+
# Identifier. The resource name of the program configuration settings.
|
|
82
|
+
# Format: `accounts/{account}/programs/{program}/checkoutSettings`
|
|
83
|
+
# @!attribute [rw] uri_settings
|
|
84
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::UriSettings]
|
|
85
|
+
# URI settings for cart or checkout URL.
|
|
86
|
+
# @!attribute [rw] eligible_destinations
|
|
87
|
+
# @return [::Array<::Google::Shopping::Type::Destination::DestinationEnum>]
|
|
88
|
+
# Optional. The destinations to which the checkout program applies, valid
|
|
89
|
+
# destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
|
|
90
|
+
# @!attribute [r] enrollment_state
|
|
91
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::CheckoutSettings::CheckoutEnrollmentState]
|
|
92
|
+
# Output only. Reflects the merchant enrollment state in `Checkout` program.
|
|
93
|
+
# @!attribute [r] review_state
|
|
94
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::CheckoutSettings::CheckoutReviewState]
|
|
95
|
+
# Output only. Reflects the merchant review state in `Checkout` program.
|
|
96
|
+
# This is set based on the data quality reviews of the URL provided by
|
|
97
|
+
# the merchant.
|
|
98
|
+
# A merchant with enrollment state
|
|
99
|
+
# as `ENROLLED` can be in the following review states: `IN_REVIEW`,
|
|
100
|
+
# `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of
|
|
101
|
+
# `ENROLLED` before a review can begin for the merchant.For more details,
|
|
102
|
+
# check the help center doc.
|
|
103
|
+
# @!attribute [r] effective_uri_settings
|
|
104
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::UriSettings]
|
|
105
|
+
# Output only. The effective value of `uri_settings` for a given merchant. If
|
|
106
|
+
# account level settings are present then this value will be a copy of url
|
|
107
|
+
# settings. Otherwise, it will have the value of the parent account (for only
|
|
108
|
+
# marketplace sellers).
|
|
109
|
+
# @!attribute [r] effective_enrollment_state
|
|
110
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::CheckoutSettings::CheckoutEnrollmentState]
|
|
111
|
+
# Output only. The effective value of enrollment_state for a given merchant
|
|
112
|
+
# ID. If account level settings are present then this value will be a copy of
|
|
113
|
+
# the account level settings. Otherwise, it will have the value of the parent
|
|
114
|
+
# account (for only marketplace sellers).
|
|
115
|
+
# @!attribute [r] effective_review_state
|
|
116
|
+
# @return [::Google::Shopping::Merchant::Accounts::V1beta::CheckoutSettings::CheckoutReviewState]
|
|
117
|
+
# Output only. The effective value of `review_state` for a given merchant ID.
|
|
118
|
+
# If account level settings are present then this value will be a copy of the
|
|
119
|
+
# account level settings. Otherwise, it will have the value of the parent
|
|
120
|
+
# account (for only marketplace sellers).
|
|
121
|
+
class CheckoutSettings
|
|
122
|
+
include ::Google::Protobuf::MessageExts
|
|
123
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
124
|
+
|
|
125
|
+
# Enum indicating the enrollment state of merchant in `Checkout`
|
|
126
|
+
# program.
|
|
127
|
+
module CheckoutEnrollmentState
|
|
128
|
+
# Default enrollment state when enrollment state is not specified.
|
|
129
|
+
CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0
|
|
130
|
+
|
|
131
|
+
# Merchant has not enrolled into the program.
|
|
132
|
+
INACTIVE = 1
|
|
133
|
+
|
|
134
|
+
# Merchant has enrolled into the program by providing either an
|
|
135
|
+
# account level URL or checkout URLs as part of their feed.
|
|
136
|
+
ENROLLED = 2
|
|
137
|
+
|
|
138
|
+
# Merchant has previously enrolled but opted out of the program.
|
|
139
|
+
OPTED_OUT = 3
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
# Enum indicating the review state of merchant in `Checkout`
|
|
143
|
+
# program.
|
|
144
|
+
module CheckoutReviewState
|
|
145
|
+
# Default review state when review state is not specified.
|
|
146
|
+
CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0
|
|
147
|
+
|
|
148
|
+
# Merchant provided URLs are being reviewed for data quality issues.
|
|
149
|
+
IN_REVIEW = 1
|
|
150
|
+
|
|
151
|
+
# Merchant account has been approved. Indicates the data quality checks
|
|
152
|
+
# have passed.
|
|
153
|
+
APPROVED = 2
|
|
154
|
+
|
|
155
|
+
# Merchant account has been disapproved due to data quality issues.
|
|
156
|
+
DISAPPROVED = 3
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# URL settings for cart or checkout URL.
|
|
161
|
+
# @!attribute [rw] checkout_uri_template
|
|
162
|
+
# @return [::String]
|
|
163
|
+
# Checkout URL template. When the placeholders are expanded will redirect
|
|
164
|
+
# the buyer to the merchant checkout page with the item in the cart. For
|
|
165
|
+
# more details, check the [help center
|
|
166
|
+
# doc](https://support.google.com/merchants/answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
|
|
167
|
+
#
|
|
168
|
+
# Note: The following fields are mutually exclusive: `checkout_uri_template`, `cart_uri_template`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
169
|
+
# @!attribute [rw] cart_uri_template
|
|
170
|
+
# @return [::String]
|
|
171
|
+
# Cart URL template. When the placeholders are expanded will redirect the
|
|
172
|
+
# buyer to the cart page on the merchant website with the selected
|
|
173
|
+
# item in cart. For more details, check the [help center
|
|
174
|
+
# doc](https://support.google.com/merchants/answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
|
|
175
|
+
#
|
|
176
|
+
# Note: The following fields are mutually exclusive: `cart_uri_template`, `checkout_uri_template`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
177
|
+
class UriSettings
|
|
178
|
+
include ::Google::Protobuf::MessageExts
|
|
179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-shopping-merchant-accounts-v1beta
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.12.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
@@ -15,14 +15,14 @@ dependencies:
|
|
|
15
15
|
requirements:
|
|
16
16
|
- - "~>"
|
|
17
17
|
- !ruby/object:Gem::Version
|
|
18
|
-
version: '1.
|
|
18
|
+
version: '1.2'
|
|
19
19
|
type: :runtime
|
|
20
20
|
prerelease: false
|
|
21
21
|
version_requirements: !ruby/object:Gem::Requirement
|
|
22
22
|
requirements:
|
|
23
23
|
- - "~>"
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
|
-
version: '1.
|
|
25
|
+
version: '1.2'
|
|
26
26
|
- !ruby/object:Gem::Dependency
|
|
27
27
|
name: google-cloud-errors
|
|
28
28
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -149,6 +149,15 @@ files:
|
|
|
149
149
|
- lib/google/shopping/merchant/accounts/v1beta/businessidentity_services_pb.rb
|
|
150
150
|
- lib/google/shopping/merchant/accounts/v1beta/businessinfo_pb.rb
|
|
151
151
|
- lib/google/shopping/merchant/accounts/v1beta/businessinfo_services_pb.rb
|
|
152
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service.rb
|
|
153
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/client.rb
|
|
154
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/credentials.rb
|
|
155
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/paths.rb
|
|
156
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/rest.rb
|
|
157
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/rest/client.rb
|
|
158
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkout_settings_service/rest/service_stub.rb
|
|
159
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkoutsettings_pb.rb
|
|
160
|
+
- lib/google/shopping/merchant/accounts/v1beta/checkoutsettings_services_pb.rb
|
|
152
161
|
- lib/google/shopping/merchant/accounts/v1beta/customerservice_pb.rb
|
|
153
162
|
- lib/google/shopping/merchant/accounts/v1beta/email_preferences_service.rb
|
|
154
163
|
- lib/google/shopping/merchant/accounts/v1beta/email_preferences_service/client.rb
|
|
@@ -282,6 +291,7 @@ files:
|
|
|
282
291
|
- proto_docs/google/shopping/merchant/accounts/v1beta/automaticimprovements.rb
|
|
283
292
|
- proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb
|
|
284
293
|
- proto_docs/google/shopping/merchant/accounts/v1beta/businessinfo.rb
|
|
294
|
+
- proto_docs/google/shopping/merchant/accounts/v1beta/checkoutsettings.rb
|
|
285
295
|
- proto_docs/google/shopping/merchant/accounts/v1beta/customerservice.rb
|
|
286
296
|
- proto_docs/google/shopping/merchant/accounts/v1beta/emailpreferences.rb
|
|
287
297
|
- proto_docs/google/shopping/merchant/accounts/v1beta/gbpaccounts.rb
|