The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

REST Resource: accountUserProfiles

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 (UserAccessType),
  "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 addresss 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 (UserAccessType)

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"

.

UserAccessType

Enums
NORMAL_USER
SUPER_USER
INTERNAL_ADMINISTRATOR
READ_ONLY_SUPER_USER

TraffickerType

Enums
INTERNAL_NON_TRAFFICKER
INTERNAL_TRAFFICKER
EXTERNAL_TRAFFICKER

ObjectFilter

Object Filter.

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

string (int64 format)

Applicable when

status

is

ASSIGNED

. The user has access to objects with these object IDs.

status

enum (Status)

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"

.

Status

Enums
NONE
ASSIGNED
ALL

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.