Reports.compatibleFields

For a list of methods for this resource, see the end of this page.

Resource representations

Represents a Report resource.

{
  "kind": "dfareporting#report",
  "id": long,
  "etag": etag,
  "lastModifiedTime": unsigned long,
  "ownerProfileId": long,
  "accountId": long,
  "subAccountId": long,
  "name": string,
  "fileName": string,
  "format": string,
  "type": string,
  "criteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "pathToConversionCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "conversionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "perInteractionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customFloodlightVariables": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "clicksLookbackWindow": integer,
      "impressionsLookbackWindow": integer,
      "maximumInteractionGap": integer,
      "maximumClickInteractions": integer,
      "maximumImpressionInteractions": integer,
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean,
      "pivotOnInteractionPath": boolean
    }
  },
  "reachCriteria": {
    "enableAllDimensionCombinations": boolean,
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "reachByFrequencyMetricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "crossDimensionReachCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimension": string,
    "pivoted": boolean,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "breakdown": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "overlapMetricNames": [
      string
    ]
  },
  "floodlightCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ]
  },
  "schedule": {
    "active": boolean,
    "repeats": string,
    "every": integer,
    "repeatsOnWeekDays": [
      string
    ],
    "startDate": date,
    "expirationDate": date,
    "runsOnDayOfMonth": string
  },
  "delivery": {
    "emailOwner": boolean,
    "emailOwnerDeliveryType": string,
    "message": string,
    "recipients": [
      {
        "kind": "dfareporting#recipient",
        "email": string,
        "deliveryType": string
      }
    ]
  }
}
Property name Value Description Notes
accountId long The account ID to which this report belongs.
criteria object The report criteria for a report of type "STANDARD".
criteria.activities nested object Activity group.
criteria.activities.filters[] list List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". writable
criteria.activities.kind string The kind of resource this is, in this case dfareporting#activities.
criteria.activities.metricNames[] list List of names of floodlight activity metrics. writable
criteria.customRichMediaEvents nested object Custom Rich Media Events group.
criteria.customRichMediaEvents.filteredEventIds[] list List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. writable
criteria.customRichMediaEvents.kind string The kind of resource this is, in this case dfareporting#customRichMediaEvents.
criteria.dateRange nested object The date range for which this report should be run.
criteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
criteria.dateRange.kind string The kind of resource this is, in this case dfareporting#dateRange.
criteria.dateRange.relativeDateRange string The date range relative to the date of when the report is run.

Acceptable values are:
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
writable
criteria.dateRange.startDate date The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
criteria.dimensionFilters[] list 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.

writable
criteria.dimensions[] list The list of standard dimensions the report should include. writable
criteria.dimensions[].kind string The kind of resource this is, in this case dfareporting#sortedDimension.
criteria.dimensions[].name string The name of the dimension.
criteria.dimensions[].sortOrder string An optional sort order for the dimension column.

Acceptable values are:
  • "ASCENDING"
  • "DESCENDING"
criteria.metricNames[] list The list of names of metrics the report should include. writable
crossDimensionReachCriteria object The report criteria for a report of type "CROSS_DIMENSION_REACH". writable
crossDimensionReachCriteria.breakdown[] list The list of dimensions the report should include. writable
crossDimensionReachCriteria.breakdown[].kind string The kind of resource this is, in this case dfareporting#sortedDimension.
crossDimensionReachCriteria.breakdown[].name string The name of the dimension.
crossDimensionReachCriteria.breakdown[].sortOrder string An optional sort order for the dimension column.

Acceptable values are:
  • "ASCENDING"
  • "DESCENDING"
crossDimensionReachCriteria.dateRange nested object The date range this report should be run for. writable
crossDimensionReachCriteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
crossDimensionReachCriteria.dateRange.kind string The kind of resource this is, in this case dfareporting#dateRange.
crossDimensionReachCriteria.dateRange.relativeDateRange string The date range relative to the date of when the report is run.

