google-shopping-merchant-accounts-v1 0.3.1 → 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 (26) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/shopping/merchant/accounts/v1/accounts_pb.rb +4 -1
  3. data/lib/google/shopping/merchant/accounts/v1/accounts_service/client.rb +12 -5
  4. data/lib/google/shopping/merchant/accounts/v1/accounts_service/rest/client.rb +12 -5
  5. data/lib/google/shopping/merchant/accounts/v1/accounts_services_pb.rb +7 -4
  6. data/lib/google/shopping/merchant/accounts/v1/accountservices_pb.rb +2 -1
  7. data/lib/google/shopping/merchant/accounts/v1/developer_registration_service/client.rb +79 -1
  8. data/lib/google/shopping/merchant/accounts/v1/developer_registration_service/rest/client.rb +80 -1
  9. data/lib/google/shopping/merchant/accounts/v1/developer_registration_service/rest/service_stub.rb +59 -0
  10. data/lib/google/shopping/merchant/accounts/v1/developerregistration_pb.rb +2 -1
  11. data/lib/google/shopping/merchant/accounts/v1/developerregistration_services_pb.rb +2 -0
  12. data/lib/google/shopping/merchant/accounts/v1/user_pb.rb +2 -1
  13. data/lib/google/shopping/merchant/accounts/v1/user_service/client.rb +94 -0
  14. data/lib/google/shopping/merchant/accounts/v1/user_service/rest/client.rb +87 -0
  15. data/lib/google/shopping/merchant/accounts/v1/user_service/rest/service_stub.rb +62 -0
  16. data/lib/google/shopping/merchant/accounts/v1/user_services_pb.rb +3 -0
  17. data/lib/google/shopping/merchant/accounts/v1/verificationmailsettings_pb.rb +47 -0
  18. data/lib/google/shopping/merchant/accounts/v1/version.rb +1 -1
  19. data/proto_docs/google/shopping/merchant/accounts/v1/accessright.rb +4 -2
  20. data/proto_docs/google/shopping/merchant/accounts/v1/accounts.rb +72 -0
  21. data/proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb +18 -5
  22. data/proto_docs/google/shopping/merchant/accounts/v1/developerregistration.rb +12 -1
  23. data/proto_docs/google/shopping/merchant/accounts/v1/programs.rb +1 -0
  24. data/proto_docs/google/shopping/merchant/accounts/v1/user.rb +14 -2
  25. data/proto_docs/google/shopping/merchant/accounts/v1/verificationmailsettings.rb +53 -0
  26. metadata +3 -1
@@ -661,6 +661,93 @@ module Google
661
661
  raise ::Google::Cloud::Error.from_error(e)
662
662
  end
663
663
 
664
+ ##
665
+ # Updates the user that is represented by the caller from pending to
666
+ # verified.
667
+ #
668
+ # @overload verify_self(request, options = nil)
669
+ # Pass arguments to `verify_self` via a request object, either of type
670
+ # {::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest} or an equivalent Hash.
671
+ #
672
+ # @param request [::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest, ::Hash]
673
+ # A request object representing the call parameters. Required. To specify no
674
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
675
+ # @param options [::Gapic::CallOptions, ::Hash]
676
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
677
+ #
678
+ # @overload verify_self(account: nil)
679
+ # Pass arguments to `verify_self` via keyword arguments. Note that at
680
+ # least one keyword argument is required. To specify no parameters, or to keep all
681
+ # the default parameter values, pass an empty Hash as a request object (see above).
682
+ #
683
+ # @param account [::String]
684
+ # Required. The name of the account under which the caller is a user.
685
+ # Format: `accounts/{account}`
686
+ #
687
+ # @yield [response, operation] Access the result along with the RPC operation
688
+ # @yieldparam response [::Google::Shopping::Merchant::Accounts::V1::User]
689
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
690
+ #
691
+ # @return [::Google::Shopping::Merchant::Accounts::V1::User]
692
+ #
693
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
694
+ #
695
+ # @example Basic example
696
+ # require "google/shopping/merchant/accounts/v1"
697
+ #
698
+ # # Create a client object. The client can be reused for multiple calls.
699
+ # client = Google::Shopping::Merchant::Accounts::V1::UserService::Client.new
700
+ #
701
+ # # Create a request. To set request fields, pass in keyword arguments.
702
+ # request = Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest.new
703
+ #
704
+ # # Call the verify_self method.
705
+ # result = client.verify_self request
706
+ #
707
+ # # The returned object is of type Google::Shopping::Merchant::Accounts::V1::User.
708
+ # p result
709
+ #
710
+ def verify_self request, options = nil
711
+ raise ::ArgumentError, "request must be provided" if request.nil?
712
+
713
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest
714
+
715
+ # Converts hash and nil to an options object
716
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
717
+
718
+ # Customize the options with defaults
719
+ metadata = @config.rpcs.verify_self.metadata.to_h
720
+
721
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
722
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
723
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
724
+ gapic_version: ::Google::Shopping::Merchant::Accounts::V1::VERSION
725
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
726
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
727
+
728
+ header_params = {}
729
+ if request.account
730
+ header_params["account"] = request.account
731
+ end
732
+
733
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
734
+ metadata[:"x-goog-request-params"] ||= request_params_header
735
+
736
+ options.apply_defaults timeout: @config.rpcs.verify_self.timeout,
737
+ metadata: metadata,
738
+ retry_policy: @config.rpcs.verify_self.retry_policy
739
+
740
+ options.apply_defaults timeout: @config.timeout,
741
+ metadata: @config.metadata,
742
+ retry_policy: @config.retry_policy
743
+
744
+ @user_service_stub.call_rpc :verify_self, request, options: options do |response, operation|
745
+ yield response, operation if block_given?
746
+ end
747
+ rescue ::GRPC::BadStatus => e
748
+ raise ::Google::Cloud::Error.from_error(e)
749
+ end
750
+
664
751
  ##
665
752
  # Configuration class for the UserService API.
666
753
  #
@@ -869,6 +956,11 @@ module Google
869
956
  # @return [::Gapic::Config::Method]
870
957
  #
871
958
  attr_reader :list_users
959
+ ##
960
+ # RPC-specific configuration for `verify_self`
961
+ # @return [::Gapic::Config::Method]
962
+ #
963
+ attr_reader :verify_self
872
964
 
873
965
  # @private
874
966
  def initialize parent_rpcs = nil
@@ -882,6 +974,8 @@ module Google
882
974
  @update_user = ::Gapic::Config::Method.new update_user_config
883
975
  list_users_config = parent_rpcs.list_users if parent_rpcs.respond_to? :list_users
884
976
  @list_users = ::Gapic::Config::Method.new list_users_config
977
+ verify_self_config = parent_rpcs.verify_self if parent_rpcs.respond_to? :verify_self
978
+ @verify_self = ::Gapic::Config::Method.new verify_self_config
885
979
 
886
980
  yield self if block_given?
887
981
  end
@@ -619,6 +619,86 @@ module Google
619
619
  raise ::Google::Cloud::Error.from_error(e)
620
620
  end
621
621
 
622
+ ##
623
+ # Updates the user that is represented by the caller from pending to
624
+ # verified.
625
+ #
626
+ # @overload verify_self(request, options = nil)
627
+ # Pass arguments to `verify_self` via a request object, either of type
628
+ # {::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest} or an equivalent Hash.
629
+ #
630
+ # @param request [::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest, ::Hash]
631
+ # A request object representing the call parameters. Required. To specify no
632
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
633
+ # @param options [::Gapic::CallOptions, ::Hash]
634
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
635
+ #
636
+ # @overload verify_self(account: nil)
637
+ # Pass arguments to `verify_self` via keyword arguments. Note that at
638
+ # least one keyword argument is required. To specify no parameters, or to keep all
639
+ # the default parameter values, pass an empty Hash as a request object (see above).
640
+ #
641
+ # @param account [::String]
642
+ # Required. The name of the account under which the caller is a user.
643
+ # Format: `accounts/{account}`
644
+ # @yield [result, operation] Access the result along with the TransportOperation object
645
+ # @yieldparam result [::Google::Shopping::Merchant::Accounts::V1::User]
646
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
647
+ #
648
+ # @return [::Google::Shopping::Merchant::Accounts::V1::User]
649
+ #
650
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
651
+ #
652
+ # @example Basic example
653
+ # require "google/shopping/merchant/accounts/v1"
654
+ #
655
+ # # Create a client object. The client can be reused for multiple calls.
656
+ # client = Google::Shopping::Merchant::Accounts::V1::UserService::Rest::Client.new
657
+ #
658
+ # # Create a request. To set request fields, pass in keyword arguments.
659
+ # request = Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest.new
660
+ #
661
+ # # Call the verify_self method.
662
+ # result = client.verify_self request
663
+ #
664
+ # # The returned object is of type Google::Shopping::Merchant::Accounts::V1::User.
665
+ # p result
666
+ #
667
+ def verify_self request, options = nil
668
+ raise ::ArgumentError, "request must be provided" if request.nil?
669
+
670
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest
671
+
672
+ # Converts hash and nil to an options object
673
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
674
+
675
+ # Customize the options with defaults
676
+ call_metadata = @config.rpcs.verify_self.metadata.to_h
677
+
678
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
679
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
680
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
681
+ gapic_version: ::Google::Shopping::Merchant::Accounts::V1::VERSION,
682
+ transports_version_send: [:rest]
683
+
684
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
685
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
686
+
687
+ options.apply_defaults timeout: @config.rpcs.verify_self.timeout,
688
+ metadata: call_metadata,
689
+ retry_policy: @config.rpcs.verify_self.retry_policy
690
+
691
+ options.apply_defaults timeout: @config.timeout,
692
+ metadata: @config.metadata,
693
+ retry_policy: @config.retry_policy
694
+
695
+ @user_service_stub.verify_self request, options do |result, operation|
696
+ yield result, operation if block_given?
697
+ end
698
+ rescue ::Gapic::Rest::Error => e
699
+ raise ::Google::Cloud::Error.from_error(e)
700
+ end
701
+
622
702
  ##
623
703
  # Configuration class for the UserService REST API.
624
704
  #
@@ -790,6 +870,11 @@ module Google
790
870
  # @return [::Gapic::Config::Method]
791
871
  #
792
872
  attr_reader :list_users
873
+ ##
874
+ # RPC-specific configuration for `verify_self`
875
+ # @return [::Gapic::Config::Method]
876
+ #
877
+ attr_reader :verify_self
793
878
 
794
879
  # @private
795
880
  def initialize parent_rpcs = nil
@@ -803,6 +888,8 @@ module Google
803
888
  @update_user = ::Gapic::Config::Method.new update_user_config
804
889
  list_users_config = parent_rpcs.list_users if parent_rpcs.respond_to? :list_users
805
890
  @list_users = ::Gapic::Config::Method.new list_users_config
891
+ verify_self_config = parent_rpcs.verify_self if parent_rpcs.respond_to? :verify_self
892
+ @verify_self = ::Gapic::Config::Method.new verify_self_config
806
893
 
807
894
  yield self if block_given?
808
895
  end
@@ -274,6 +274,46 @@ module Google
274
274
  end
275
275
  end
276
276
 
277
+ ##
278
+ # Baseline implementation for the verify_self REST call
279
+ #
280
+ # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest]
281
+ # A request object representing the call parameters. Required.
282
+ # @param options [::Gapic::CallOptions]
283
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
284
+ #
285
+ # @yield [result, operation] Access the result along with the TransportOperation object
286
+ # @yieldparam result [::Google::Shopping::Merchant::Accounts::V1::User]
287
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
288
+ #
289
+ # @return [::Google::Shopping::Merchant::Accounts::V1::User]
290
+ # A result object deserialized from the server's reply
291
+ def verify_self request_pb, options = nil
292
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
293
+
294
+ verb, uri, query_string_params, body = ServiceStub.transcode_verify_self_request request_pb
295
+ query_string_params = if query_string_params.any?
296
+ query_string_params.to_h { |p| p.split "=", 2 }
297
+ else
298
+ {}
299
+ end
300
+
301
+ response = @client_stub.make_http_request(
302
+ verb,
303
+ uri: uri,
304
+ body: body || "",
305
+ params: query_string_params,
306
+ method_name: "verify_self",
307
+ options: options
308
+ )
309
+ operation = ::Gapic::Rest::TransportOperation.new response
310
+ result = ::Google::Shopping::Merchant::Accounts::V1::User.decode_json response.body, ignore_unknown_fields: true
311
+ catch :response do
312
+ yield result, operation if block_given?
313
+ result
314
+ end
315
+ end
316
+
277
317
  ##
278
318
  # @private
279
319
  #
@@ -380,6 +420,28 @@ module Google
380
420
  )
381
421
  transcoder.transcode request_pb
382
422
  end
423
+
424
+ ##
425
+ # @private
426
+ #
427
+ # GRPC transcoding helper method for the verify_self REST call
428
+ #
429
+ # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest]
430
+ # A request object representing the call parameters. Required.
431
+ # @return [Array(String, [String, nil], Hash{String => String})]
432
+ # Uri, Body, Query string parameters
433
+ def self.transcode_verify_self_request request_pb
434
+ transcoder = Gapic::Rest::GrpcTranscoder.new
435
+ .with_bindings(
436
+ uri_method: :patch,
437
+ uri_template: "/accounts/v1/{account}/users/me:verifySelf",
438
+ body: "*",
439
+ matches: [
440
+ ["account", %r{^accounts/[^/]+/?$}, false]
441
+ ]
442
+ )
443
+ transcoder.transcode request_pb
444
+ end
383
445
  end
384
446
  end
385
447
  end
