- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
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 |
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only sites with these IDs. |
directorySiteIds[] |
Select only sites with these directory site IDs. |
subaccountId |
Select only sites with this subaccount ID. |
approved |
Select only approved sites. |
acceptsInterstitialPlacements |
This search filter is no longer supported and will have no effect on the results returned. |
acceptsPublisherPaidPlacements |
Select only sites that accept publisher paid placements. |
acceptsInStreamVideoPlacements |
This search filter is no longer supported and will have no effect on the results returned. |
adWordsSite |
Select only AdWords sites. |
unmappedSite |
Select only sites that have not been mapped to a directory site. |
campaignIds[] |
Select only sites with these campaign IDs. |
maxResults |
Maximum number of results to return. |
pageToken |
Value of the
from the previous result page. |
searchString |
Allows searching for objects by name, ID or keyName. Wildcards (
) are allowed. For example,
will return objects with names like
,
, or simply
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
will match objects with name
,
, or simply
. |
sortField |
Field by which to sort the list. |
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 ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
nextPageToken |
Pagination token to be used for the next list operation. |
sites[] |
Site collection. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking