List

Retrieves list of reports

6 variables
186 variables

Retrieves list of reports

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage DoubleClick for Advertisers reports

Input

This building block consumes 6 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

The DFA user profile ID

maxResults INTEGER

Maximum number of results to return

pageToken STRING

The value of the nextToken from the previous result page

scope ENUMERATION

The scope that defines which results are returned

sortField ENUMERATION

The field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 186 output parameters

  = Parameter name
  = Format

etag STRING

The eTag of this response for caching purposes

items[] OBJECT

Represents a Report resource

items[].accountId INTEGER

The account ID to which this report belongs

items[].criteria OBJECT

The report criteria for a report of type "STANDARD"

items[].criteria.activities OBJECT

Represents an activity group

items[].criteria.activities.kind STRING

The kind of resource this is, in this case dfareporting#activities

items[].criteria.activities.metricNames[] STRING

items[].criteria.customRichMediaEvents OBJECT

Represents a Custom Rich Media Events group

items[].criteria.customRichMediaEvents.kind STRING

The kind of resource this is, in this case dfareporting#customRichMediaEvents

items[].criteria.dateRange OBJECT

Represents a date range

items[].criteria.dateRange.endDate DATE

The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].criteria.dateRange.kind STRING

The kind of resource this is, in this case dfareporting#dateRange

items[].criteria.dateRange.relativeDateRange ENUMERATION

The date range relative to the date of when the report is run

items[].criteria.dateRange.startDate DATE

The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].criteria.dimensionFilters[] OBJECT

Represents a DimensionValue resource

items[].criteria.dimensionFilters[].dimensionName STRING

The name of the dimension

items[].criteria.dimensionFilters[].etag STRING

The eTag of this response for caching purposes

items[].criteria.dimensionFilters[].id STRING

The ID associated with the value if available

items[].criteria.dimensionFilters[].kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].criteria.dimensionFilters[].matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].criteria.dimensionFilters[].value STRING

The value of the dimension

items[].criteria.dimensions[] OBJECT

Represents a sorted dimension

items[].criteria.dimensions[].kind STRING

The kind of resource this is, in this case dfareporting#sortedDimension

items[].criteria.dimensions[].name STRING

The name of the dimension

items[].criteria.dimensions[].sortOrder ENUMERATION

An optional sort order for the dimension column

items[].criteria.metricNames[] STRING

items[].crossDimensionReachCriteria OBJECT

The report criteria for a report of type "CROSS_DIMENSION_REACH"

items[].crossDimensionReachCriteria.breakdown[] OBJECT

Represents a sorted dimension

items[].crossDimensionReachCriteria.breakdown[].kind STRING

The kind of resource this is, in this case dfareporting#sortedDimension

items[].crossDimensionReachCriteria.breakdown[].name STRING

The name of the dimension

items[].crossDimensionReachCriteria.breakdown[].sortOrder ENUMERATION

An optional sort order for the dimension column

items[].crossDimensionReachCriteria.dateRange OBJECT

Represents a date range

items[].crossDimensionReachCriteria.dateRange.endDate DATE

The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].crossDimensionReachCriteria.dateRange.kind STRING

The kind of resource this is, in this case dfareporting#dateRange

items[].crossDimensionReachCriteria.dateRange.relativeDateRange ENUMERATION

The date range relative to the date of when the report is run

items[].crossDimensionReachCriteria.dateRange.startDate DATE

The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].crossDimensionReachCriteria.dimension ENUMERATION

The dimension option

items[].crossDimensionReachCriteria.dimensionFilters[] OBJECT

Represents a DimensionValue resource

items[].crossDimensionReachCriteria.dimensionFilters[].dimensionName STRING

The name of the dimension

items[].crossDimensionReachCriteria.dimensionFilters[].etag STRING

The eTag of this response for caching purposes

items[].crossDimensionReachCriteria.dimensionFilters[].id STRING

The ID associated with the value if available

items[].crossDimensionReachCriteria.dimensionFilters[].kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].crossDimensionReachCriteria.dimensionFilters[].matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].crossDimensionReachCriteria.dimensionFilters[].value STRING

The value of the dimension

items[].crossDimensionReachCriteria.metricNames[] STRING

items[].crossDimensionReachCriteria.overlapMetricNames[] STRING

items[].crossDimensionReachCriteria.pivoted BOOLEAN

Whether the report is pivoted or not. Defaults to true

items[].delivery OBJECT

The report's email delivery settings

items[].delivery.emailOwner BOOLEAN

Whether the report should be emailed to the report owner

items[].delivery.emailOwnerDeliveryType ENUMERATION

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

items[].delivery.message STRING

The message to be sent with each email

items[].delivery.recipients[] OBJECT

Represents a recipient

items[].delivery.recipients[].deliveryType ENUMERATION

The delivery type for the recipient

items[].delivery.recipients[].email STRING

The email address of the recipient

items[].delivery.recipients[].kind STRING

The kind of resource this is, in this case dfareporting#recipient

items[].etag STRING

The eTag of this response for caching purposes

items[].fileName STRING

The filename used when generating report files for this report

items[].floodlightCriteria OBJECT

The report criteria for a report of type "FLOODLIGHT"

items[].floodlightCriteria.customRichMediaEvents[] OBJECT

Represents a DimensionValue resource

items[].floodlightCriteria.customRichMediaEvents[].dimensionName STRING

The name of the dimension

items[].floodlightCriteria.customRichMediaEvents[].etag STRING

The eTag of this response for caching purposes

items[].floodlightCriteria.customRichMediaEvents[].id STRING

The ID associated with the value if available

items[].floodlightCriteria.customRichMediaEvents[].kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].floodlightCriteria.customRichMediaEvents[].matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].floodlightCriteria.customRichMediaEvents[].value STRING

The value of the dimension

items[].floodlightCriteria.dateRange OBJECT

Represents a date range

items[].floodlightCriteria.dateRange.endDate DATE

The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].floodlightCriteria.dateRange.kind STRING

The kind of resource this is, in this case dfareporting#dateRange

items[].floodlightCriteria.dateRange.relativeDateRange ENUMERATION

The date range relative to the date of when the report is run

items[].floodlightCriteria.dateRange.startDate DATE

The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].floodlightCriteria.dimensionFilters[] OBJECT

Represents a DimensionValue resource

items[].floodlightCriteria.dimensionFilters[].dimensionName STRING

The name of the dimension

items[].floodlightCriteria.dimensionFilters[].etag STRING

The eTag of this response for caching purposes

items[].floodlightCriteria.dimensionFilters[].id STRING

The ID associated with the value if available

items[].floodlightCriteria.dimensionFilters[].kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].floodlightCriteria.dimensionFilters[].matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].floodlightCriteria.dimensionFilters[].value STRING

The value of the dimension

items[].floodlightCriteria.dimensions[] OBJECT

Represents a sorted dimension

items[].floodlightCriteria.dimensions[].kind STRING

The kind of resource this is, in this case dfareporting#sortedDimension

items[].floodlightCriteria.dimensions[].name STRING

The name of the dimension

items[].floodlightCriteria.dimensions[].sortOrder ENUMERATION

An optional sort order for the dimension column

items[].floodlightCriteria.floodlightConfigId OBJECT

Represents a DimensionValue resource

items[].floodlightCriteria.floodlightConfigId.dimensionName STRING

The name of the dimension

items[].floodlightCriteria.floodlightConfigId.etag STRING

The eTag of this response for caching purposes

items[].floodlightCriteria.floodlightConfigId.id STRING

The ID associated with the value if available

items[].floodlightCriteria.floodlightConfigId.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].floodlightCriteria.floodlightConfigId.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].floodlightCriteria.floodlightConfigId.value STRING

The value of the dimension

items[].floodlightCriteria.metricNames[] STRING

items[].floodlightCriteria.reportProperties OBJECT

The properties of the report

items[].floodlightCriteria.reportProperties.includeAttributedIPConversions BOOLEAN

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

items[].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

items[].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

items[].format ENUMERATION

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

items[].id INTEGER

The unique ID identifying this report resource

items[].kind STRING

The kind of resource this is, in this case dfareporting#report

items[].lastModifiedTime INTEGER

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

items[].name STRING

The name of the report

items[].ownerProfileId INTEGER

The user profile id of the owner of this report

items[].pathToConversionCriteria OBJECT

The report criteria for a report of type "PATH_TO_CONVERSION"

items[].pathToConversionCriteria.activityFilters[] OBJECT

Represents a DimensionValue resource

items[].pathToConversionCriteria.activityFilters[].dimensionName STRING

The name of the dimension

items[].pathToConversionCriteria.activityFilters[].etag STRING

The eTag of this response for caching purposes

items[].pathToConversionCriteria.activityFilters[].id STRING

The ID associated with the value if available

items[].pathToConversionCriteria.activityFilters[].kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].pathToConversionCriteria.activityFilters[].matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].pathToConversionCriteria.activityFilters[].value STRING

The value of the dimension

items[].pathToConversionCriteria.conversionDimensions[] OBJECT

Represents a sorted dimension

items[].pathToConversionCriteria.conversionDimensions[].kind STRING

The kind of resource this is, in this case dfareporting#sortedDimension

items[].pathToConversionCriteria.conversionDimensions[].name STRING

The name of the dimension

items[].pathToConversionCriteria.conversionDimensions[].sortOrder ENUMERATION

An optional sort order for the dimension column

items[].pathToConversionCriteria.customFloodlightVariables[] OBJECT

Represents a sorted dimension

items[].pathToConversionCriteria.customFloodlightVariables[].kind STRING

The kind of resource this is, in this case dfareporting#sortedDimension

items[].pathToConversionCriteria.customFloodlightVariables[].name STRING

The name of the dimension

items[].pathToConversionCriteria.customFloodlightVariables[].sortOrder ENUMERATION

An optional sort order for the dimension column

items[].pathToConversionCriteria.customRichMediaEvents[] OBJECT

Represents a DimensionValue resource

items[].pathToConversionCriteria.customRichMediaEvents[].dimensionName STRING

