public static final class Account.Builder extends GeneratedMessageV3.Builder<Account.Builder> implements AccountOrBuilder
The Account
message represents a business's account within Shopping
Ads. It's the primary entity for managing product data, settings, and
interactions with Google's services and external providers.
Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts.
Establishing an account involves configuring attributes like the account name, time zone, and language preferences.
The Account
message is the parent entity for many other resources, for
example, AccountRelationship
, Homepage
, BusinessInfo
and so on.
Protobuf type google.shopping.merchant.accounts.v1.Account
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Account.BuilderImplements
AccountOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Account.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Account.Builder |
build()
public Account build()
Returns | |
---|---|
Type | Description |
Account |
buildPartial()
public Account buildPartial()
Returns | |
---|---|
Type | Description |
Account |
clear()
public Account.Builder clear()
Returns | |
---|---|
Type | Description |
Account.Builder |
clearAccountId()
public Account.Builder clearAccountId()
Output only. The ID of the account.
int64 account_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
clearAccountName()
public Account.Builder clearAccountName()
Required. A human-readable name of the account. See store name and business name for more information.
string account_name = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
clearAdultContent()
public Account.Builder clearAdultContent()
Optional. Whether this account contains adult content.
optional bool adult_content = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Account.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Account.Builder |
clearLanguageCode()
public Account.Builder clearLanguageCode()
Required. The account's BCP-47 language
code, such as en-US
or sr-Latn
.
string language_code = 7 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
clearName()
public Account.Builder clearName()
Identifier. The resource name of the account.
Format: accounts/{account}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Account.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Account.Builder |
clearTestAccount()
public Account.Builder clearTestAccount()
Output only. Whether this is a test account.
bool test_account = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
clearTimeZone()
public Account.Builder clearTimeZone()
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Account.Builder |
clone()
public Account.Builder clone()
Returns | |
---|---|
Type | Description |
Account.Builder |
getAccountId()
public long getAccountId()
Output only. The ID of the account.
int64 account_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
long |
The accountId. |
getAccountName()
public String getAccountName()
Required. A human-readable name of the account. See store name and business name for more information.
string account_name = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The accountName. |
getAccountNameBytes()
public ByteString getAccountNameBytes()
Required. A human-readable name of the account. See store name and business name for more information.
string account_name = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for accountName. |
getAdultContent()
public boolean getAdultContent()
Optional. Whether this account contains adult content.
optional bool adult_content = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The adultContent. |
getDefaultInstanceForType()
public Account getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Account |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getLanguageCode()
public String getLanguageCode()
Required. The account's BCP-47 language
code, such as en-US
or sr-Latn
.
string language_code = 7 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The languageCode. |
getLanguageCodeBytes()
public ByteString getLanguageCodeBytes()
Required. The account's BCP-47 language
code, such as en-US
or sr-Latn
.
string language_code = 7 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for languageCode. |
getName()
public String getName()
Identifier. The resource name of the account.
Format: accounts/{account}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name of the account.
Format: accounts/{account}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getTestAccount()
public boolean getTestAccount()
Output only. Whether this is a test account.
bool test_account = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
The testAccount. |
getTimeZone()
public TimeZone getTimeZone()
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
com.google.type.TimeZone |
The timeZone. |
getTimeZoneBuilder()
public TimeZone.Builder getTimeZoneBuilder()
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
com.google.type.TimeZone.Builder |
getTimeZoneOrBuilder()
public TimeZoneOrBuilder getTimeZoneOrBuilder()
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
com.google.type.TimeZoneOrBuilder |
hasAdultContent()
public boolean hasAdultContent()
Optional. Whether this account contains adult content.
optional bool adult_content = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the adultContent field is set. |
hasTimeZone()
public boolean hasTimeZone()
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the timeZone field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Account.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Account.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Account.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Account.Builder |
mergeFrom(Account other)
public Account.Builder mergeFrom(Account other)
Parameter | |
---|---|
Name | Description |
other |
Account |
Returns | |
---|---|
Type | Description |
Account.Builder |
mergeTimeZone(TimeZone value)
public Account.Builder mergeTimeZone(TimeZone value)
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
com.google.type.TimeZone |
Returns | |
---|---|
Type | Description |
Account.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Account.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Account.Builder |
setAccountId(long value)
public Account.Builder setAccountId(long value)
Output only. The ID of the account.
int64 account_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The accountId to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setAccountName(String value)
public Account.Builder setAccountName(String value)
Required. A human-readable name of the account. See store name and business name for more information.
string account_name = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The accountName to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setAccountNameBytes(ByteString value)
public Account.Builder setAccountNameBytes(ByteString value)
Required. A human-readable name of the account. See store name and business name for more information.
string account_name = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for accountName to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setAdultContent(boolean value)
public Account.Builder setAdultContent(boolean value)
Optional. Whether this account contains adult content.
optional bool adult_content = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
boolean The adultContent to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Account.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Account.Builder |
setLanguageCode(String value)
public Account.Builder setLanguageCode(String value)
Required. The account's BCP-47 language
code, such as en-US
or sr-Latn
.
string language_code = 7 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The languageCode to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setLanguageCodeBytes(ByteString value)
public Account.Builder setLanguageCodeBytes(ByteString value)
Required. The account's BCP-47 language
code, such as en-US
or sr-Latn
.
string language_code = 7 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for languageCode to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setName(String value)
public Account.Builder setName(String value)
Identifier. The resource name of the account.
Format: accounts/{account}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Account.Builder setNameBytes(ByteString value)
Identifier. The resource name of the account.
Format: accounts/{account}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Account.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Account.Builder |
setTestAccount(boolean value)
public Account.Builder setTestAccount(boolean value)
Output only. Whether this is a test account.
bool test_account = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
boolean The testAccount to set. |
Returns | |
---|---|
Type | Description |
Account.Builder |
This builder for chaining. |
setTimeZone(TimeZone value)
public Account.Builder setTimeZone(TimeZone value)
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
com.google.type.TimeZone |
Returns | |
---|---|
Type | Description |
Account.Builder |
setTimeZone(TimeZone.Builder builderForValue)
public Account.Builder setTimeZone(TimeZone.Builder builderForValue)
Required. The time zone of the account.
On writes, time_zone
sets both the reporting_time_zone
and the
display_time_zone
.
For reads, time_zone
always returns the display_time_zone
. If
display_time_zone
doesn't exist for your account, time_zone
is empty.
The version
field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
.google.type.TimeZone time_zone = 6 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
com.google.type.TimeZone.Builder |
Returns | |
---|---|
Type | Description |
Account.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Account.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Account.Builder |