google-shopping-merchant-accounts-v1 0.3.0 → 0.3.2

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.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/shopping/merchant/accounts/v1/account_issue_service/client.rb +20 -3
  3. data/lib/google/shopping/merchant/accounts/v1/account_relationships_service/client.rb +20 -3
  4. data/lib/google/shopping/merchant/accounts/v1/account_services_service/client.rb +20 -3
  5. data/lib/google/shopping/merchant/accounts/v1/accounts_pb.rb +4 -1
  6. data/lib/google/shopping/merchant/accounts/v1/accounts_service/client.rb +32 -8
  7. data/lib/google/shopping/merchant/accounts/v1/accounts_service/rest/client.rb +12 -5
  8. data/lib/google/shopping/merchant/accounts/v1/accounts_services_pb.rb +7 -4
  9. data/lib/google/shopping/merchant/accounts/v1/accountservices_pb.rb +2 -1
  10. data/lib/google/shopping/merchant/accounts/v1/autofeed_settings_service/client.rb +20 -3
  11. data/lib/google/shopping/merchant/accounts/v1/automatic_improvements_service/client.rb +20 -3
  12. data/lib/google/shopping/merchant/accounts/v1/business_identity_service/client.rb +20 -3
  13. data/lib/google/shopping/merchant/accounts/v1/business_info_service/client.rb +20 -3
  14. data/lib/google/shopping/merchant/accounts/v1/checkout_settings_service/client.rb +20 -3
  15. data/lib/google/shopping/merchant/accounts/v1/developer_registration_service/client.rb +99 -4
  16. data/lib/google/shopping/merchant/accounts/v1/developer_registration_service/rest/client.rb +80 -1
  17. data/lib/google/shopping/merchant/accounts/v1/developer_registration_service/rest/service_stub.rb +59 -0
  18. data/lib/google/shopping/merchant/accounts/v1/developerregistration_pb.rb +2 -1
  19. data/lib/google/shopping/merchant/accounts/v1/developerregistration_services_pb.rb +2 -0
  20. data/lib/google/shopping/merchant/accounts/v1/email_preferences_service/client.rb +20 -3
  21. data/lib/google/shopping/merchant/accounts/v1/gbp_accounts_service/client.rb +20 -3
  22. data/lib/google/shopping/merchant/accounts/v1/homepage_service/client.rb +20 -3
  23. data/lib/google/shopping/merchant/accounts/v1/lfp_providers_service/client.rb +20 -3
  24. data/lib/google/shopping/merchant/accounts/v1/omnichannel_settings_service/client.rb +20 -3
  25. data/lib/google/shopping/merchant/accounts/v1/online_return_policy_service/client.rb +20 -3
  26. data/lib/google/shopping/merchant/accounts/v1/programs_service/client.rb +20 -3
  27. data/lib/google/shopping/merchant/accounts/v1/regions_service/client.rb +20 -3
  28. data/lib/google/shopping/merchant/accounts/v1/shipping_settings_service/client.rb +20 -3
  29. data/lib/google/shopping/merchant/accounts/v1/terms_of_service_agreement_state_service/client.rb +20 -3
  30. data/lib/google/shopping/merchant/accounts/v1/terms_of_service_service/client.rb +20 -3
  31. data/lib/google/shopping/merchant/accounts/v1/user_pb.rb +2 -1
  32. data/lib/google/shopping/merchant/accounts/v1/user_service/client.rb +114 -3
  33. data/lib/google/shopping/merchant/accounts/v1/user_service/rest/client.rb +87 -0
  34. data/lib/google/shopping/merchant/accounts/v1/user_service/rest/service_stub.rb +62 -0
  35. data/lib/google/shopping/merchant/accounts/v1/user_services_pb.rb +3 -0
  36. data/lib/google/shopping/merchant/accounts/v1/verificationmailsettings_pb.rb +47 -0
  37. data/lib/google/shopping/merchant/accounts/v1/version.rb +1 -1
  38. data/proto_docs/google/shopping/merchant/accounts/v1/accessright.rb +4 -2
  39. data/proto_docs/google/shopping/merchant/accounts/v1/accounts.rb +72 -0
  40. data/proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb +18 -5
  41. data/proto_docs/google/shopping/merchant/accounts/v1/developerregistration.rb +12 -1
  42. data/proto_docs/google/shopping/merchant/accounts/v1/programs.rb +1 -0
  43. data/proto_docs/google/shopping/merchant/accounts/v1/user.rb +14 -2
  44. data/proto_docs/google/shopping/merchant/accounts/v1/verificationmailsettings.rb +53 -0
  45. metadata +3 -1
