REST Resource: reports

{
  "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
    ],
    "every": integer,
    "startDate": string,
    "expirationDate": string,
    "runsOnDayOfMonth": enum,
    "timezone": string
  },
  "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,
    "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,
    "message": string,
    "recipients": [
      {
        object (Recipient)
      }
    ]
  },
  "crossMediaReachCriteria": {
    "dateRange": {
      object (DateRange)
    },
    "dimensions": [
      {
        object (SortedDimension)
      }
    ],
    "dimensionFilters": [
      {
        object (DimensionValue)
      }
    ],
    "metricNames": [
      string
    ]
  }
}

string (int64 format)

The unique ID identifying this report resource.

string (int64 format)

The user profile id of the owner of this report.

string (int64 format)

The account ID to which this report belongs.

string (int64 format)

The subaccount ID to which this report belongs if applicable.

string

The name of the report.

string

The filename used when generating report files for this report.

string

The kind of resource this is, in this case

dfareporting#report

.

enum (Type)

The type of the report.

string

The eTag of this response for caching purposes.

string

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

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.

object

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

object (DateRange)

The date range for which this report should be run.

object (SortedDimension)

The list of standard dimensions the report should include.

string

The list of names of metrics the report should include.

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.

object (Activities)

Activity group.

object (CustomRichMediaEvents)

Custom Rich Media Events group.

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

boolean

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

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.

enum

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

Valid values of this enum field are:

SUNDAY

,

MONDAY

,

TUESDAY

,

WEDNESDAY

,

THURSDAY

,

FRIDAY

,

SATURDAY

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

string

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

string

The expiration date when the scheduled report stops running.

enum

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.

Valid values of this enum field are:

DAY_OF_MONTH

,

WEEK_OF_MONTH

string

The timezone when the report will run.

object

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

object (DateRange)

The date range this report should be run for.

object (SortedDimension)

The list of dimensions the report should include.

string

The list of names of metrics the report should include.

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.

object (Activities)

Activity group.

object (CustomRichMediaEvents)

Custom Rich Media Events group.

string

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

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.

object

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

object (DateRange)

The date range this report should be run for.

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

object (DimensionValue)

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

object (SortedDimension)

The list of conversion dimensions the report should include.

object (SortedDimension)

The list of per interaction dimensions the report should include.

string

The list of names of metrics the report should include.

object (SortedDimension)

The list of custom floodlight variables the report should include.

object (DimensionValue)

The list of custom rich media events to include.

object

The properties of the report.

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.

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.

integer

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

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.

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.

boolean

Enable pivoting on interaction path.

boolean

Deprecated: has no effect.

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.

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.

object

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

object (DateRange)

The date range this report should be run for.

enum

The dimension option.

Valid values of this enum field are:

ADVERTISER

,

CAMPAIGN

,

SITE_BY_ADVERTISER

,

SITE_BY_CAMPAIGN

boolean

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

object (DimensionValue)

The list of filters on which dimensions are filtered.

object (SortedDimension)

The list of dimensions the report should include.

string

The list of names of metrics the report should include.

string

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

object

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

object (DateRange)

The date range this report should be run for.

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

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.

object (SortedDimension)

The list of dimensions the report should include.

string

The list of names of metrics the report should include.

object (DimensionValue)

The list of custom rich media events to include.

object

The properties of the report.

boolean

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

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.

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.

object

The report's email delivery settings.

boolean

Whether the report should be emailed to the report owner.

enum

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

Valid values of this enum field are:

LINK

,

ATTACHMENT

string

The message to be sent with each email.

object (Recipient)

The list of recipients to which to email the report.

object

Optional. The report criteria for a report of type "CROSS_MEDIA_REACH".

object (DateRange)

Required. The date range this report should be run for.

object (SortedDimension)

Required. The list of dimensions the report should include.

object (DimensionValue)

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

string

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