The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Jan 10th, 2022. All users must migrate to a newer API version by that date.

REST Resource: reports

Resource: Report

Represents a Report resource.

JSON representation
{
  "id": string,
  "ownerProfileId": string,
  "accountId": string,
  "subAccountId": string,
  "name": string,
  "fileName": string,
  "kind": string,
  "type": enum (Type),
  "etag": string,
  "lastModifiedTime": string,
  "format": enum (Format),
  "criteria": {
    "dateRange": {
      object (DateRange)
    },
    "dimensions": [
      {
        object (SortedDimension)
      }
    ],
    "metricNames": [
      string
    ],
    "dimensionFilters": [
      {
        object (DimensionValue)
      }
    ],
    "activities": {
      object (Activities)
    },
    "customRichMediaEvents": {
      object (CustomRichMediaEvents)
    }
  },
  "schedule": {
    "active": boolean,
    "repeats": string,
    "repeatsOnWeekDays": [
      enum (RepeatsOnWeekDays)
    ],
    "every": integer,
    "startDate": string,
    "expirationDate": string,
    "runsOnDayOfMonth": enum (RunsOnDayOfMonth)
  },
  "reachCriteria": {
    "dateRange": {
      object (DateRange)
    },
    "dimensions": [
      {
        object (SortedDimension)
      }
    ],
    "metricNames": [
      string
    ],
    "dimensionFilters": [
      {
        object (DimensionValue)
      }
    ],
    "activities": {
      object (Activities)
    },
    "customRichMediaEvents": {
      object (CustomRichMediaEvents)
    },
    "reachByFrequencyMetricNames": [
      string
    ],
    "enableAllDimensionCombinations": boolean
  },
  "pathToConversionCriteria": {
    "dateRange": {
      object (DateRange)
    },
    "floodlightConfigId": {
      object (DimensionValue)
    },
    "activityFilters": [
      {
        object (DimensionValue)
      }
    ],
    "conversionDimensions": [
      {
        object (SortedDimension)
      }
    ],
    "perInteractionDimensions": [
      {
        object (SortedDimension)
      }
    ],
    "metricNames": [
      string
    ],
    "customFloodlightVariables": [
      {
        object (SortedDimension)
      }
    ],
    "customRichMediaEvents": [
      {
        object (DimensionValue)
      }
    ],
    "reportProperties": {
      "clicksLookbackWindow": integer,
      "impressionsLookbackWindow": integer,
      "maximumInteractionGap": integer,
      "maximumClickInteractions": integer,
      "maximumImpressionInteractions": integer,
      "pivotOnInteractionPath": boolean,
      "includeAttributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean,
      "includeUnattributedIPConversions": boolean
    }
  },
  "crossDimensionReachCriteria": {
    "dateRange": {
      object (DateRange)
    },
    "dimension": enum (Dimension),
    "pivoted": boolean,
    "dimensionFilters": [
      {
        object (DimensionValue)
      }
    ],
    "breakdown": [
      {
        object (SortedDimension)
      }
    ],
    "metricNames": [
      string
    ],
    "overlapMetricNames": [
      string
    ]
  },
  "floodlightCriteria": {
    "dateRange": {
      object (DateRange)
    },
    "floodlightConfigId": {
      object (DimensionValue)
    },
    "dimensionFilters": [
      {
        object (DimensionValue)
      }
    ],
    "dimensions": [
      {
        object (SortedDimension)
      }
    ],
    "metricNames": [
      string
    ],
    "customRichMediaEvents": [
      {
        object (DimensionValue)
      }
    ],
    "reportProperties": {
      "includeAttributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean,
      "includeUnattributedIPConversions": boolean
    }
  },
  "delivery": {
    "emailOwner": boolean,
    "emailOwnerDeliveryType": enum (EmailOwnerDeliveryType),
    "message": string,
    "recipients": [
      {
        object (Recipient)
      }
    ]
  },
  "pathCriteria": {
    "dateRange": {
      object (DateRange)
    },
    "floodlightConfigId": {
      object (DimensionValue)
    },
    "activityFilters": [
      {
        object (DimensionValue)
      }
    ],
    "customChannelGrouping": {
      object (ChannelGrouping)
    },
    "pathFilters": [
      {
        object (PathFilter)
      }
    ],
    "dimensions": [
      {
        object (SortedDimension)
      }
    ],
    "metricNames": [
      string
    ]
  },
  "pathAttributionCriteria": {
    "dateRange": {
      object (DateRange)
    },
    "floodlightConfigId": {
      object (DimensionValue)
    },
    "activityFilters": [
      {
        object (DimensionValue)
      }
    ],
    "customChannelGrouping": {
      object (ChannelGrouping)
    },
    "pathFilters": [
      {
        object (PathFilter)
      }
    ],
    "dimensions": [
      {
        object (SortedDimension)
      }
    ],
    "metricNames": [
      string
    ]
  }
}
Fields
id