@@ -101,6 +101,11 @@ module Google
101
101
  # used to create a sub-account under an existing advanced account through
102
102
  # this method. Additional `account_management` or
103
103
  # `product_management` services may be provided.
104
+ # @!attribute [rw] set_alias
105
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1::CreateAndConfigureAccountRequest::SetAliasForRelationship>]
106
+ # Optional. If a relationship is created with a provider, you can set an
107
+ # alias for it with this field. The calling user must be an admin on the
108
+ # provider to be able to set an alias.
104
109
  class CreateAndConfigureAccountRequest
105
110
  include ::Google::Protobuf::MessageExts
106
111
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -114,6 +119,10 @@ module Google
114
119
  # @return [::Google::Shopping::Merchant::Accounts::V1::User]
115
120
  # Optional. Details about the user to be added. At the moment, only access
116
121
  # rights may be specified.
122
+ # @!attribute [rw] verification_mail_settings
123
+ # @return [::Google::Shopping::Merchant::Accounts::V1::VerificationMailSettings]
124
+ # Optional. Settings related to configuring the verification email that is
125
+ # sent after adding a user.
117
126
  class AddUser
118
127
  include ::Google::Protobuf::MessageExts
119
128
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -126,15 +135,78 @@ module Google
126
135
  # The provider is an
127
136
  # [aggregator](https://support.google.com/merchants/answer/188487) for
128
137
  # the account. Payload for service type Account Aggregation.
138
+ #
139
+ # Note: The following fields are mutually exclusive: `account_aggregation`, `account_management`, `comparison_shopping`, `products_management`, `campaigns_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
140
+ # @!attribute [rw] account_management
141
+ # @return [::Google::Shopping::Merchant::Accounts::V1::AccountManagement]
142
+ # The provider manages this account. Payload for service type Account
143
+ # Management.
144
+ #
145
+ # Note: The following fields are mutually exclusive: `account_management`, `account_aggregation`, `comparison_shopping`, `products_management`, `campaigns_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
146
+ # @!attribute [rw] comparison_shopping
147
+ # @return [::Google::Shopping::Merchant::Accounts::V1::ComparisonShopping]
148
+ # The provider is a CSS (Comparison Shopping Service) of this account.
149
+ # Payload for service type Comparison Shopping.
150
+ #
151
+ # Note: The following fields are mutually exclusive: `comparison_shopping`, `account_aggregation`, `account_management`, `products_management`, `campaigns_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
152
+ # @!attribute [rw] products_management
153
+ # @return [::Google::Shopping::Merchant::Accounts::V1::ProductsManagement]
154
+ # The provider manages products for this account. Payload for service
155
+ # type products management.
156
+ #
157
+ # Note: The following fields are mutually exclusive: `products_management`, `account_aggregation`, `account_management`, `comparison_shopping`, `campaigns_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
158
+ # @!attribute [rw] campaigns_management
159
+ # @return [::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement]
160
+ # The provider manages campaigns for this account. Payload for service
161
+ # type campaigns management.
162
+ #
163
+ # Note: The following fields are mutually exclusive: `campaigns_management`, `account_aggregation`, `account_management`, `comparison_shopping`, `products_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
129
164
  # @!attribute [rw] provider
130
165
  # @return [::String]
131
166
  # Required. The provider of the service. Either the reference to an account
132
167
  # such as `providers/123` or a well-known service provider (one of
133
168
  # `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
169
+ # @!attribute [rw] external_account_id
170
+ # @return [::String]
171
+ # Immutable. An optional, immutable identifier that Google uses to refer to
172
+ # this account when communicating with the provider. This should be the
173
+ # unique account ID within the provider's system (for example, your shop ID
174
+ # in Shopify).
175
+ #
176
+ # If you have multiple accounts with the same provider - for instance,
177
+ # different accounts for various regions — the `external_account_id`
178
+ # differentiates between them, ensuring accurate linking and integration
179
+ # between Google and the provider.
180
+ #
181
+ # The external account ID must be specified for the campaigns management
182
+ # service type.
183
+ #
184
+ # The external account ID must not be specified for the account aggregation
185
+ # service type.
186
+ #
187
+ # The external account ID is optional / may be specified for all other
188
+ # service types.
134
189
  class AddAccountService
135
190
  include ::Google::Protobuf::MessageExts
136
191
  extend ::Google::Protobuf::MessageExts::ClassMethods
137
192
  end
193
+
194
+ # Set an alias for a relationship between a provider and the account to
195
+ # be created.
196
+ # @!attribute [rw] provider
197
+ # @return [::String]
198
+ # Required. The provider of the service. This is a reference to an account
199
+ # such as `providers/123` or `accounts/123`. The same provider must be
200
+ # specified in at least one of the `service` fields.
201
+ # @!attribute [rw] account_id_alias
202
+ # @return [::String]
203
+ # Required. The unique ID of this account in the provider's system.
204
+ # The value must be unique across all accounts on the platform for this
205
+ # provider.
206
+ class SetAliasForRelationship
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
138
210
  end
139
211
 
140
212
  # Request message for the `DeleteAccount` method.
@@ -48,14 +48,14 @@ module Google
48
48
  # management or catalog synchronization services to keep the business's
49
49
  # product information up-to-date across platforms.
50
50
  #
51
- # Note: The following fields are mutually exclusive: `products_management`, `campaigns_management`, `account_management`, `account_aggregation`, `local_listing_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
51
+ # Note: The following fields are mutually exclusive: `products_management`, `campaigns_management`, `account_management`, `account_aggregation`, `local_listing_management`, `comparison_shopping`. If a field in that set is populated, all other fields in the set will automatically be cleared.
52
52
  # @!attribute [rw] campaigns_management
53
53
  # @return [::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement]
54
54
  # Service type for managing advertising campaigns. Grants the provider
55
55
  # access to create and manage the business's ad campaigns, including
56
56
  # setting up campaigns, adjusting bids, and optimizing performance.
57
57
  #
58
- # Note: The following fields are mutually exclusive: `campaigns_management`, `products_management`, `account_management`, `account_aggregation`, `local_listing_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
58
+ # Note: The following fields are mutually exclusive: `campaigns_management`, `products_management`, `account_management`, `account_aggregation`, `local_listing_management`, `comparison_shopping`. If a field in that set is populated, all other fields in the set will automatically be cleared.
59
59
  # @!attribute [rw] account_management
60
60
  # @return [::Google::Shopping::Merchant::Accounts::V1::AccountManagement]
61
61
  # Service type for account management. Enables the provider to perform
@@ -63,7 +63,7 @@ module Google
63
63
  # configuring account settings, managing users, or updating business
64
64
  # information.
65
65
  #
66
- # Note: The following fields are mutually exclusive: `account_management`, `products_management`, `campaigns_management`, `account_aggregation`, `local_listing_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
66
+ # Note: The following fields are mutually exclusive: `account_management`, `products_management`, `campaigns_management`, `account_aggregation`, `local_listing_management`, `comparison_shopping`. If a field in that set is populated, all other fields in the set will automatically be cleared.
67
67
  # @!attribute [rw] account_aggregation
68
68
  # @return [::Google::Shopping::Merchant::Accounts::V1::AccountAggregation]
69
69
  # Service type for account aggregation. This enables the provider, which is
