REST Resource: userProfiles

  • A UserProfile resource allows you to list DFA user profiles associated with a Google user account, and the profileId is necessary for other API requests.

  • The JSON representation of a UserProfile includes fields such as kind, profileId, userName, accountId, accountName, subAccountId, subAccountName, and etag.

  • Methods for interacting with UserProfile resources include get to retrieve a single profile by ID and list to get a list of profiles for a user.

Resource: UserProfile

A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profileId needs to be specified in other API requests. 

JSON representation
{
  "kind": string,
  "profileId": string,
  "userName": string,
  "accountId": string,
  "accountName": string,
  "subAccountId": string,
  "subAccountName": string,
  "etag": string
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#userProfile"

.

profileId

string (int64 format)

The unique ID of the user profile.

userName

string

The user name.

accountId

string (int64 format)

The account ID to which this profile belongs.

accountName

string

The account name this profile belongs to.

subAccountId

string (int64 format)

The sub account ID this profile belongs to if applicable.

subAccountName

string

The sub account name this profile belongs to if applicable.

etag

string

Etag of this resource.

Methods

get

Gets one user profile by ID.

list

Retrieves list of user profiles for a user.