Acceptable values are:
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
writable
crossDimensionReachCriteria.dateRange.startDate date The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
crossDimensionReachCriteria.dimension string The dimension option.

Acceptable values are:
  • "ADVERTISER"
  • "CAMPAIGN"
  • "SITE_BY_ADVERTISER"
  • "SITE_BY_CAMPAIGN"
writable
crossDimensionReachCriteria.dimensionFilters[] list The list of filters on which dimensions are filtered. writable
crossDimensionReachCriteria.metricNames[] list The list of names of metrics the report should include. writable
crossDimensionReachCriteria.overlapMetricNames[] list The list of names of overlap metrics the report should include. writable
crossDimensionReachCriteria.pivoted boolean Whether the report is pivoted or not. Defaults to true. writable
delivery object The report's email delivery settings. writable
delivery.emailOwner boolean Whether the report should be emailed to the report owner. writable
delivery.emailOwnerDeliveryType string The type of delivery for the owner to receive, if enabled.

Acceptable values are:
  • "ATTACHMENT"
  • "LINK"
writable
delivery.message string The message to be sent with each email. writable
delivery.recipients[] list The list of recipients to which to email the report. writable
delivery.recipients[].deliveryType string The delivery type for the recipient.

Acceptable values are:
  • "ATTACHMENT"
  • "LINK"
writable
delivery.recipients[].email string The email address of the recipient. writable
delivery.recipients[].kind string The kind of resource this is, in this case dfareporting#recipient.
etag etag The eTag of this response for caching purposes.
fileName string The filename used when generating report files for this report. writable
floodlightCriteria object The report criteria for a report of type "FLOODLIGHT".
floodlightCriteria.customRichMediaEvents[] list The list of custom rich media events to include.
floodlightCriteria.dateRange nested object The date range this report should be run for.
floodlightCriteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
floodlightCriteria.dateRange.kind string The kind of resource this is, in this case dfareporting#dateRange.
floodlightCriteria.dateRange.relativeDateRange string The date range relative to the date of when the report is run.

Acceptable values are:
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
writable
floodlightCriteria.dateRange.startDate date The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
floodlightCriteria.dimensionFilters[] list 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.

writable
floodlightCriteria.dimensions[] list The list of dimensions the report should include. writable
floodlightCriteria.dimensions[].kind string The kind of resource this is, in this case dfareporting#sortedDimension.
floodlightCriteria.dimensions[].name string The name of the dimension.
floodlightCriteria.dimensions[].sortOrder string An optional sort order for the dimension column.

Acceptable values are:
  • "ASCENDING"
  • "DESCENDING"
floodlightCriteria.floodlightConfigId nested object 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'. writable
floodlightCriteria.metricNames[] list The list of names of metrics the report should include. writable
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.
format string 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.

Acceptable values are:
  • "CSV"
  • "EXCEL"
writable
id long The unique ID identifying this report resource.
kind string The kind of resource this is, in this case dfareporting#report.
lastModifiedTime unsigned long The timestamp (in milliseconds since epoch) of when this report was last modified.
name string The name of the report. writable
ownerProfileId long The user profile id of the owner of this report.
pathToConversionCriteria object The report criteria for a report of type "PATH_TO_CONVERSION".
pathToConversionCriteria.activityFilters[] list The list of 'dfa:activity' values to filter on. writable
pathToConversionCriteria.conversionDimensions[] list The list of conversion dimensions the report should include. writable
pathToConversionCriteria.conversionDimensions[].kind string The kind of resource this is, in this case dfareporting#sortedDimension.
pathToConversionCriteria.conversionDimensions[].name string The name of the dimension.
pathToConversionCriteria.conversionDimensions[].sortOrder string An optional sort order for the dimension column.

Acceptable values are:
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.customFloodlightVariables[] list The list of custom floodlight variables the report should include. writable
pathToConversionCriteria.customFloodlightVariables[].kind string The kind of resource this is, in this case dfareporting#sortedDimension.
pathToConversionCriteria.customFloodlightVariables[].name string The name of the dimension.
pathToConversionCriteria.customFloodlightVariables[].sortOrder string An optional sort order for the dimension column.

