v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
directorySites

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

get/userprofiles/{+profileId}/directorySites

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

acceptsInStreamVideoPlacementsboolean

This search filter is no longer supported and will have no effect on the results returned.

acceptsInterstitialPlacementsboolean

This search filter is no longer supported and will have no effect on the results returned.

acceptsPublisherPaidPlacementsboolean

Select only directory sites that accept publisher paid placements. This field can be left blank.

activeboolean

Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.

dfpNetworkCodestring

Select only directory sites with this Ad Manager network code.

idsstring[]

Select only directory sites 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 URL. Wildcards () are allowed. For example, "directory site2015" 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'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

Response

Successful response