@@ -49,6 +49,9 @@ module Google
49
49
  rpc :UpdateUser, ::Google::Shopping::Merchant::Accounts::V1::UpdateUserRequest, ::Google::Shopping::Merchant::Accounts::V1::User
50
50
  # Lists all users of a Merchant Center account.
51
51
  rpc :ListUsers, ::Google::Shopping::Merchant::Accounts::V1::ListUsersRequest, ::Google::Shopping::Merchant::Accounts::V1::ListUsersResponse
52
+ # Updates the user that is represented by the caller from pending to
53
+ # verified.
54
+ rpc :VerifySelf, ::Google::Shopping::Merchant::Accounts::V1::VerifySelfRequest, ::Google::Shopping::Merchant::Accounts::V1::User
52
55
  end
53
56
 
54
57
  Stub = Service.rpc_stub_class
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
3
+ # source: google/shopping/merchant/accounts/v1/verificationmailsettings.proto
4
+
5
+ require 'google/protobuf'
6
+
7
+ require 'google/api/field_behavior_pb'
8
+
9
+
10
+ descriptor_data = "\nCgoogle/shopping/merchant/accounts/v1/verificationmailsettings.proto\x12$google.shopping.merchant.accounts.v1\x1a\x1fgoogle/api/field_behavior.proto\"\x90\x02\n\x18VerificationMailSettings\x12x\n\x16verification_mail_mode\x18\x01 \x01(\x0e\x32S.google.shopping.merchant.accounts.v1.VerificationMailSettings.VerificationMailModeB\x03\xe0\x41\x01\"z\n\x14VerificationMailMode\x12&\n\"VERIFICATION_MAIL_MODE_UNSPECIFIED\x10\x00\x12\x1a\n\x16SEND_VERIFICATION_MAIL\x10\x01\x12\x1e\n\x1aSUPPRESS_VERIFICATION_MAIL\x10\x02\x42\x90\x02\n(com.google.shopping.merchant.accounts.v1B\x1dVerificationMailSettingsProtoP\x01ZJcloud.google.com/go/shopping/merchant/accounts/apiv1/accountspb;accountspb\xaa\x02$Google.Shopping.Merchant.Accounts.V1\xca\x02$Google\\Shopping\\Merchant\\Accounts\\V1\xea\x02(Google::Shopping::Merchant::Accounts::V1b\x06proto3"
11
+
12
+ pool = Google::Protobuf::DescriptorPool.generated_pool
13
+
14
+ begin
15
+ pool.add_serialized_file(descriptor_data)
16
+ rescue TypeError
17
+ # Compatibility code: will be removed in the next major version.
18
+ require 'google/protobuf/descriptor_pb'
19
+ parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
20
+ parsed.clear_dependency
21
+ serialized = parsed.class.encode(parsed)
22
+ file = pool.add_serialized_file(serialized)
23
+ warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
24
+ imports = [
25
+ ]
26
+ imports.each do |type_name, expected_filename|
27
+ import_file = pool.lookup(type_name).file_descriptor
28
+ if import_file.name != expected_filename
29
+ warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
30
+ end
31
+ end
32
+ warn "Each proto file must use a consistent fully-qualified name."
33
+ warn "This will become an error in the next major version."
34
+ end
35
+
36
+ module Google
37
+ module Shopping
38
+ module Merchant
39
+ module Accounts
40
+ module V1
41
+ VerificationMailSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.accounts.v1.VerificationMailSettings").msgclass
42
+ VerificationMailSettings::VerificationMailMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.accounts.v1.VerificationMailSettings.VerificationMailMode").enummodule
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
@@ -22,7 +22,7 @@ module Google
22
22
  module Merchant
23
23
  module Accounts
24
24
  module V1
25
- VERSION = "0.3.1"
25
+ VERSION = "0.3.2"
26
26
  end
27
27
  end
28
28
  end
@@ -22,7 +22,8 @@ module Google
22
22
  module Merchant
23
23
  module Accounts
24
24
  module V1
25
- # The access right.
25
+ # The access right defines the level of permission a
26
+ # user has within a Merchant Center account.
26
27
  module AccessRight
27
28
  # Default value. This value is unused.
28
29
  ACCESS_RIGHT_UNSPECIFIED = 0
@@ -41,7 +42,8 @@ module Google
41
42
  PERFORMANCE_REPORTING = 3
42
43
 
43
44
  # Users with this right have access to Merchant API and its notifications.
44
- # This role is only accessible to accounts that has a developer registration.
45
+ # This role is only accessible to accounts that have a developer
46
+ # registration.
45
47
  API_DEVELOPER = 5
46
48
  end
47
49
  end
@@ -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