The name of the dimension

items[].pathToConversionCriteria.customRichMediaEvents[].etag STRING

The eTag of this response for caching purposes

items[].pathToConversionCriteria.customRichMediaEvents[].id STRING

The ID associated with the value if available

items[].pathToConversionCriteria.customRichMediaEvents[].kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].pathToConversionCriteria.customRichMediaEvents[].matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].pathToConversionCriteria.customRichMediaEvents[].value STRING

The value of the dimension

items[].pathToConversionCriteria.dateRange OBJECT

Represents a date range

items[].pathToConversionCriteria.dateRange.endDate DATE

The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].pathToConversionCriteria.dateRange.kind STRING

The kind of resource this is, in this case dfareporting#dateRange

items[].pathToConversionCriteria.dateRange.relativeDateRange ENUMERATION

The date range relative to the date of when the report is run

items[].pathToConversionCriteria.dateRange.startDate DATE

The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].pathToConversionCriteria.floodlightConfigId OBJECT

Represents a DimensionValue resource

items[].pathToConversionCriteria.floodlightConfigId.dimensionName STRING

The name of the dimension

items[].pathToConversionCriteria.floodlightConfigId.etag STRING

The eTag of this response for caching purposes

items[].pathToConversionCriteria.floodlightConfigId.id STRING

The ID associated with the value if available

items[].pathToConversionCriteria.floodlightConfigId.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].pathToConversionCriteria.floodlightConfigId.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].pathToConversionCriteria.floodlightConfigId.value STRING

The value of the dimension

items[].pathToConversionCriteria.metricNames[] STRING

items[].pathToConversionCriteria.perInteractionDimensions[] OBJECT

Represents a sorted dimension

items[].pathToConversionCriteria.perInteractionDimensions[].kind STRING

The kind of resource this is, in this case dfareporting#sortedDimension

items[].pathToConversionCriteria.perInteractionDimensions[].name STRING

The name of the dimension

items[].pathToConversionCriteria.perInteractionDimensions[].sortOrder ENUMERATION

An optional sort order for the dimension column

items[].pathToConversionCriteria.reportProperties OBJECT

The properties of the report

items[].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

items[].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

items[].pathToConversionCriteria.reportProperties.includeAttributedIPConversions BOOLEAN

Deprecated: has no effect

items[].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

items[].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

items[].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

items[].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

items[].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

items[].pathToConversionCriteria.reportProperties.pivotOnInteractionPath BOOLEAN

Enable pivoting on interaction path

items[].reachCriteria OBJECT

The report criteria for a report of type "REACH"

items[].reachCriteria.activities OBJECT

Represents an activity group

items[].reachCriteria.activities.kind STRING

The kind of resource this is, in this case dfareporting#activities

items[].reachCriteria.activities.metricNames[] STRING

items[].reachCriteria.customRichMediaEvents OBJECT

Represents a Custom Rich Media Events group

items[].reachCriteria.customRichMediaEvents.kind STRING

The kind of resource this is, in this case dfareporting#customRichMediaEvents

items[].reachCriteria.dateRange OBJECT

Represents a date range

items[].reachCriteria.dateRange.endDate DATE

The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].reachCriteria.dateRange.kind STRING

The kind of resource this is, in this case dfareporting#dateRange

items[].reachCriteria.dateRange.relativeDateRange ENUMERATION

The date range relative to the date of when the report is run

items[].reachCriteria.dateRange.startDate DATE

The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd"

items[].reachCriteria.dimensionFilters[] OBJECT

Represents a DimensionValue resource

items[].reachCriteria.dimensionFilters[].dimensionName STRING

The name of the dimension

items[].reachCriteria.dimensionFilters[].etag STRING

The eTag of this response for caching purposes

items[].reachCriteria.dimensionFilters[].id STRING

The ID associated with the value if available

items[].reachCriteria.dimensionFilters[].kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

items[].reachCriteria.dimensionFilters[].matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

items[].reachCriteria.dimensionFilters[].value STRING

The value of the dimension

items[].reachCriteria.dimensions[] OBJECT

Represents a sorted dimension

items[].reachCriteria.dimensions[].kind STRING

The kind of resource this is, in this case dfareporting#sortedDimension

items[].reachCriteria.dimensions[].name STRING

The name of the dimension

items[].reachCriteria.dimensions[].sortOrder ENUMERATION

An optional sort order for the dimension column

items[].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

items[].reachCriteria.metricNames[] STRING

items[].reachCriteria.reachByFrequencyMetricNames[] STRING

items[].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"

items[].schedule.active BOOLEAN

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

items[].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"

items[].schedule.expirationDate DATE

The expiration date when the scheduled report stops running

items[].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.

items[].schedule.repeatsOnWeekDays[] ENUMERATION

items[].schedule.runsOnDayOfMonth ENUMERATION

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

items[].schedule.startDate DATE

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

items[].subAccountId INTEGER

The subaccount ID to which this report belongs if applicable

items[].type ENUMERATION

The type of the report

kind STRING

The kind of list this is, in this case dfareporting#reportList

nextPageToken STRING

Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted