GOgoogle
sites

GET /userprofiles/{userprofilesId}/sites

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

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

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 sites that accept publisher paid placements.

adWordsSiteboolean

Select only AdWords sites.

approvedboolean

Select only approved sites.

campaignIdsstring[]

Select only sites with these campaign IDs.

directorySiteIdsstring[]

Select only sites with these directory site IDs.

idsstring[]

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

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

subaccountIdstring int64

Select only sites with this subaccount ID.

unmappedSiteboolean

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

Response

Successful response

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".

nextPageTokenstring

Pagination token to be used for the next list operation.

Changes

No recorded changes to this operation across all 5 revisions of this API.