Projects: list

Requires authorization

Retrieves a list of projects, possibly filtered. This method supports paging. Try it now.


HTTP request



Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
advertiserIds long Select only projects with these advertiser IDs.
ids long Select only projects 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.
searchString string Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 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 "project" will match projects with name "my project", "project 2015", or simply "project".
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)


This request requires authorization with the following scope (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "dfareporting#projectsListResponse",
  "nextPageToken": string,
  "projects": [
    projects Resource
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
nextPageToken string Pagination token to be used for the next list operation.
projects[] list Project collection.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.