Method: projects.list

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

HTTP request

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

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 projects with these IDs.

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"

.

advertiserIds[]

string ( int64 format)

Select only projects with these advertiser IDs.

maxResults

integer

Maximum number of results to return.

pageToken

string

Value of the

nextPageToken

from the previous result page.

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

Project projects.list Response

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

JSON representation
 { 
 "kind" 
 : 
 string 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "projects" 
 : 
 [ 
 { 
 object (  Project 
 
) 
 } 
 ] 
 } 
Fields
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[]

object ( Project )

Project collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking
Create a Mobile Website
View Site in Mobile | Classic
Share by: