accountUserProfiles

PUT /userprofiles/{userprofilesId}/accountUserProfiles

Updates an existing account user profile.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Request body

accountIdstring int64

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

activeboolean

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

commentsstring

Comments for this user profile.

emailstring

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.

idstring int64

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

kindstring

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

localestring

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)

namestring

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

subaccountIdstring int64

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

traffickerType'INTERNAL_NON_TRAFFICKER' | 'INTERNAL_TRAFFICKER' | 'EXTERNAL_TRAFFICKER'

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

userAccessType'NORMAL_USER' | 'SUPER_USER' | 'INTERNAL_ADMINISTRATOR' | 'READ_ONLY_SUPER_USER'

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

userRoleIdstring int64

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

Response

Successful response

accountIdstring int64

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

activeboolean

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

commentsstring

Comments for this user profile.

emailstring

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.

idstring int64

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

kindstring

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

localestring

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)

namestring

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

subaccountIdstring int64

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

traffickerType'INTERNAL_NON_TRAFFICKER' | 'INTERNAL_TRAFFICKER' | 'EXTERNAL_TRAFFICKER'

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

userAccessType'NORMAL_USER' | 'SUPER_USER' | 'INTERNAL_ADMINISTRATOR' | 'READ_ONLY_SUPER_USER'

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

userRoleIdstring int64

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

Changes

No recorded changes to this operation across all 5 revisions of this API.