Method: sites.list

  • This method retrieves a list of sites, with optional filtering and paging support.

  • The HTTP request uses a GET method with a specific URL structure including a user profile ID path parameter.

  • Various query parameters are available to filter the list of sites based on criteria like IDs, approval status, placement types, and search strings.

  • The request body must be empty for this method.

  • The successful response body contains a JSON object with a list of site resources, a kind field, and a nextPageToken for pagination.

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

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/sites

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 sites with these IDs.
directorySiteIds[]

string (int64 format)

Select only sites with these directory site IDs.
subaccountId

string (int64 format)

Select only sites with this subaccount ID.
approved

boolean

Select only approved sites.
acceptsInterstitialPlacements

boolean

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

boolean

Select only sites that accept publisher paid placements.
acceptsInStreamVideoPlacements

boolean

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

boolean

Select only AdWords sites.
unmappedSite

boolean

Select only sites that have not been mapped to a directory site.
campaignIds[]

string (int64 format)

Select only sites with these campaign IDs.
maxResults

integer

Maximum number of results to return.
pageToken

string

Value of the

nextPageToken

from the previous result page.
searchString

string

Allows searching for objects by name, ID or keyName. Wildcards (

*

) are allowed. For example,

"site*2015"

will return objects with names like

"site June 2015"

,

"site April 2015"

, or simply

"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

"site"

will match objects with name

"my site"

,

"site 2015"

, or simply

"site"

.
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

Site sites.list Response

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "sites": [
    {
      object (Site)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#sitesListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
sites[]

object (Site)

Site collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking