REST Resource: projects

  • The "Resource: Project" section outlines the properties of a Planning project resource.

  • The JSON representation shows the structure and data types for a project resource.

  • The fields section provides descriptions for each property within the Project resource.

  • Enums are defined for PlanningAudienceAgeGroup and PlanningAudienceGender to specify target demographics.

  • The Methods section lists available operations, including getting a single project by ID and listing multiple projects with filtering.

Resource: Project

Contains properties of a Planning project.

JSON representation 
{
  "id": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "name": string,
  "startDate": string,
  "endDate": string,
  "clientName": string,
  "clientBillingCode": string,
  "budget": string,
  "targetCpmNanos": string,
  "targetCpcNanos": string,
  "targetCpaNanos": string,
  "targetImpressions": string,
  "targetClicks": string,
  "targetConversions": string,
  "audienceAgeGroup": enum (PlanningAudienceAgeGroup),
  "audienceGender": enum (PlanningAudienceGender),
  "lastModifiedInfo": {
    object (LastModifiedInfo)
  },
  "overview": string,
  "targetCpmActiveViewNanos": string,
  "kind": string
}
Fields
id

string (int64 format)

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

string (int64 format)

Account ID of this project.
subaccountId

string (int64 format)

Subaccount ID of this project.
advertiserId

string (int64 format)

Advertiser ID of this project.
name

string

Name of this project.
startDate

string

Start date of the project.
endDate

string

End date of the project.
clientName

string

Name of the project client.
clientBillingCode

string

Client billing code of this project.
budget

string (int64 format)

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.
targetCpmNanos

string (int64 format)

CPM that the advertiser is targeting.
targetCpcNanos

string (int64 format)

CPC that the advertiser is targeting.
targetCpaNanos

string (int64 format)

CPA that the advertiser is targeting.
targetImpressions

string (int64 format)

Number of impressions that the advertiser is targeting.
targetClicks

string (int64 format)

Number of clicks that the advertiser is targeting.
targetConversions

string (int64 format)

Number of conversions that the advertiser is targeting.
audienceAgeGroup

enum (PlanningAudienceAgeGroup)

Audience age group of this project.
audienceGender

enum (PlanningAudienceGender)

Audience gender of this project.
lastModifiedInfo

object (LastModifiedInfo)

Information about the most recent modification of this project.
overview

string

Overview of this project.
targetCpmActiveViewNanos

string (int64 format)

vCPM from Active View that the advertiser is targeting.
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#project"

.

PlanningAudienceAgeGroup

Next value = 8

Enums
PLANNING_AUDIENCE_AGE_18_24
PLANNING_AUDIENCE_AGE_25_34
PLANNING_AUDIENCE_AGE_35_44
PLANNING_AUDIENCE_AGE_45_54
PLANNING_AUDIENCE_AGE_55_64
PLANNING_AUDIENCE_AGE_65_OR_MORE
PLANNING_AUDIENCE_AGE_UNKNOWN

PlanningAudienceGender

Next value = 3

Enums
PLANNING_AUDIENCE_GENDER_MALE
PLANNING_AUDIENCE_GENDER_FEMALE

Methods

get

 Gets one project by ID.

list

 Retrieves a list of projects, possibly filtered.