REST Resource: accounts.projects

Resource: Project

Represents an MMM data request.

JSON representation
{
  "name": string,
  "projectId": string,
  "createTime": string,
  "caseId": string,
  "displayName": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "regionCode": string,
  "brandLabels": [
    string
  ],
  "reportTypes": [
    enum (ReportType)
  ],
  "dataTimeGranularity": enum (DataTimeGranularity),
  "dataGeoGranularity": enum (DataGeoGranularity),
  "advertiser": string,
  "cadence": enum (Cadence),
  "modelType": enum (ModelType),
  "requestedAdEntities": {
    object (RequestedAdEntities)
  },
  "contactEmail": string
}
Fields
name

string

Output only. Identifier. The unique name of this project resource. Format: accounts/{account}/projects/{project}

projectId

string

Output only. The ID of this project, in the form of a UUID. Corresponds to the {project} segment in the resource name.

createTime

string (Timestamp format)

Output only. The instant when the project was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

caseId

string

Output only. The Case ID associated with this project.

displayName

string

Required. User-defined description of this project.

startDate

object (Date)

Required. The start of the date range covered by the project.

The delivered reports may not include all dates if no campaigns were active on certain days within the range.

endDate

object (Date)

Required. The inclusive end of the date range covered by the project. For recurring projects, the end date is the end date of the last delivery.

The delivered reports may not include all dates if no campaigns were active on certain days within the range.

regionCode

string

Required. The 2-character ISO-3166 region code of the project .

brandLabels[]

string

Required. Brands to measure in the data set, will be supplemented by the brand resource once it is implemented.

reportTypes[]

enum (ReportType)

Required. The reports contained in this project.

dataTimeGranularity

enum (DataTimeGranularity)

Required. The time granularity of the report data.

dataGeoGranularity

enum (DataGeoGranularity)

Required. The geo granularity of the report data.

advertiser

string

The advertiser whose data will be modeled in this project. Not populated if the project is created by an advertiser as it's implied. Format: accounts/{account}/advertisers/{advertiser}

cadence

enum (Cadence)

Required. The frequency in which the project will obtain new data.

modelType

enum (ModelType)

Required. The model that will be used to run the MMM for this project.

requestedAdEntities

object (RequestedAdEntities)

Required. The ad entities that were requested for this project.

contactEmail

string

Required. The email address of the person to contact about this project for any follow-up. This email would be visible to other users belonging to the same MMM Data Platform account.

DataTimeGranularity

Time granularity of the report data.

Enums
DATA_TIME_GRANULARITY_UNSPECIFIED Data aggregated with an undetermined time granularity.
DAILY Data aggregated into daily buckets.
WEEKLY_MONDAY Data aggregated into weekly buckets, with Monday as the start of the week.
WEEKLY_SUNDAY Data aggregated into weekly buckets, with Sunday as the start of the week.

DataGeoGranularity

Geo granularity of the report data.

Enums
DATA_GEO_GRANULARITY_UNSPECIFIED Data aggregated with an undetermined geo granularity.
COUNTRY_LEVEL Data aggregated at the country level.
LOWEST_LEVEL Data aggregated at the lowest possible level, e.g. regional or DMA.

Cadence

The frequency in which a project will be refreshed with new data. Must prefix with CADENCE_ to avoid name collisions with time granularity.

Enums
CADENCE_UNSPECIFIED Project is refreshed at an undetermined cadence.
CADENCE_ONCE A one-off project that is not automatically refreshed.
CADENCE_MONTHLY Project is refreshed at the start of each month.
CADENCE_QUARTERLY Project is refreshed at the start of each quarter, e.g. Jan/Apr/Jul/Oct.
CADENCE_WEEKLY_MONDAY Project is refreshed weekly, on Mondays.
CADENCE_WEEKLY_SUNDAY Project is refreshed weekly, on Sundays.

ModelType

Model that will be used to run the MMM for this project.

Enums
MODEL_TYPE_UNSPECIFIED Unspecified or other model.
MERIDIAN Google's in-house MMM solution (https://developers.google.com/meridian).

RequestedAdEntities

The ad entities that were requested for this project.

JSON representation
{
  "googleAdsCampaignIds": [
    string
  ],
  "dv360InsertionOrderIds": [
    string
  ],
  "dv360LineItemIds": [
    string
  ]
}
Fields
googleAdsCampaignIds[]

string (int64 format)

Optional. A list of Google Ads campaign IDs.

dv360InsertionOrderIds[]

string (int64 format)

Optional. A list of DV360 insertion order IDs.

dv360LineItemIds[]

string (int64 format)

Optional. A list of DV360 line item IDs.

Methods

create

Creates a project.

get

Gets a project.

list

Lists projects.