Class: Google::Shopping::Merchant::Accounts::V1::CreateAndConfigureAccountRequest

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

Overview

Request message for the CreateAndConfigureAccount method.

Defined Under Namespace

Classes: AddAccountService, AddUser, SetAliasForRelationship

Instance Attribute Summary collapse

Instance Attribute Details

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 109

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

  # Instruction for adding a user to the account during creation.
  # @!attribute [rw] user_id
  #   @return [::String]
  #     Required. The email address of the user (for example,
  #     `[email protected]`).
  # @!attribute [rw] user
  #   @return [::Google::Shopping::Merchant::Accounts::V1::User]
  #     Optional. Details about the user to be added. At the moment, only access
  #     rights may be specified.
  # @!attribute [rw] verification_mail_settings
  #   @return [::Google::Shopping::Merchant::Accounts::V1::VerificationMailSettings]
  #     Optional. Settings related to configuring the verification email that is
  #     sent after adding a user.
  class AddUser
    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::V1::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  #
  #     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.
  # @!attribute [rw] account_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::AccountManagement]
  #     The provider manages this account. Payload for service type Account
  #     Management.
  #
  #     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.
  # @!attribute [rw] comparison_shopping
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ComparisonShopping]
  #     The provider is a CSS (Comparison Shopping Service) of this account.
  #     Payload for service type Comparison Shopping.
  #
  #     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.
  # @!attribute [rw] products_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ProductsManagement]
  #     The provider manages products for this account. Payload for service
  #     type products management.
  #
  #     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.
  # @!attribute [rw] campaigns_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement]
  #     The provider manages campaigns for this account. Payload for service
  #     type campaigns management.
  #
  #     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.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. Either the reference to an account
  #     such as `providers/123` or a well-known service provider (one of
  #     `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
  # @!attribute [rw] external_account_id
  #   @return [::String]
  #     Immutable. An optional, immutable identifier that Google uses to refer to
  #     this account when communicating with the provider. This should be the
  #     unique account ID within the provider's system (for example, your shop ID
  #     in Shopify).
  #
  #     If you have multiple accounts with the same provider - for instance,
  #     different accounts for various regions — the `external_account_id`
  #     differentiates between them, ensuring accurate linking and integration
  #     between Google and the provider.
  #
  #     The external account ID must be specified for the campaigns management
  #     service type.
  #
  #     The external account ID must not be specified for the account aggregation
  #     service type.
  #
  #     The external account ID is optional / may be specified for all other
  #     service types.
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set an alias for a relationship between a provider and the account to
  # be created.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. This is a reference to an account
  #     such as `providers/123` or `accounts/123`. The same provider must be
  #     specified in at least one of the `service` fields.
  # @!attribute [rw] account_id_alias
  #   @return [::String]
  #     Required. The unique ID of this account in the provider's system.
  #     The value must be unique across all accounts on the platform for this
  #     provider.
  class SetAliasForRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 109

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

  # Instruction for adding a user to the account during creation.
  # @!attribute [rw] user_id
  #   @return [::String]
  #     Required. The email address of the user (for example,
  #     `[email protected]`).
  # @!attribute [rw] user
  #   @return [::Google::Shopping::Merchant::Accounts::V1::User]
  #     Optional. Details about the user to be added. At the moment, only access
  #     rights may be specified.
  # @!attribute [rw] verification_mail_settings
  #   @return [::Google::Shopping::Merchant::Accounts::V1::VerificationMailSettings]
  #     Optional. Settings related to configuring the verification email that is
  #     sent after adding a user.
  class AddUser
    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::V1::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  #
  #     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.
  # @!attribute [rw] account_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::AccountManagement]
  #     The provider manages this account. Payload for service type Account
  #     Management.
  #
  #     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.
  # @!attribute [rw] comparison_shopping
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ComparisonShopping]
  #     The provider is a CSS (Comparison Shopping Service) of this account.
  #     Payload for service type Comparison Shopping.
  #
  #     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.
  # @!attribute [rw] products_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ProductsManagement]
  #     The provider manages products for this account. Payload for service
  #     type products management.
  #
  #     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.
  # @!attribute [rw] campaigns_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement]
  #     The provider manages campaigns for this account. Payload for service
  #     type campaigns management.
  #
  #     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.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. Either the reference to an account
  #     such as `providers/123` or a well-known service provider (one of
  #     `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
  # @!attribute [rw] external_account_id
  #   @return [::String]
  #     Immutable. An optional, immutable identifier that Google uses to refer to
  #     this account when communicating with the provider. This should be the
  #     unique account ID within the provider's system (for example, your shop ID
  #     in Shopify).
  #
  #     If you have multiple accounts with the same provider - for instance,
  #     different accounts for various regions — the `external_account_id`
  #     differentiates between them, ensuring accurate linking and integration
  #     between Google and the provider.
  #
  #     The external account ID must be specified for the campaigns management
  #     service type.
  #
  #     The external account ID must not be specified for the account aggregation
  #     service type.
  #
  #     The external account ID is optional / may be specified for all other
  #     service types.
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set an alias for a relationship between a provider and the account to
  # be created.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. This is a reference to an account
  #     such as `providers/123` or `accounts/123`. The same provider must be
  #     specified in at least one of the `service` fields.
  # @!attribute [rw] account_id_alias
  #   @return [::String]
  #     Required. The unique ID of this account in the provider's system.
  #     The value must be unique across all accounts on the platform for this
  #     provider.
  class SetAliasForRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#set_alias ⇒ ::Array<::Google::Shopping::Merchant::Accounts::V1::CreateAndConfigureAccountRequest::SetAliasForRelationship> 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 109

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

  # Instruction for adding a user to the account during creation.
  # @!attribute [rw] user_id
  #   @return [::String]
  #     Required. The email address of the user (for example,
  #     `[email protected]`).
  # @!attribute [rw] user
  #   @return [::Google::Shopping::Merchant::Accounts::V1::User]
  #     Optional. Details about the user to be added. At the moment, only access
  #     rights may be specified.
  # @!attribute [rw] verification_mail_settings
  #   @return [::Google::Shopping::Merchant::Accounts::V1::VerificationMailSettings]
  #     Optional. Settings related to configuring the verification email that is
  #     sent after adding a user.
  class AddUser
    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::V1::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  #
  #     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.
  # @!attribute [rw] account_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::AccountManagement]
  #     The provider manages this account. Payload for service type Account
  #     Management.
  #
  #     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.
  # @!attribute [rw] comparison_shopping
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ComparisonShopping]
  #     The provider is a CSS (Comparison Shopping Service) of this account.
  #     Payload for service type Comparison Shopping.
  #
  #     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.
  # @!attribute [rw] products_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ProductsManagement]
  #     The provider manages products for this account. Payload for service
  #     type products management.
  #
  #     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.
  # @!attribute [rw] campaigns_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement]
  #     The provider manages campaigns for this account. Payload for service
  #     type campaigns management.
  #
  #     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.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. Either the reference to an account
  #     such as `providers/123` or a well-known service provider (one of
  #     `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
  # @!attribute [rw] external_account_id
  #   @return [::String]
  #     Immutable. An optional, immutable identifier that Google uses to refer to
  #     this account when communicating with the provider. This should be the
  #     unique account ID within the provider's system (for example, your shop ID
  #     in Shopify).
  #
  #     If you have multiple accounts with the same provider - for instance,
  #     different accounts for various regions — the `external_account_id`
  #     differentiates between them, ensuring accurate linking and integration
  #     between Google and the provider.
  #
  #     The external account ID must be specified for the campaigns management
  #     service type.
  #
  #     The external account ID must not be specified for the account aggregation
  #     service type.
  #
  #     The external account ID is optional / may be specified for all other
  #     service types.
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set an alias for a relationship between a provider and the account to
  # be created.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. This is a reference to an account
  #     such as `providers/123` or `accounts/123`. The same provider must be
  #     specified in at least one of the `service` fields.
  # @!attribute [rw] account_id_alias
  #   @return [::String]
  #     Required. The unique ID of this account in the provider's system.
  #     The value must be unique across all accounts on the platform for this
  #     provider.
  class SetAliasForRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user ⇒ ::Array<::Google::Shopping::Merchant::Accounts::V1::CreateAndConfigureAccountRequest::AddUser> 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 109

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

  # Instruction for adding a user to the account during creation.
  # @!attribute [rw] user_id
  #   @return [::String]
  #     Required. The email address of the user (for example,
  #     `[email protected]`).
  # @!attribute [rw] user
  #   @return [::Google::Shopping::Merchant::Accounts::V1::User]
  #     Optional. Details about the user to be added. At the moment, only access
  #     rights may be specified.
  # @!attribute [rw] verification_mail_settings
  #   @return [::Google::Shopping::Merchant::Accounts::V1::VerificationMailSettings]
  #     Optional. Settings related to configuring the verification email that is
  #     sent after adding a user.
  class AddUser
    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::V1::AccountAggregation]
  #     The provider is an
  #     [aggregator](https://support.google.com/merchants/answer/188487) for
  #     the account. Payload for service type Account Aggregation.
  #
  #     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.
  # @!attribute [rw] account_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::AccountManagement]
  #     The provider manages this account. Payload for service type Account
  #     Management.
  #
  #     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.
  # @!attribute [rw] comparison_shopping
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ComparisonShopping]
  #     The provider is a CSS (Comparison Shopping Service) of this account.
  #     Payload for service type Comparison Shopping.
  #
  #     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.
  # @!attribute [rw] products_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::ProductsManagement]
  #     The provider manages products for this account. Payload for service
  #     type products management.
  #
  #     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.
  # @!attribute [rw] campaigns_management
  #   @return [::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement]
  #     The provider manages campaigns for this account. Payload for service
  #     type campaigns management.
  #
  #     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.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. Either the reference to an account
  #     such as `providers/123` or a well-known service provider (one of
  #     `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
  # @!attribute [rw] external_account_id
  #   @return [::String]
  #     Immutable. An optional, immutable identifier that Google uses to refer to
  #     this account when communicating with the provider. This should be the
  #     unique account ID within the provider's system (for example, your shop ID
  #     in Shopify).
  #
  #     If you have multiple accounts with the same provider - for instance,
  #     different accounts for various regions — the `external_account_id`
  #     differentiates between them, ensuring accurate linking and integration
  #     between Google and the provider.
  #
  #     The external account ID must be specified for the campaigns management
  #     service type.
  #
  #     The external account ID must not be specified for the account aggregation
  #     service type.
  #
  #     The external account ID is optional / may be specified for all other
  #     service types.
  class AddAccountService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set an alias for a relationship between a provider and the account to
  # be created.
  # @!attribute [rw] provider
  #   @return [::String]
  #     Required. The provider of the service. This is a reference to an account
  #     such as `providers/123` or `accounts/123`. The same provider must be
  #     specified in at least one of the `service` fields.
  # @!attribute [rw] account_id_alias
  #   @return [::String]
  #     Required. The unique ID of this account in the provider's system.
  #     The value must be unique across all accounts on the platform for this
  #     provider.
  class SetAliasForRelationship
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end