Reports: update

Requires authorization

Updates a report.

Request

HTTP request

PUT https://www.googleapis.com/dfareporting/v2.8/userprofiles/profileId/reports/reportId

Parameters

Parameter name Value Description
Path parameters
profileId long The DFA user profile ID.
reportId long The ID of the report.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/dfareporting

Request body

In the request body, supply a report resource with the following properties:

Property name Value Description Notes
Required Properties
accountId long The account ID to which this report belongs.
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
id long The unique ID identifying this report resource.
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.
schedule.active boolean Whether the schedule is active or not. Must be set to either true or false. 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.startDate date Start date of date range for which scheduled reports should be run. writable
type string The type of the report.

Acceptable values are:
  • "CROSS_DIMENSION_REACH"
  • "FLOODLIGHT"
  • "PATH_TO_CONVERSION"
  • "REACH"
  • "STANDARD"
Optional Properties
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.customRichMediaEvents.filteredEventIds[] list List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. writable
criteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
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.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.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.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
fileName string The filename used when generating report files for this report. writable
floodlightCriteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
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.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
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
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.customFloodlightVariables[] list The list of custom floodlight variables the report should include. writable
pathToConversionCriteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
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
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.customRichMediaEvents.filteredEventIds[] list List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. writable
reachCriteria.dateRange.endDate date The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". writable
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.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 three months. 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.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.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

Response

If successful, this method returns a report resource in the response body.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager