Class User (0.12.0)

  public 
  
 final 
  
 class 
 User 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 UserOrBuilder 
 

The User resource.

Protobuf type google.ads.admanager.v1.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
  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

getDescriptor()

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

newBuilder()

  public 
  
 static 
  
 User 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(User prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
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

The active.

getDefaultInstanceForType()

  public 
  
 User 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

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

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

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

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

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

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

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

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

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

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

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

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

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

The serviceAccount.

getUserId()

  public 
  
 long 
  
 getUserId 
 () 
 

Output only. User ID.

int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

The userId.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 User 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

  public 
  
 User 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: