Patch

Updates an existing account user profile

30 variables
28 variables

Updates an existing account user profile. This method supports patch semantics

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 30 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

id INTEGER Required

User profile ID

accountId INTEGER

Account ID 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

advertiserFilter OBJECT

Object Filter

advertiserFilter.kind STRING

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

advertiserFilter.objectIds[] INTEGER

advertiserFilter.status ENUMERATION

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

campaignFilter OBJECT

Object Filter

campaignFilter.kind STRING

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

campaignFilter.objectIds[] INTEGER

campaignFilter.status ENUMERATION

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

comments STRING

Comments for this user profile

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

id INTEGER

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

kind STRING

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

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)

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

siteFilter OBJECT

Object Filter

siteFilter.kind STRING

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

siteFilter.objectIds[] INTEGER

siteFilter.status ENUMERATION

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

subaccountId INTEGER

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

traffickerType ENUMERATION

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

userAccessType ENUMERATION

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

userRoleFilter OBJECT

Object Filter

userRoleFilter.kind STRING

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

userRoleFilter.objectIds[] INTEGER

userRoleFilter.status ENUMERATION

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

userRoleId INTEGER

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

Output

This building block provides 28 output parameters

  = Parameter name
  = Format

accountId INTEGER

Account ID 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

advertiserFilter OBJECT

Object Filter

advertiserFilter.kind STRING

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

advertiserFilter.objectIds[] INTEGER

advertiserFilter.status ENUMERATION

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

campaignFilter OBJECT

Object Filter

campaignFilter.kind STRING

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

campaignFilter.objectIds[] INTEGER

campaignFilter.status ENUMERATION

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

comments STRING

Comments for this user profile

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

id INTEGER

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

kind STRING

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

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)

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

siteFilter OBJECT

Object Filter

siteFilter.kind STRING

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

siteFilter.objectIds[] INTEGER

siteFilter.status ENUMERATION

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

subaccountId INTEGER

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

traffickerType ENUMERATION

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

userAccessType ENUMERATION

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

userRoleFilter OBJECT

Object Filter

userRoleFilter.kind STRING

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

userRoleFilter.objectIds[] INTEGER

userRoleFilter.status ENUMERATION

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

userRoleId INTEGER

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