public static final class User.Builder extends GeneratedMessageV3.Builder<User.Builder> implements UserOrBuilderThe User resource.
Protobuf type google.ads.admanager.v1.User
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > User.BuilderImplements
UserOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public User.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
build()
public User build()| Returns | |
|---|---|
| Type | Description |
User |
|
buildPartial()
public User buildPartial()| Returns | |
|---|---|
| Type | Description |
User |
|
clear()
public User.Builder clear()| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
clearActive()
public User.Builder clearActive()Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.
bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearDisplayName()
public User.Builder clearDisplayName()Required. The name of the User. It has a maximum length of 128 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearEmail()
public User.Builder clearEmail()Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearExternalId()
public User.Builder clearExternalId()Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public User.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
clearName()
public User.Builder clearName() Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public User.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
clearOrdersUiLocalTimeZone()
public User.Builder clearOrdersUiLocalTimeZone()Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearRole()
public User.Builder clearRole()Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearServiceAccount()
public User.Builder clearServiceAccount()Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI.
bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clearUserId()
public User.Builder clearUserId() Output only. User ID.
int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
clone()
public User.Builder clone()| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
getActive()
public boolean getActive()Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.
bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The active. |
getDefaultInstanceForType()
public User getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
User |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Required. The name of the User. It has a maximum length of 128 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. The name of the User. It has a maximum length of 128 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEmail()
public String getEmail()Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The email. |
getEmailBytes()
public ByteString getEmailBytes()Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for email. |
getExternalId()
public String getExternalId()Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The externalId. |
getExternalIdBytes()
public ByteString getExternalIdBytes()Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for externalId. |
getName()
public String getName() Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOrdersUiLocalTimeZone()
public String getOrdersUiLocalTimeZone()Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The ordersUiLocalTimeZone. |
getOrdersUiLocalTimeZoneBytes()
public ByteString getOrdersUiLocalTimeZoneBytes()Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for ordersUiLocalTimeZone. |
getRole()
public String getRole()Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The role. |
getRoleBytes()
public ByteString getRoleBytes()Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for role. |
getServiceAccount()
public boolean getServiceAccount()Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI.
bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The serviceAccount. |
getUserId()
public long getUserId() Output only. User ID.
int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The userId. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(User other)
public User.Builder mergeFrom(User other)| Parameter | |
|---|---|
| Name | Description |
other |
User |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public User.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public User.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final User.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
setActive(boolean value)
public User.Builder setActive(boolean value)Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.
bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe active to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setDisplayName(String value)
public User.Builder setDisplayName(String value)Required. The name of the User. It has a maximum length of 128 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public User.Builder setDisplayNameBytes(ByteString value)Required. The name of the User. It has a maximum length of 128 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setEmail(String value)
public User.Builder setEmail(String value)Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe email to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setEmailBytes(ByteString value)
public User.Builder setEmailBytes(ByteString value)Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for email to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setExternalId(String value)
public User.Builder setExternalId(String value)Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe externalId to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setExternalIdBytes(ByteString value)
public User.Builder setExternalIdBytes(ByteString value)Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for externalId to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public User.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
setName(String value)
public User.Builder setName(String value) Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public User.Builder setNameBytes(ByteString value) Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setOrdersUiLocalTimeZone(String value)
public User.Builder setOrdersUiLocalTimeZone(String value)Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe ordersUiLocalTimeZone to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setOrdersUiLocalTimeZoneBytes(ByteString value)
public User.Builder setOrdersUiLocalTimeZoneBytes(ByteString value)Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for ordersUiLocalTimeZone to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public User.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
setRole(String value)
public User.Builder setRole(String value)Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe role to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setRoleBytes(ByteString value)
public User.Builder setRoleBytes(ByteString value)Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for role to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setServiceAccount(boolean value)
public User.Builder setServiceAccount(boolean value)Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI.
bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final User.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
|
setUserId(long value)
public User.Builder setUserId(long value) Output only. User ID.
int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe userId to set. |
| Returns | |
|---|---|
| Type | Description |
User.Builder |
This builder for chaining. |