The DCM/DFA Reporting and Trafficking API v2.7 is deprecated and will be sunset on November 30th, 2017. All users must migrate to a newer API version by that date.

DirectorySites: list

Requires authorization

Retrieves a list of directory sites, possibly filtered. This method supports paging.

Request

HTTP request

GET https://www.googleapis.com/dfareporting/v2.8/userprofiles/profileId/directorySites

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
acceptsInStreamVideoPlacements boolean This search filter is no longer supported and will have no effect on the results returned.
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.
active boolean Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
countryId long Select only directory sites with this country ID.
dfpNetworkCode string Select only directory sites with this DFP network code.
ids long Select only directory sites 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.
parentId long Select only directory sites with this parent ID.
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".
sortField string Field by which to sort the list.

Acceptable values are:
  • "ID" (default)
  • "NAME"
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING" (default)
  • "DESCENDING"

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#directorySitesListResponse",
  "nextPageToken": string,
  "directorySites": [
    directorySites Resource
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
directorySites[] list Directory site collection.
nextPageToken string Pagination token to be used for the next list operation.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager