Class: Google::Shopping::Merchant::Accounts::V1beta::CreateAndConfigureAccountRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/accounts/v1beta/accounts.rb

Overview

Request message for the CreateAndConfigureAccount method.

Defined Under Namespace

Classes: AcceptTermsOfService, AddAccountService

Instance Attribute Summary collapse

Instance Attribute Details

#accept_terms_of_service ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::CreateAndConfigureAccountRequest::AcceptTermsOfService

Returns Optional. The Terms of Service (ToS) to be accepted immediately upon account creation.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/accounts.rb', line 92

class CreateAndConfigureAccountRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a Terms of Service resource.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The resource name of the terms of service version in the format
  #     `termsOfService/{version}`. To retrieve the latest version, use the
  #     [termsOfService.retrieveLatest](/merchant/api/reference/rest/accounts_v1beta/termsOfService/retrieveLatest)
  #     method.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. Region code as defined by [CLDR](https://cldr.unicode.org/).
  #     This is either a country when the ToS applies specifically to that
  #     country or `001` when it applies globally.
  class AcceptTermsOfService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional instructions to add account services during creation of the
  # account.
  # @!attribute [rw] account_aggregation
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Optional. The provider of the service.
  #     Format: `accounts/{account}`
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#account ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Account

Returns Required. The account to be created.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/accounts.rb', line 92

class CreateAndConfigureAccountRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a Terms of Service resource.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The resource name of the terms of service version in the format
  #     `termsOfService/{version}`. To retrieve the latest version, use the
  #     [termsOfService.retrieveLatest](/merchant/api/reference/rest/accounts_v1beta/termsOfService/retrieveLatest)
  #     method.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. Region code as defined by [CLDR](https://cldr.unicode.org/).
  #     This is either a country when the ToS applies specifically to that
  #     country or `001` when it applies globally.
  class AcceptTermsOfService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional instructions to add account services during creation of the
  # account.
  # @!attribute [rw] account_aggregation
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Optional. The provider of the service.
  #     Format: `accounts/{account}`
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service ⇒ ::Array<::Google::Shopping::Merchant::Accounts::V1beta::CreateAndConfigureAccountRequest::AddAccountService>

Returns Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be account_aggregation, which means you can only create sub accounts, not standalone account through this method. Additional account_management or product_management services may be provided.

Returns:

  • (::Array<::Google::Shopping::Merchant::Accounts::V1beta::CreateAndConfigureAccountRequest::AddAccountService>) —

    Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be account_aggregation, which means you can only create sub accounts, not standalone account through this method. Additional account_management or product_management services may be provided.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/accounts.rb', line 92

class CreateAndConfigureAccountRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a Terms of Service resource.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The resource name of the terms of service version in the format
  #     `termsOfService/{version}`. To retrieve the latest version, use the
  #     [termsOfService.retrieveLatest](/merchant/api/reference/rest/accounts_v1beta/termsOfService/retrieveLatest)
  #     method.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. Region code as defined by [CLDR](https://cldr.unicode.org/).
  #     This is either a country when the ToS applies specifically to that
  #     country or `001` when it applies globally.
  class AcceptTermsOfService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional instructions to add account services during creation of the
  # account.
  # @!attribute [rw] account_aggregation
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Optional. The provider of the service.
  #     Format: `accounts/{account}`
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#users ⇒ ::Array<::Google::Shopping::Merchant::Accounts::V1beta::CreateUserRequest>

Returns Optional. Users to be added to the account.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/accounts.rb', line 92

class CreateAndConfigureAccountRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a Terms of Service resource.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The resource name of the terms of service version in the format
  #     `termsOfService/{version}`. To retrieve the latest version, use the
  #     [termsOfService.retrieveLatest](/merchant/api/reference/rest/accounts_v1beta/termsOfService/retrieveLatest)
  #     method.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. Region code as defined by [CLDR](https://cldr.unicode.org/).
  #     This is either a country when the ToS applies specifically to that
  #     country or `001` when it applies globally.
  class AcceptTermsOfService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional instructions to add account services during creation of the
  # account.
  # @!attribute [rw] account_aggregation
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Optional. The provider of the service.
  #     Format: `accounts/{account}`
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end