Method: directorySites.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of directory sites, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/directorySites
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 directory sites with these IDs.
|
maxResults |
integer
Maximum number of results to return.
|
active |
boolean
Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
|
acceptsInterstitialPlacements |
boolean
This search filter is no longer supported and will have no effect on the results returned.
|
acceptsPublisherPaidPlacements |
boolean
Select only directory sites that accept publisher paid placements. This field can be left blank.
|
acceptsInStreamVideoPlacements |
boolean
This search filter is no longer supported and will have no effect on the results returned.
|
dfpNetworkCode |
string
Select only directory sites with this Ad Manager network code.
|
searchString |
string
Allows searching for objects by name, ID or URL. Wildcards (
*
) are allowed. For example,
"directory site*2015"
will return objects with names like
"directory site June 2015"
,
"directory site April 2015"
, or simply
"directory site 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
"directory site"
will match objects with name
"my directory site"
,
"directory site 2015"
or simply,
"directory site"
.
|
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
Directory Site directorySites.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"directorySites": [
{
object (DirectorySite )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#directorySitesListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
directorySites[] |
object (DirectorySite )
Directory site 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 2025-09-02 UTC.
[null,null,["Last updated 2025-09-02 UTC."],[],[],null,["- [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.DirectorySitesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of directory sites, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\nHTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/directorySites`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profileId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\nQuery parameters\n\n| Parameters ||\n|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only directory sites with these IDs. |\n| `maxResults` | `integer` Maximum number of results to return. |\n| `active` | `boolean` Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. |\n| `acceptsInterstitialPlacements` | `boolean` This search filter is no longer supported and will have no effect on the results returned. |\n| `acceptsPublisherPaidPlacements` | `boolean` Select only directory sites that accept publisher paid placements. This field can be left blank. |\n| `acceptsInStreamVideoPlacements` | `boolean` This search filter is no longer supported and will have no effect on the results returned. |\n| `dfpNetworkCode` | `string` Select only directory sites with this Ad Manager network code. |\n| `searchString` | `string` Allows searching for objects by name, ID or URL. Wildcards ( `*` ) are allowed. For example, `\"directory site*2015\"` will return objects with names like `\"directory site June 2015\"` , `\"directory site April 2015\"` , or simply `\"directory site 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 `\"directory site\"` will match objects with name `\"my directory site\"` , `\"directory site 2015\"` or simply, `\"directory site\"` . |\n| `pageToken` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sortField` | `enum (`[SortField](/doubleclick-advertisers/rest/v5/SortField)`)` Field by which to sort the list. |\n| `sortOrder` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v5/SortOrder)`)` Order of sorted results. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body Directory Site directorySites.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"directorySites\": [ { object (/doubleclick-advertisers/rest/v5/directorySites#DirectorySite) } ] } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#directorySitesListResponse\"` . |\n| `nextPageToken` | `string` Pagination token to be used for the next list operation. |\n| `directorySites[]` | `object (`[DirectorySite](/doubleclick-advertisers/rest/v5/directorySites#DirectorySite)`)` Directory site collection. |\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]