Requires authorization
Retrieves the list of accounts, possibly filtered. This method supports paging. Try it now.
Request
HTTP request
GET https://www.googleapis.com/dfareporting/v3.2/userprofiles/profileId/accounts
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
profileId |
long |
User profile ID associated with this request. |
Optional query parameters | ||
active |
boolean |
Select only active accounts. Don't set this field to select both active and non-active accounts. |
ids |
long |
Select only accounts with these IDs. |
maxResults |
integer |
Maximum number of results to return.
Acceptable values are 0 to 1000 , inclusive.
(Default: 1000 )
|
pageToken |
string |
Value of the nextPageToken from the previous result page.
|
searchString |
string |
Allows searching for objects by name or ID. Wildcards (* ) are allowed. For example, "account*2015" will return objects with names like "account June 2015" , "account April 2015" , or simply "account 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 "account" will match objects with name "my account" , "account 2015" , or simply "account" .
|
sortField |
string |
Field by which to sort the list.
Acceptable values are:
|
sortOrder |
string |
Order of sorted results.
Acceptable values are:
|
Authorization
This request requires authorization with the following scope (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/dfatrafficking |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "dfareporting#accountsListResponse", "nextPageToken": string, "accounts": [ accounts Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse" . |
|
accounts[] |
list |
Account collection. | |
nextPageToken |
string |
Pagination token to be used for the next list operation. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.