REST Resource: accountUserProfiles

  • The AccountUserProfile resource manages properties of Campaign Manager user profiles, distinct from UserProfiles which is for API access.

  • AccountUserProfile objects have various fields including ID, name, email, account and subaccount IDs, locale, user role ID, and filters for campaigns, sites, user roles, and advertisers.

  • The ObjectFilter resource defines user access to specific objects by specifying their IDs or a status of none, all, or assigned.

  • Available methods for accountUserProfiles include getting, inserting, listing, patching, and updating user profiles.

Resource: AccountUserProfile

AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.

JSON representation 
{
  "id": string,
  "name": string,
  "email": string,
  "accountId": string,
  "subaccountId": string,
  "locale": string,
  "userRoleId": string,
  "userAccessType": enum (UserProfileType),
  "active": boolean,
  "comments": string,
  "traffickerType": enum (TraffickerType),
  "campaignFilter": {
    object (ObjectFilter)
  },
  "siteFilter": {
    object (ObjectFilter)
  },
  "userRoleFilter": {
    object (ObjectFilter)
  },
  "advertiserFilter": {
    object (ObjectFilter)
  },
  "kind": string
}
Fields
id

string (int64 format)

ID of the user profile. This is a read-only, auto-generated field.
name

string

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: "&;<>"#%,".
email

string

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

string (int64 format)

Account ID of the user profile. This is a read-only field that can be left blank.
subaccountId

string (int64 format)

Subaccount ID of the user profile. This is a read-only field that can be left blank.
locale

string

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)

userRoleId

string (int64 format)

User role ID of the user profile. This is a required field.
userAccessType

enum (UserProfileType)

User type of the user profile. This is a read-only field that can be left blank.
active

boolean

Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
comments

string

Comments for this user profile.
traffickerType

enum (TraffickerType)

Trafficker type of this user profile. This is a read-only field.
campaignFilter

object (ObjectFilter)

Filter that describes which campaigns are visible to the user profile.
siteFilter

object (ObjectFilter)

Filter that describes which sites are visible to the user profile.
userRoleFilter

object (ObjectFilter)

Filter that describes which user roles are visible to the user profile.
advertiserFilter

object (ObjectFilter)

Filter that describes which advertisers are visible to the user profile.
kind

string

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

UserProfileType

Type of a user profile.

Enums
NORMAL_USER Normal user managed by the customer.
SUPER_USER Super user managed by internal support teams.
INTERNAL_ADMINISTRATOR Internal administrator having super user access to only a specific set of networks.
READ_ONLY_SUPER_USER A super-user without permission to mutate any data.

TraffickerType

accountUserProfiles.list of trafficker types for any user profile.

Enums
INTERNAL_NON_TRAFFICKER Internal profile, but is not a trafficker.
INTERNAL_TRAFFICKER Internal profile who is a trafficker.
EXTERNAL_TRAFFICKER External profile who is a trafficker.

ObjectFilter

Object Filter.

JSON representation 
{
  "objectIds": [
    string
  ],
  "status": enum (ObjectFilterStatus),
  "kind": string
}
Fields
objectIds[]

string (int64 format)

Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
status

enum (ObjectFilterStatus)

Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
kind

string

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

ObjectFilterStatus

Status of the object filter assigned to a profile.

Enums
NONE Profile has access to none of the objects.
ASSIGNED Profile has access to only specific objects.
ALL Profile has access to all objects.

Methods

get

 Gets one account user profile by ID.

insert

 Inserts a new account user profile.

list

 Retrieves a list of account user profiles, possibly filtered.

patch

 Updates an existing account user profile.

update

 Updates an existing account user profile.