string (int64 format)

The unique ID identifying this report resource.

ownerProfileId

string (int64 format)

The user profile id of the owner of this report.

accountId

string (int64 format)

The account ID to which this report belongs.

subAccountId

string (int64 format)

The subaccount ID to which this report belongs if applicable.

name

string

The name of the report.

fileName

string

The filename used when generating report files for this report.

kind

string

The kind of resource this is, in this case

dfareporting#report

.

type

enum (Type)

The type of the report.

etag

string

The eTag of this response for caching purposes.

lastModifiedTime

string

The timestamp (in milliseconds since epoch) of when this report was last modified.

format

enum (Format)

The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.

criteria

object

The report criteria for a report of type "STANDARD".

criteria.dateRange

object (DateRange)

The date range for which this report should be run.

criteria.dimensions[]

object (SortedDimension)

The list of standard dimensions the report should include.

criteria.metricNames[]

string

The list of names of metrics the report should include.

criteria.dimensionFilters[]

object (DimensionValue)

The list of filters on which dimensions are filtered.

Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

criteria.activities

object (Activities)

Activity group.

criteria.customRichMediaEvents

object (CustomRichMediaEvents)

Custom Rich Media Events group.

schedule

object

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

schedule.active

boolean

Whether the schedule is active or not. Must be set to either true or false.

schedule.repeats

string

The interval for which the report is repeated. Note:

  • "DAILY" also requires field "every" to be set.
  • "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
  • "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.

schedule.repeatsOnWeekDays[]

enum (RepeatsOnWeekDays)

accountPermissionGroups.list of week days "WEEKLY" on which scheduled reports should run.

schedule.every

integer

Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".

schedule.startDate

string

Start date of date range for which scheduled reports should be run.

schedule.expirationDate

string

The expiration date when the scheduled report stops running.

schedule.runsOnDayOfMonth

enum (RunsOnDayOfMonth)

Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month.

Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.

reachCriteria

object

The report criteria for a report of type "REACH".

reachCriteria.dateRange

object (DateRange)

The date range this report should be run for.

reachCriteria.dimensions[]

object (SortedDimension)

The list of dimensions the report should include.

reachCriteria.metricNames[]

string

The list of names of metrics the report should include.

reachCriteria.dimensionFilters[]

object (DimensionValue)

The list of filters on which dimensions are filtered.

Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

reachCriteria.activities

object (Activities)

Activity group.

reachCriteria.customRichMediaEvents

object (CustomRichMediaEvents)

Custom Rich Media Events group.

reachCriteria.reachByFrequencyMetricNames[]

string

The list of names of Reach By Frequency metrics the report should include.

reachCriteria.enableAllDimensionCombinations

boolean

Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.

pathToConversionCriteria

object

The report criteria for a report of type "PATH_TO_CONVERSION".

pathToConversionCriteria.dateRange

object (DateRange)

The date range this report should be run for.

pathToConversionCriteria.floodlightConfigId

object (DimensionValue)

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

pathToConversionCriteria.activityFilters[]

object (DimensionValue)

The list of 'dfa:activity' values to filter on.

pathToConversionCriteria.conversionDimensions[]

object (SortedDimension)

The list of conversion dimensions the report should include.

pathToConversionCriteria.perInteractionDimensions[]

object (SortedDimension)

The list of per interaction dimensions the report should include.

pathToConversionCriteria.metricNames[]

string

The list of names of metrics the report should include.

pathToConversionCriteria.customFloodlightVariables[]

object (SortedDimension)

The list of custom floodlight variables the report should include.

pathToConversionCriteria.customRichMediaEvents[]

object (DimensionValue)

The list of custom rich media events to include.

pathToConversionCriteria.reportProperties

object

The properties of the report.

pathToConversionCriteria.reportProperties.clicksLookbackWindow

integer

CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.

pathToConversionCriteria.reportProperties.impressionsLookbackWindow

integer

CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.

pathToConversionCriteria.reportProperties.maximumInteractionGap

integer

The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.

pathToConversionCriteria.reportProperties.maximumClickInteractions

integer

The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.

pathToConversionCriteria.reportProperties.maximumImpressionInteractions

integer

The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.

pathToConversionCriteria.reportProperties.pivotOnInteractionPath

boolean

Enable pivoting on interaction path.

pathToConversionCriteria.reportProperties.includeAttributedIPConversions

boolean

Deprecated: has no effect.

pathToConversionCriteria.reportProperties.includeUnattributedCookieConversions

boolean

Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.

pathToConversionCriteria.reportProperties.includeUnattributedIPConversions

boolean

Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.

crossDimensionReachCriteria

object

The report criteria for a report of type "CROSS_DIMENSION_REACH".

crossDimensionReachCriteria.dateRange

object (DateRange)

The date range this report should be run for.

crossDimensionReachCriteria.dimension

enum (Dimension)

The dimension option.

crossDimensionReachCriteria.pivoted

boolean

Whether the report is pivoted or not. Defaults to true.

crossDimensionReachCriteria.dimensionFilters[]

object (DimensionValue)

The list of filters on which dimensions are filtered.

crossDimensionReachCriteria.breakdown[]

object (SortedDimension)

The list of dimensions the report should include.

crossDimensionReachCriteria.metricNames[]

string

The list of names of metrics the report should include.

crossDimensionReachCriteria.overlapMetricNames[]

string

The list of names of overlap metrics the report should include.

floodlightCriteria

object

The report criteria for a report of type "FLOODLIGHT".

floodlightCriteria.dateRange

object (DateRange)

The date range this report should be run for.

floodlightCriteria.floodlightConfigId

object (DimensionValue)

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

floodlightCriteria.dimensionFilters[]

object (DimensionValue)

The list of filters on which dimensions are filtered.

Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

floodlightCriteria.dimensions[]

object (SortedDimension)

The list of dimensions the report should include.

floodlightCriteria.metricNames[]

string

The list of names of metrics the report should include.

floodlightCriteria.customRichMediaEvents[]

object (DimensionValue)

The list of custom rich media events to include.

floodlightCriteria.reportProperties

object

The properties of the report.

floodlightCriteria.reportProperties.includeAttributedIPConversions

boolean

Include conversions that have no cookie, but do have an exposure path.

floodlightCriteria.reportProperties.includeUnattributedCookieConversions

boolean

Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.

floodlightCriteria.reportProperties.includeUnattributedIPConversions

boolean

Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.

delivery

object

The report's email delivery settings.

delivery.emailOwner

boolean

Whether the report should be emailed to the report owner.

delivery.emailOwnerDeliveryType

enum (EmailOwnerDeliveryType)

The type of delivery for the owner to receive, if enabled.

delivery.message

string

The message to be sent with each email.

delivery.recipients[]

object (Recipient)

The list of recipients to which to email the report.

pathCriteria

object

The report criteria for a report of type "PATH".

pathCriteria.dateRange

object (DateRange)

The date range this report should be run for.

pathCriteria.floodlightConfigId

object (DimensionValue)

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

pathCriteria.activityFilters[]

object (DimensionValue)

The list of 'dfa:activity' values to filter on.

pathCriteria.customChannelGrouping

object (ChannelGrouping)

Channel Grouping.

pathCriteria.pathFilters[]

object (PathFilter)

Path Filters.

pathCriteria.dimensions[]

object (SortedDimension)

The list of dimensions the report should include.

pathCriteria.metricNames[]

string

The list of names of metrics the report should include.

pathAttributionCriteria

object

The report criteria for a report of type "PATH_ATTRIBUTION".

pathAttributionCriteria.dateRange

object (DateRange)

The date range this report should be run for.

pathAttributionCriteria.floodlightConfigId

object (DimensionValue)

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

pathAttributionCriteria.activityFilters[]

object (DimensionValue)

The list of 'dfa:activity' values to filter on.

pathAttributionCriteria.customChannelGrouping

object (ChannelGrouping)

Channel Grouping.

pathAttributionCriteria.pathFilters[]

object (PathFilter)

Path Filters.

pathAttributionCriteria.dimensions[]

object (SortedDimension)

The list of dimensions the report should include.

pathAttributionCriteria.metricNames[]

string

The list of names of metrics the report should include.

Type

Enums
STANDARD
REACH
PATH_TO_CONVERSION
CROSS_DIMENSION_REACH
FLOODLIGHT
PATH
PATH_ATTRIBUTION

Format

Enums
CSV
EXCEL

Methods

delete

Deletes a report by its ID.

get

Retrieves a report by its ID.

insert

Creates a report.

list

Retrieves list of reports.

patch

Updates an existing report.

run

Runs a report.

update

Updates a report.