Method: accounts.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves the list of accounts, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/accounts
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
Query parameters
Parameters |
ids[] |
string (int64 format)
Select only accounts with these IDs.
|
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"
.
|
active |
boolean
Select only active accounts. Don't set this field to select both active and non-active accounts.
|
maxResults |
integer
Maximum number of results to return.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
sortField |
enum (SortField )
Field by which to sort the list.
|
sortOrder |
enum (SortOrder )
Order of sorted results.
|
Request body
The request body must be empty.
Response body
Account accounts.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"accounts": [
{
object (Account )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#accountsListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
accounts[] |
object (Account )
Account collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of accounts, with optional filtering and paging.\u003c/p\u003e\n"],["\u003cp\u003eSupports searching by name or ID using wildcards.\u003c/p\u003e\n"],["\u003cp\u003eRequest requires the \u003ccode\u003edfatrafficking\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes account details and pagination information.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AccountsListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves the list of accounts, possibly filtered. This method supports [paging](/doubleclick-accounts/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/accounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only accounts with these IDs. |\n| `search``String` | `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\"` . |\n| `active` | `boolean` Select only active accounts. Don't set this field to select both active and non-active accounts. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nAccount accounts.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"accounts\": [ { object (/doubleclick-advertisers/rest/v4/accounts#Account) } ] } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#accountsListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `accounts[]` | `object (`[Account](/doubleclick-advertisers/rest/v4/accounts#Account)`)` Account collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]