@@ -75,14 +75,21 @@ module Google
75
75
  # This is useful for agencies, aggregators, or large retailers that need
76
76
  # centralized control over many Merchant Center accounts.
77
77
  #
78
- # Note: The following fields are mutually exclusive: `account_aggregation`, `products_management`, `campaigns_management`, `account_management`, `local_listing_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
78
+ # Note: The following fields are mutually exclusive: `account_aggregation`, `products_management`, `campaigns_management`, `account_management`, `local_listing_management`, `comparison_shopping`. If a field in that set is populated, all other fields in the set will automatically be cleared.
79
79
  # @!attribute [rw] local_listing_management
80
80
  # @return [::Google::Shopping::Merchant::Accounts::V1::LocalListingManagement]
81
81
  # Service type for local listings management. The business group associated
82
82
  # with the external account id will be used to provide local inventory to
83
83
  # this Merchant Center account.
84
84
  #
85
- # Note: The following fields are mutually exclusive: `local_listing_management`, `products_management`, `campaigns_management`, `account_management`, `account_aggregation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
85
+ # Note: The following fields are mutually exclusive: `local_listing_management`, `products_management`, `campaigns_management`, `account_management`, `account_aggregation`, `comparison_shopping`. If a field in that set is populated, all other fields in the set will automatically be cleared.
86
+ # @!attribute [rw] comparison_shopping
87
+ # @return [::Google::Shopping::Merchant::Accounts::V1::ComparisonShopping]
88
+ # Service type for comparison shopping. The provider is a CSS (Comparison
89
+ # Shopping Service) managing the account. See
90
+ # https://support.google.com/merchants/answer/12653197
91
+ #
92
+ # Note: The following fields are mutually exclusive: `comparison_shopping`, `products_management`, `campaigns_management`, `account_management`, `account_aggregation`, `local_listing_management`. If a field in that set is populated, all other fields in the set will automatically be cleared.
86
93
  # @!attribute [rw] name
87
94
  # @return [::String]
88
95
  # Identifier. The resource name of the account service.
@@ -241,6 +248,12 @@ module Google
241
248
  extend ::Google::Protobuf::MessageExts::ClassMethods
242
249
  end
243
250
 
251
+ # `ComparisonShopping` payload.
252
+ class ComparisonShopping
253
+ include ::Google::Protobuf::MessageExts
254
+ extend ::Google::Protobuf::MessageExts::ClassMethods
255
+ end
256
+
244
257
  # The current status of establishing of the service.
245
258
  # (for example, pending approval or approved).
246
259
  # @!attribute [r] approval_state
@@ -50,7 +50,9 @@ module Google
50
50
  # updated to have the new "API notifications" preference. If the developer
51
51
  # email provided is not associated with any user we will just add it as a
52
52
  # contact. The email preference corresponding to that contact will have the
53
- # new "API notifications" preference
53
+ # new "API notifications" preference. Make sure the email used is associated
54
+ # with a Google Account (Google Workspace account or Gmail account)
55
+ # and is not a service account as service accounts can't receive emails.
54
56
  class RegisterGcpRequest
55
57
  include ::Google::Protobuf::MessageExts
56
58
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -75,6 +77,15 @@ module Google
75
77
  include ::Google::Protobuf::MessageExts
76
78
  extend ::Google::Protobuf::MessageExts::ClassMethods
77
79
  end
80
+
81
+ # Response message for the GetAccountForGcpRegistration method.
82
+ # @!attribute [rw] name
83
+ # @return [::String]
84
+ # The name of the merchant account id that the GCP is registered with.
85
+ class GetAccountForGcpRegistrationResponse
86
+ include ::Google::Protobuf::MessageExts
87
+ extend ::Google::Protobuf::MessageExts::ClassMethods
88
+ end
78
89
  end
79
90
  end
80
91
  end
@@ -33,6 +33,7 @@ module Google
33
33
  # The following list is the available set of program resource IDs accessible
34
34
  # through the API:
35
35
  #
36
+ # * `checkout`
36
37
  # * `free-listings`
