List

Retrieves a list of projects, possibly filtered

8 variables
26 variables

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 8 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

advertiserIds INTEGER

Select only projects with these advertiser IDs

ids INTEGER

Select only projects with these 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 projects by name or ID. Wildcards () are allowed. For example, "project2015" 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 ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 26 output parameters

  = Parameter name
  = Format

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

Contains properties of a Planning project

projects[].accountId INTEGER

Account ID of this project

projects[].advertiserId INTEGER

Advertiser ID of this project

projects[].audienceAgeGroup ENUMERATION

Audience age group of this project

projects[].audienceGender ENUMERATION

Audience gender of this project

projects[].budget INTEGER

Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar

projects[].clientBillingCode STRING

Client billing code of this project

projects[].clientName STRING

Name of the project client

projects[].endDate DATE

End date of the project

projects[].id INTEGER

ID of this project. This is a read-only, auto-generated field

projects[].kind STRING

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

projects[].lastModifiedInfo OBJECT

Modification timestamp

projects[].lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

projects[].name STRING

Name of this project

projects[].overview STRING

Overview of this project

projects[].startDate DATE

Start date of the project

projects[].subaccountId INTEGER

Subaccount ID of this project

projects[].targetClicks INTEGER

Number of clicks that the advertiser is targeting

projects[].targetConversions INTEGER

Number of conversions that the advertiser is targeting

projects[].targetCpaNanos INTEGER

CPA that the advertiser is targeting

projects[].targetCpcNanos INTEGER

CPC that the advertiser is targeting

projects[].targetCpmActiveViewNanos INTEGER

vCPM from Active View that the advertiser is targeting

projects[].targetCpmNanos INTEGER

CPM that the advertiser is targeting

projects[].targetImpressions INTEGER

Number of impressions that the advertiser is targeting