AccountUserProfile (Campaign Manager 360 API v5-rev20251009-2.0.0)

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.AccountUserProfile

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class AccountUserProfile
extends com.google.api.client.json.GenericJson
```
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
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

AccountUserProfile()

Constructors
Constructor and Description
`AccountUserProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccountUserProfile`	`clone()`
`Long`	`getAccountId()` Account ID of the user profile.
`Boolean`	`getActive()` Whether this user profile is active.
`ObjectFilter`	`getAdvertiserFilter()` Filter that describes which advertisers are visible to the user profile.
`ObjectFilter`	`getCampaignFilter()` Filter that describes which campaigns are visible to the user profile.
`String`	`getComments()` Comments for this user profile.
`String`	`getEmail()` Email of the user profile.
`Long`	`getId()` ID of the user profile.
`String`	`getKind()` Identifies what kind of resource this is.
`String`	`getLocale()` Locale of the user profile.
`String`	`getName()` Name of the user profile.
`ObjectFilter`	`getSiteFilter()` Filter that describes which sites are visible to the user profile.
`Long`	`getSubaccountId()` Subaccount ID of the user profile.
`String`	`getTraffickerType()` Trafficker type of this user profile.
`String`	`getUserAccessType()` User type of the user profile.
`ObjectFilter`	`getUserRoleFilter()` Filter that describes which user roles are visible to the user profile.
`Long`	`getUserRoleId()` User role ID of the user profile.
`AccountUserProfile`	`set(String fieldName, Object value)`
`AccountUserProfile`	`setAccountId(Long accountId)` Account ID of the user profile.
`AccountUserProfile`	`setActive(Boolean active)` Whether this user profile is active.
`AccountUserProfile`	`setAdvertiserFilter(ObjectFilter advertiserFilter)` Filter that describes which advertisers are visible to the user profile.
`AccountUserProfile`	`setCampaignFilter(ObjectFilter campaignFilter)` Filter that describes which campaigns are visible to the user profile.
`AccountUserProfile`	`setComments(String comments)` Comments for this user profile.
`AccountUserProfile`	`setEmail(String email)` Email of the user profile.
`AccountUserProfile`	`setId(Long id)` ID of the user profile.
`AccountUserProfile`	`setKind(String kind)` Identifies what kind of resource this is.
`AccountUserProfile`	`setLocale(String locale)` Locale of the user profile.
`AccountUserProfile`	`setName(String name)` Name of the user profile.
`AccountUserProfile`	`setSiteFilter(ObjectFilter siteFilter)` Filter that describes which sites are visible to the user profile.
`AccountUserProfile`	`setSubaccountId(Long subaccountId)` Subaccount ID of the user profile.
`AccountUserProfile`	`setTraffickerType(String traffickerType)` Trafficker type of this user profile.
`AccountUserProfile`	`setUserAccessType(String userAccessType)` User type of the user profile.
`AccountUserProfile`	`setUserRoleFilter(ObjectFilter userRoleFilter)` Filter that describes which user roles are visible to the user profile.
`AccountUserProfile`	`setUserRoleId(Long userRoleId)` User role ID of the user profile.

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
  - AccountUserProfile
```
public AccountUserProfile()
```
- Method Detail
  - getAccountId
```
public Long getAccountId()
```
    Account ID of the user profile. This is a read-only field that can be left blank.
    
    Returns:
    
    value or null for none
  - setAccountId
```
public AccountUserProfile setAccountId(Long accountId)
```
    Account ID of the user profile. This is a read-only field that can be left blank.
    
    Parameters:
    
    accountId - accountId or null for none
  - getActive
```
public Boolean getActive()
```
    Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    
    Returns:
    
    value or null for none
  - setActive
```
public AccountUserProfile setActive(Boolean active)
```
    Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    
    Parameters:
    
    active - active or null for none
  - getAdvertiserFilter
```
public ObjectFilter getAdvertiserFilter()
```
    Filter that describes which advertisers are visible to the user profile.
    
    Returns:
    
    value or null for none
  - setAdvertiserFilter
```
public AccountUserProfile setAdvertiserFilter(ObjectFilter advertiserFilter)
```
    Filter that describes which advertisers are visible to the user profile.
    
    Parameters:
    
    advertiserFilter - advertiserFilter or null for none
  - getCampaignFilter
```
public ObjectFilter getCampaignFilter()
```
    Filter that describes which campaigns are visible to the user profile.
    
    Returns:
    
    value or null for none
  - setCampaignFilter
```
public AccountUserProfile setCampaignFilter(ObjectFilter campaignFilter)
```
    Filter that describes which campaigns are visible to the user profile.
    
    Parameters:
    
    campaignFilter - campaignFilter or null for none
  - getComments
```
public String getComments()
```
    Comments for this user profile.
    
    Returns:
    
    value or null for none
  - setComments
```
public AccountUserProfile setComments(String comments)
```
    Comments for this user profile.
    
    Parameters:
    
    comments - comments or null for none
  - getEmail
```
public String getEmail()
```
    Email of the user profile. The email address must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    
    Returns:
    
    value or null for none
  - setEmail
```
public AccountUserProfile setEmail(String email)
```
    Email of the user profile. The email address must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    
    Parameters:
    
    email - email or null for none
  - getId
```
public Long getId()
```
    ID of the user profile. This is a read-only, auto-generated field.
    
    Returns:
    
    value or null for none
  - setId
```
public AccountUserProfile setId(Long id)
```
    ID of the user profile. 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#accountUserProfile".
    
    Returns:
    
    value or null for none
  - setKind
```
public AccountUserProfile setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    
    Parameters:
    
    kind - kind or null for none
  - getLocale
```
public String getLocale()
```
    Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
    
    Returns:
    
    value or null for none
  - setLocale
```
public AccountUserProfile setLocale(String locale)
```
    Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
    
    Parameters:
    
    locale - locale or null for none
  - getName
```
public String getName()
```
    Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
    
    Returns:
    
    value or null for none
  - setName
```
public AccountUserProfile setName(String name)
```
    Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
    
    Parameters:
    
    name - name or null for none
  - getSiteFilter
```
public ObjectFilter getSiteFilter()
```
    Filter that describes which sites are visible to the user profile.
    
    Returns:
    
    value or null for none
  - setSiteFilter
```
public AccountUserProfile setSiteFilter(ObjectFilter siteFilter)
```
    Filter that describes which sites are visible to the user profile.
    
    Parameters:
    
    siteFilter - siteFilter or null for none
  - getSubaccountId
```
public Long getSubaccountId()
```
    Subaccount ID of the user profile. This is a read-only field that can be left blank.
    
    Returns:
    
    value or null for none
  - setSubaccountId
```
public AccountUserProfile setSubaccountId(Long subaccountId)
```
    Subaccount ID of the user profile. This is a read-only field that can be left blank.
    
    Parameters:
    
    subaccountId - subaccountId or null for none
  - getTraffickerType
```
public String getTraffickerType()
```
    Trafficker type of this user profile. This is a read-only field.
    
    Returns:
    
    value or null for none
  - setTraffickerType
```
public AccountUserProfile setTraffickerType(String traffickerType)
```
    Trafficker type of this user profile. This is a read-only field.
    
    Parameters:
    
    traffickerType - traffickerType or null for none
  - getUserAccessType
```
public String getUserAccessType()
```
    User type of the user profile. This is a read-only field that can be left blank.
    
    Returns:
    
    value or null for none
  - setUserAccessType
```
public AccountUserProfile setUserAccessType(String userAccessType)
```
    User type of the user profile. This is a read-only field that can be left blank.
    
    Parameters:
    
    userAccessType - userAccessType or null for none
  - getUserRoleFilter
```
public ObjectFilter getUserRoleFilter()
```
    Filter that describes which user roles are visible to the user profile.
    
    Returns:
    
    value or null for none
  - setUserRoleFilter
```
public AccountUserProfile setUserRoleFilter(ObjectFilter userRoleFilter)
```
    Filter that describes which user roles are visible to the user profile.
    
    Parameters:
    
    userRoleFilter - userRoleFilter or null for none
  - getUserRoleId
```
public Long getUserRoleId()
```
    User role ID of the user profile. This is a required field.
    
    Returns:
    
    value or null for none
  - setUserRoleId
```
public AccountUserProfile setUserRoleId(Long userRoleId)
```
    User role ID of the user profile. This is a required field.
    
    Parameters:
    
    userRoleId - userRoleId or null for none
  - set
```
public AccountUserProfile set(String fieldName,
                              Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public AccountUserProfile clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class AccountUserProfile

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AccountUserProfile

Method Detail

getAccountId

setAccountId

getActive

setActive

getAdvertiserFilter

setAdvertiserFilter

getCampaignFilter

setCampaignFilter

getComments

setComments

getEmail

setEmail

getId

setId

getKind

setKind

getLocale

setLocale

getName

setName

getSiteFilter

setSiteFilter

getSubaccountId

setSubaccountId

getTraffickerType

setTraffickerType

getUserAccessType

setUserAccessType

getUserRoleFilter

setUserRoleFilter

getUserRoleId

setUserRoleId

set

clone