com.google.api.services.dfareporting.model

Class UserRole

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.UserRole

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class UserRole
extends com.google.api.client.json.GenericJson

Contains properties of auser role, which is used to manage user access.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Campaign Manager 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
UserRole()

Method Summary

Modifier and Type	Method and Description
UserRole	clone()
Long	getAccountId() Account ID of this user role.
Boolean	getDefaultUserRole() Whether this is a default user role.
Long	getId() ID of this user role.
String	getKind() Identifies what kind of resource this is.
String	getName() Name of this user role.
Long	getParentUserRoleId() ID of the user role that this user role is based on or copied from.
List<UserRolePermission>	getPermissions() List of permissions associated with this user role.
Long	getSubaccountId() Subaccount ID of this user role.
UserRole	set(String fieldName, Object value)
UserRole	setAccountId(Long accountId) Account ID of this user role.
UserRole	setDefaultUserRole(Boolean defaultUserRole) Whether this is a default user role.
UserRole	setId(Long id) ID of this user role.
UserRole	setKind(String kind) Identifies what kind of resource this is.
UserRole	setName(String name) Name of this user role.
UserRole	setParentUserRoleId(Long parentUserRoleId) ID of the user role that this user role is based on or copied from.
UserRole	setPermissions(List<UserRolePermission> permissions) List of permissions associated with this user role.
UserRole	setSubaccountId(Long subaccountId) Subaccount ID of this user role.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

UserRole

public UserRole()

Method Detail

getAccountId

public Long getAccountId()

Account ID of this user role. This is a read-only field that can be left blank.

Returns:

value or null for none

setAccountId

public UserRole setAccountId(Long accountId)

Account ID of this user role. This is a read-only field that can be left blank.

Parameters:

accountId - accountId or null for none

getDefaultUserRole

public Boolean getDefaultUserRole()

Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.

Returns:

value or null for none

setDefaultUserRole

public UserRole setDefaultUserRole(Boolean defaultUserRole)

Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.

Parameters:

defaultUserRole - defaultUserRole or null for none

getId

public Long getId()

ID of this user role. This is a read-only, auto-generated field.

Returns:

value or null for none

setId

public UserRole setId(Long id)

ID of this user role. This is a read-only, auto-generated field.

Parameters:

id - id or null for none

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".

Returns:

value or null for none

setKind

public UserRole setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".

Parameters:

kind - kind or null for none

getName

public String getName()

Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.

Returns:

value or null for none

setName

public UserRole setName(String name)

Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.

Parameters:

name - name or null for none

getParentUserRoleId

public Long getParentUserRoleId()

ID of the user role that this user role is based on or copied from. This is a required field.

Returns:

value or null for none

setParentUserRoleId

public UserRole setParentUserRoleId(Long parentUserRoleId)

ID of the user role that this user role is based on or copied from. This is a required field.

Parameters:

parentUserRoleId - parentUserRoleId or null for none

getPermissions

public List<UserRolePermission> getPermissions()

List of permissions associated with this user role.

Returns:

value or null for none

setPermissions

public UserRole setPermissions(List<UserRolePermission> permissions)

List of permissions associated with this user role.

Parameters:

permissions - permissions or null for none

getSubaccountId

public Long getSubaccountId()

Subaccount ID of this user role. This is a read-only field that can be left blank.

Returns:

value or null for none

setSubaccountId

public UserRole setSubaccountId(Long subaccountId)

Subaccount ID of this user role. This is a read-only field that can be left blank.

Parameters:

subaccountId - subaccountId or null for none

set

public UserRole set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public UserRole clone()

Overrides:

clone in class com.google.api.client.json.GenericJson