GOgoogle
accountUserProfiles

GET /userprofiles/{userprofilesId}/accountUserProfiles

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

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

Query parameters

activeboolean

Select only active user profiles.

idsstring[]

Select only user profiles with these IDs.

maxResultsinteger

Maximum number of results to return.

pageTokenstring

Value of the nextPageToken from the previous result page.

searchStringstring

Allows searching for objects by name, ID or email. Wildcards () are allowed. For example, "user profile2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

subaccountIdstring int64

Select only user profiles with the specified subaccount ID.

userRoleIdstring int64

Select only user profiles with the specified user role ID.

Response

Successful response

kindstring

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

nextPageTokenstring

Pagination token to be used for the next list operation.

Changes

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