Acceptable values are:
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.customRichMediaEvents[] list The list of custom rich media events to include.
pathToConversionCriteria.dateRange nested object The date range this report should be run for.
pathToConversionCriteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
pathToConversionCriteria.dateRange.kind string The kind of resource this is, in this case dfareporting#dateRange.
pathToConversionCriteria.dateRange.relativeDateRange string The date range relative to the date of when the report is run.

Acceptable values are:
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
writable
pathToConversionCriteria.dateRange.startDate date The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
pathToConversionCriteria.floodlightConfigId nested object 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'. writable
pathToConversionCriteria.metricNames[] list The list of names of metrics the report should include. writable
pathToConversionCriteria.perInteractionDimensions[] list The list of per interaction dimensions the report should include. writable
pathToConversionCriteria.perInteractionDimensions[].kind string The kind of resource this is, in this case dfareporting#sortedDimension.
pathToConversionCriteria.perInteractionDimensions[].name string The name of the dimension.
pathToConversionCriteria.perInteractionDimensions[].sortOrder string An optional sort order for the dimension column.

Acceptable values are:
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.reportProperties object The properties of the report.
pathToConversionCriteria.reportProperties.clicksLookbackWindow integer DFA 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 DFA 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.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.
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.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.pivotOnInteractionPath boolean Enable pivoting on interaction path.
reachCriteria object The report criteria for a report of type "REACH".
reachCriteria.activities nested object Activity group.
reachCriteria.activities.filters[] list List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". writable
reachCriteria.activities.kind string The kind of resource this is, in this case dfareporting#activities.
reachCriteria.activities.metricNames[] list List of names of floodlight activity metrics. writable
reachCriteria.customRichMediaEvents nested object Custom Rich Media Events group.
reachCriteria.customRichMediaEvents.filteredEventIds[] list List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. writable
reachCriteria.customRichMediaEvents.kind string The kind of resource this is, in this case dfareporting#customRichMediaEvents.
reachCriteria.dateRange nested object The date range this report should be run for.
reachCriteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
reachCriteria.dateRange.kind string The kind of resource this is, in this case dfareporting#dateRange.
reachCriteria.dateRange.relativeDateRange string The date range relative to the date of when the report is run.

Acceptable values are:
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
writable
reachCriteria.dateRange.startDate date The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
reachCriteria.dimensionFilters[] list 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.

writable
reachCriteria.dimensions[] list The list of dimensions the report should include. writable
reachCriteria.dimensions[].kind string The kind of resource this is, in this case dfareporting#sortedDimension.
reachCriteria.dimensions[].name string The name of the dimension.
reachCriteria.dimensions[].sortOrder string An optional sort order for the dimension column.

Acceptable values are:
  • "ASCENDING"
  • "DESCENDING"
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. writable
reachCriteria.metricNames[] list The list of names of metrics the report should include. writable
reachCriteria.reachByFrequencyMetricNames[] list The list of names of Reach By Frequency metrics the report should include. writable
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". writable
schedule.active boolean Whether the schedule is active or not. Must be set to either true or false. writable
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". writable
schedule.expirationDate date The expiration date when the scheduled report stops running. writable
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.
writable
schedule.repeatsOnWeekDays[] list List of week days "WEEKLY" on which scheduled reports should run. writable
schedule.runsOnDayOfMonth string 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.



Acceptable values are:
  • "DAY_OF_MONTH"
  • "WEEK_OF_MONTH"
writable
schedule.startDate date Start date of date range for which scheduled reports should be run. writable
subAccountId long The subaccount ID to which this report belongs if applicable.
type string The type of the report.

Acceptable values are:
  • "CROSS_DIMENSION_REACH"
  • "FLOODLIGHT"
  • "PATH_TO_CONVERSION"
  • "REACH"
  • "STANDARD"

Methods

query
Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.

Send feedback about...

Campaign Manager
Campaign Manager