37
38
  # * `shopping-ads`
38
39
  # * `youtube-shopping-checkout`
@@ -22,7 +22,7 @@ module Google
22
22
  module Merchant
23
23
  module Accounts
24
24
  module V1
25
- # The `User` message represents a user associated with a Merchant Center
25
+ # The `User` resource represents a user associated with a Merchant Center
26
26
  # account. It is used to manage user permissions and access rights within the
27
27
  # account. For more information, see [Frequently asked questions about people
28
28
  # and access levels](//support.google.com/merchants/answer/12160472).
@@ -45,7 +45,9 @@ module Google
45
45
  include ::Google::Protobuf::MessageExts
46
46
  extend ::Google::Protobuf::MessageExts::ClassMethods
47
47
 
48
- # The possible states of a user.
48
+ # The state represents the possible statuses of a user. It is an output-only
49
+ # field that is set to `PENDING` when a user is invited to an account and
50
+ # changes to `VERIFIED` once the user accepts the invitation.
49
51
  module State
50
52
  # Default value. This value is unused.
51
53
  STATE_UNSPECIFIED = 0
@@ -157,6 +159,16 @@ module Google
157
159
  include ::Google::Protobuf::MessageExts
158
160
  extend ::Google::Protobuf::MessageExts::ClassMethods
159
161
  end
162
+
163
+ # Request message for the `VerifySelf` method.
164
+ # @!attribute [rw] account
165
+ # @return [::String]
166
+ # Required. The name of the account under which the caller is a user.
167
+ # Format: `accounts/{account}`
168
+ class VerifySelfRequest
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
160
172
  end
161
173
  end
162
174
  end
@@ -0,0 +1,53 @@
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 V1
25
+ # Settings related to the verification email that is sent after adding a user.
26
+ # @!attribute [rw] verification_mail_mode
27
+ # @return [::Google::Shopping::Merchant::Accounts::V1::VerificationMailSettings::VerificationMailMode]
28
+ # Optional. Mode of the verification mail. If not set, the default is
29
+ # `SEND_VERIFICATION_MAIL`.
30
+ class VerificationMailSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+
34
+ # The different configuration options for sending a verification email
35
+ # when adding a user.
36
+ module VerificationMailMode
37
+ # Default first member of every enum. Do not use.
38
+ VERIFICATION_MAIL_MODE_UNSPECIFIED = 0
39
+
40
+ # An invitation email is sent to the user added shortly after.
41
+ SEND_VERIFICATION_MAIL = 1
42
+
43
+ # No invitation email is sent. This can be useful if the user is
44
+ # expected to accept the invitation through the API without needing
45
+ # another notification.
46
+ SUPPRESS_VERIFICATION_MAIL = 2
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-shopping-merchant-accounts-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -281,6 +281,7 @@ files:
281
281
  - lib/google/shopping/merchant/accounts/v1/user_service/rest/client.rb
282
282
  - lib/google/shopping/merchant/accounts/v1/user_service/rest/service_stub.rb
283
283
  - lib/google/shopping/merchant/accounts/v1/user_services_pb.rb
284
+ - lib/google/shopping/merchant/accounts/v1/verificationmailsettings_pb.rb
284
285
  - lib/google/shopping/merchant/accounts/v1/version.rb
285
286
  - proto_docs/README.md
286
287
  - proto_docs/google/api/client.rb
@@ -317,6 +318,7 @@ files:
317
318
  - proto_docs/google/shopping/merchant/accounts/v1/termsofserviceagreementstate.rb
318
319
  - proto_docs/google/shopping/merchant/accounts/v1/termsofservicekind.rb
319
320
  - proto_docs/google/shopping/merchant/accounts/v1/user.rb
321
+ - proto_docs/google/shopping/merchant/accounts/v1/verificationmailsettings.rb
320
322
  - proto_docs/google/shopping/type/types.rb
321
323
  - proto_docs/google/type/date.rb
322
324
  - proto_docs/google/type/datetime.rb