Class User (0.4.0) 

public final class User extends GeneratedMessageV3 implements UserOrBuilder

The User resource.

Protobuf type google.ads.admanager.v1.User

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > User

Implements

UserOrBuilder

Static Fields

ACTIVE_FIELD_NUMBER

public static final int ACTIVE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EMAIL_FIELD_NUMBER

public static final int EMAIL_FIELD_NUMBER
Field Value
Type Description
int

EXTERNAL_ID_FIELD_NUMBER

public static final int EXTERNAL_ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORDERS_UI_LOCAL_TIME_ZONE_FIELD_NUMBER

public static final int ORDERS_UI_LOCAL_TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static User getDefaultInstance()
Returns
Type Description
User

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static User.Builder newBuilder()
Returns
Type Description
User.Builder

newBuilder(User prototype)

public static User.Builder newBuilder(User prototype)
Parameter
Name Description
prototype User
Returns
Type Description
User.Builder

parseDelimitedFrom(InputStream input)

public static User parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
User
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static User parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static User parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
User
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static User parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static User parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
User
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static User parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static User parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
User
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static User parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static User parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
User
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static User parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static User parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
User
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static User parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<User> parser()
Returns
Type Description
Parser<User>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

getParserForType()

public Parser<User> getParserForType()
Returns
Type Description
Parser<User>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public User.Builder newBuilderForType()
Returns
Type Description
User.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected User.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
User.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public User.Builder toBuilder()
Returns
Type Description
User.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException