Get
|
|||||
|
|
||||
Retrieves a report by its ID
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 2 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
The DFA user profile ID |
reportId Required |
INTEGER |
The ID of the report |
= Parameter name
= Format
|
profileId INTEGER Required The DFA user profile ID |
|
reportId INTEGER Required The ID of the report |
Output
This building block provides 210 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
The account ID to which this report belongs |
criteria |
OBJECT |
The report criteria for a report of type "STANDARD" |
criteria.activities |
OBJECT |
Represents an activity group |
criteria.activities.filters[] |
OBJECT |
Represents a DimensionValue resource |
criteria.activities.filters[].dimensionName |
STRING |
The name of the dimension |
criteria.activities.filters[].etag |
STRING |
The eTag of this response for caching purposes |
criteria.activities.filters[].id |
STRING |
The ID associated with the value if available |
criteria.activities.filters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
criteria.activities.filters[].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 |
criteria.activities.filters[].value |
STRING |
The value of the dimension |
criteria.activities.kind |
STRING |
The kind of resource this is, in this case dfareporting#activities |
criteria.activities.metricNames[] |
STRING |
|
criteria.customRichMediaEvents |
OBJECT |
Represents a Custom Rich Media Events group |
criteria.customRichMediaEvents.filteredEventIds[] |
OBJECT |
Represents a DimensionValue resource |
criteria.customRichMediaEvents.filteredEventIds[].dimensionName |
STRING |
The name of the dimension |
criteria.customRichMediaEvents.filteredEventIds[].etag |
STRING |
The eTag of this response for caching purposes |
criteria.customRichMediaEvents.filteredEventIds[].id |
STRING |
The ID associated with the value if available |
criteria.customRichMediaEvents.filteredEventIds[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
criteria.customRichMediaEvents.filteredEventIds[].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 |
criteria.customRichMediaEvents.filteredEventIds[].value |
STRING |
The value of the dimension |
criteria.customRichMediaEvents.kind |
STRING |
The kind of resource this is, in this case dfareporting#customRichMediaEvents |
criteria.dateRange |
OBJECT |
Represents a date range |
criteria.dateRange.endDate |
DATE |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
criteria.dateRange.kind |
STRING |
The kind of resource this is, in this case dfareporting#dateRange |
criteria.dateRange.relativeDateRange |
ENUMERATION |
The date range relative to the date of when the report is run |
criteria.dateRange.startDate |
DATE |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
criteria.dimensionFilters[] |
OBJECT |
Represents a DimensionValue resource |
criteria.dimensionFilters[].dimensionName |
STRING |
The name of the dimension |
criteria.dimensionFilters[].etag |
STRING |
The eTag of this response for caching purposes |
criteria.dimensionFilters[].id |
STRING |
The ID associated with the value if available |
criteria.dimensionFilters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
criteria.dimensionFilters[].value |
STRING |
The value of the dimension |
criteria.dimensions[] |
OBJECT |
Represents a sorted dimension |
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 |
ENUMERATION |
An optional sort order for the dimension column |
criteria.metricNames[] |
STRING |
|
crossDimensionReachCriteria |
OBJECT |
The report criteria for a report of type "CROSS_DIMENSION_REACH" |
crossDimensionReachCriteria.breakdown[] |
OBJECT |
Represents a sorted dimension |
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 |
ENUMERATION |
An optional sort order for the dimension column |
crossDimensionReachCriteria.dateRange |
OBJECT |
Represents a date range |
crossDimensionReachCriteria.dateRange.endDate |
DATE |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
crossDimensionReachCriteria.dateRange.kind |
STRING |
The kind of resource this is, in this case dfareporting#dateRange |
crossDimensionReachCriteria.dateRange.relativeDateRange |
ENUMERATION |
The date range relative to the date of when the report is run |
crossDimensionReachCriteria.dateRange.startDate |
DATE |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
crossDimensionReachCriteria.dimension |
ENUMERATION |
The dimension option |
crossDimensionReachCriteria.dimensionFilters[] |
OBJECT |
Represents a DimensionValue resource |
crossDimensionReachCriteria.dimensionFilters[].dimensionName |
STRING |
The name of the dimension |
crossDimensionReachCriteria.dimensionFilters[].etag |
STRING |
The eTag of this response for caching purposes |
crossDimensionReachCriteria.dimensionFilters[].id |
STRING |
The ID associated with the value if available |
crossDimensionReachCriteria.dimensionFilters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
crossDimensionReachCriteria.dimensionFilters[].value |
STRING |
The value of the dimension |
crossDimensionReachCriteria.metricNames[] |
STRING |
|
crossDimensionReachCriteria.overlapMetricNames[] |
STRING |
|
crossDimensionReachCriteria.pivoted |
BOOLEAN |
Whether the report is pivoted or not. Defaults to true |
delivery |
OBJECT |
The report's email delivery settings |
delivery.emailOwner |
BOOLEAN |
Whether the report should be emailed to the report owner |
delivery.emailOwnerDeliveryType |
ENUMERATION |
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 |
Represents a recipient |
delivery.recipients[].deliveryType |
ENUMERATION |
The delivery type for the recipient |
delivery.recipients[].email |
STRING |
The email address of the recipient |
delivery.recipients[].kind |
STRING |
The kind of resource this is, in this case dfareporting#recipient |
etag |
STRING |
The eTag of this response for caching purposes |
fileName |
STRING |
The filename used when generating report files for this report |
floodlightCriteria |
OBJECT |
The report criteria for a report of type "FLOODLIGHT" |
floodlightCriteria.customRichMediaEvents[] |
OBJECT |
Represents a DimensionValue resource |
floodlightCriteria.customRichMediaEvents[].dimensionName |
STRING |
The name of the dimension |
floodlightCriteria.customRichMediaEvents[].etag |
STRING |
The eTag of this response for caching purposes |
floodlightCriteria.customRichMediaEvents[].id |
STRING |
The ID associated with the value if available |
floodlightCriteria.customRichMediaEvents[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
floodlightCriteria.customRichMediaEvents[].value |
STRING |
The value of the dimension |
floodlightCriteria.dateRange |
OBJECT |
Represents a date range |
floodlightCriteria.dateRange.endDate |
DATE |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
floodlightCriteria.dateRange.kind |
STRING |
The kind of resource this is, in this case dfareporting#dateRange |
floodlightCriteria.dateRange.relativeDateRange |
ENUMERATION |
The date range relative to the date of when the report is run |
floodlightCriteria.dateRange.startDate |
DATE |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
floodlightCriteria.dimensionFilters[] |
OBJECT |
Represents a DimensionValue resource |
floodlightCriteria.dimensionFilters[].dimensionName |
STRING |
The name of the dimension |
floodlightCriteria.dimensionFilters[].etag |
STRING |
The eTag of this response for caching purposes |
floodlightCriteria.dimensionFilters[].id |
STRING |
The ID associated with the value if available |
floodlightCriteria.dimensionFilters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
floodlightCriteria.dimensionFilters[].value |
STRING |
The value of the dimension |
floodlightCriteria.dimensions[] |
OBJECT |
Represents a sorted dimension |
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 |
ENUMERATION |
An optional sort order for the dimension column |
floodlightCriteria.floodlightConfigId |
OBJECT |
Represents a DimensionValue resource |
floodlightCriteria.floodlightConfigId.dimensionName |
STRING |
The name of the dimension |
floodlightCriteria.floodlightConfigId.etag |
STRING |
The eTag of this response for caching purposes |
floodlightCriteria.floodlightConfigId.id |
STRING |
The ID associated with the value if available |
floodlightCriteria.floodlightConfigId.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
floodlightCriteria.floodlightConfigId.value |
STRING |
The value of the dimension |
floodlightCriteria.metricNames[] |
STRING |
|
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 |
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 |
id |
INTEGER |
The unique ID identifying this report resource |
kind |
STRING |
The kind of resource this is, in this case dfareporting#report |
lastModifiedTime |
INTEGER |
The timestamp (in milliseconds since epoch) of when this report was last modified |
name |
STRING |
The name of the report |
ownerProfileId |
INTEGER |
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[] |
OBJECT |
Represents a DimensionValue resource |
pathToConversionCriteria.activityFilters[].dimensionName |
STRING |
The name of the dimension |
pathToConversionCriteria.activityFilters[].etag |
STRING |
The eTag of this response for caching purposes |
pathToConversionCriteria.activityFilters[].id |
STRING |
The ID associated with the value if available |
pathToConversionCriteria.activityFilters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
pathToConversionCriteria.activityFilters[].value |
STRING |
The value of the dimension |
pathToConversionCriteria.conversionDimensions[] |
OBJECT |
Represents a sorted dimension |
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 |
ENUMERATION |
An optional sort order for the dimension column |
pathToConversionCriteria.customFloodlightVariables[] |
OBJECT |
Represents a sorted dimension |
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 |
ENUMERATION |
An optional sort order for the dimension column |
pathToConversionCriteria.customRichMediaEvents[] |
OBJECT |
Represents a DimensionValue resource |
pathToConversionCriteria.customRichMediaEvents[].dimensionName |
STRING |
The name of the dimension |
pathToConversionCriteria.customRichMediaEvents[].etag |
STRING |
The eTag of this response for caching purposes |
pathToConversionCriteria.customRichMediaEvents[].id |
STRING |
The ID associated with the value if available |
pathToConversionCriteria.customRichMediaEvents[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
pathToConversionCriteria.customRichMediaEvents[].value |
STRING |
The value of the dimension |
pathToConversionCriteria.dateRange |
OBJECT |
Represents a date range |
pathToConversionCriteria.dateRange.endDate |
DATE |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
pathToConversionCriteria.dateRange.kind |
STRING |
The kind of resource this is, in this case dfareporting#dateRange |
pathToConversionCriteria.dateRange.relativeDateRange |
ENUMERATION |
The date range relative to the date of when the report is run |
pathToConversionCriteria.dateRange.startDate |
DATE |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
pathToConversionCriteria.floodlightConfigId |
OBJECT |
Represents a DimensionValue resource |
pathToConversionCriteria.floodlightConfigId.dimensionName |
STRING |
The name of the dimension |
pathToConversionCriteria.floodlightConfigId.etag |
STRING |
The eTag of this response for caching purposes |
pathToConversionCriteria.floodlightConfigId.id |
STRING |
The ID associated with the value if available |
pathToConversionCriteria.floodlightConfigId.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
pathToConversionCriteria.floodlightConfigId.value |
STRING |
The value of the dimension |
pathToConversionCriteria.metricNames[] |
STRING |
|
pathToConversionCriteria.perInteractionDimensions[] |
OBJECT |
Represents a sorted dimension |
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 |
ENUMERATION |
An optional sort order for the dimension column |
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 |
OBJECT |
Represents an activity group |
reachCriteria.activities.filters[] |
OBJECT |
Represents a DimensionValue resource |
reachCriteria.activities.filters[].dimensionName |
STRING |
The name of the dimension |
reachCriteria.activities.filters[].etag |
STRING |
The eTag of this response for caching purposes |
reachCriteria.activities.filters[].id |
STRING |
The ID associated with the value if available |
reachCriteria.activities.filters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
reachCriteria.activities.filters[].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 |
reachCriteria.activities.filters[].value |
STRING |
The value of the dimension |
reachCriteria.activities.kind |
STRING |
The kind of resource this is, in this case dfareporting#activities |
reachCriteria.activities.metricNames[] |
STRING |
|
reachCriteria.customRichMediaEvents |
OBJECT |
Represents a Custom Rich Media Events group |
reachCriteria.customRichMediaEvents.filteredEventIds[] |
OBJECT |
Represents a DimensionValue resource |
reachCriteria.customRichMediaEvents.filteredEventIds[].dimensionName |
STRING |
The name of the dimension |
reachCriteria.customRichMediaEvents.filteredEventIds[].etag |
STRING |
The eTag of this response for caching purposes |
reachCriteria.customRichMediaEvents.filteredEventIds[].id |
STRING |
The ID associated with the value if available |
reachCriteria.customRichMediaEvents.filteredEventIds[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
reachCriteria.customRichMediaEvents.filteredEventIds[].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 |
reachCriteria.customRichMediaEvents.filteredEventIds[].value |
STRING |
The value of the dimension |
reachCriteria.customRichMediaEvents.kind |
STRING |
The kind of resource this is, in this case dfareporting#customRichMediaEvents |
reachCriteria.dateRange |
OBJECT |
Represents a date range |
reachCriteria.dateRange.endDate |
DATE |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
reachCriteria.dateRange.kind |
STRING |
The kind of resource this is, in this case dfareporting#dateRange |
reachCriteria.dateRange.relativeDateRange |
ENUMERATION |
The date range relative to the date of when the report is run |
reachCriteria.dateRange.startDate |
DATE |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
reachCriteria.dimensionFilters[] |
OBJECT |
Represents a DimensionValue resource |
reachCriteria.dimensionFilters[].dimensionName |
STRING |
The name of the dimension |
reachCriteria.dimensionFilters[].etag |
STRING |
The eTag of this response for caching purposes |
reachCriteria.dimensionFilters[].id |
STRING |
The ID associated with the value if available |
reachCriteria.dimensionFilters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
reachCriteria.dimensionFilters[].value |
STRING |
The value of the dimension |
reachCriteria.dimensions[] |
OBJECT |
Represents a sorted dimension |
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 |
ENUMERATION |
An optional sort order for the dimension column |
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 |
reachCriteria.metricNames[] |
STRING |
|
reachCriteria.reachByFrequencyMetricNames[] |
STRING |
|
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.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.expirationDate |
DATE |
The expiration date when the scheduled report stops running |
schedule.repeats |
STRING |
The interval for which the report is repeated. Note:
|
schedule.repeatsOnWeekDays[] |
ENUMERATION |
|
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 |
schedule.startDate |
DATE |
Start date of date range for which scheduled reports should be run |
subAccountId |
INTEGER |
The subaccount ID to which this report belongs if applicable |
type |
ENUMERATION |
The type of the report |
= Parameter name
= Format
|
accountId INTEGER The account ID to which this report belongs |
|
criteria OBJECT The report criteria for a report of type "STANDARD" |
|
criteria.activities OBJECT Represents an activity group |
|
criteria.activities.filters[] OBJECT Represents a DimensionValue resource |
|
criteria.activities.filters[].dimensionName STRING The name of the dimension |
|
criteria.activities.filters[].etag STRING The eTag of this response for caching purposes |
|
criteria.activities.filters[].id STRING The ID associated with the value if available |
|
criteria.activities.filters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
criteria.activities.filters[].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 |
|
criteria.activities.filters[].value STRING The value of the dimension |
|
criteria.activities.kind STRING The kind of resource this is, in this case dfareporting#activities |
|
criteria.activities.metricNames[] STRING |
|
criteria.customRichMediaEvents OBJECT Represents a Custom Rich Media Events group |
|
criteria.customRichMediaEvents.filteredEventIds[] OBJECT Represents a DimensionValue resource |
|
criteria.customRichMediaEvents.filteredEventIds[].dimensionName STRING The name of the dimension |
|
criteria.customRichMediaEvents.filteredEventIds[].etag STRING The eTag of this response for caching purposes |
|
criteria.customRichMediaEvents.filteredEventIds[].id STRING The ID associated with the value if available |
|
criteria.customRichMediaEvents.filteredEventIds[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
criteria.customRichMediaEvents.filteredEventIds[].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 |
|
criteria.customRichMediaEvents.filteredEventIds[].value STRING The value of the dimension |
|
criteria.customRichMediaEvents.kind STRING The kind of resource this is, in this case dfareporting#customRichMediaEvents |
|
criteria.dateRange OBJECT Represents a date range |
|
criteria.dateRange.endDate DATE The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
criteria.dateRange.kind STRING The kind of resource this is, in this case dfareporting#dateRange |
|
criteria.dateRange.relativeDateRange ENUMERATION The date range relative to the date of when the report is run |
|
criteria.dateRange.startDate DATE The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
criteria.dimensionFilters[] OBJECT Represents a DimensionValue resource |
|
criteria.dimensionFilters[].dimensionName STRING The name of the dimension |
|
criteria.dimensionFilters[].etag STRING The eTag of this response for caching purposes |
|
criteria.dimensionFilters[].id STRING The ID associated with the value if available |
|
criteria.dimensionFilters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
criteria.dimensionFilters[].value STRING The value of the dimension |
|
criteria.dimensions[] OBJECT Represents a sorted dimension |
|
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 ENUMERATION An optional sort order for the dimension column |
|
criteria.metricNames[] STRING |
|
crossDimensionReachCriteria OBJECT The report criteria for a report of type "CROSS_DIMENSION_REACH" |
|
crossDimensionReachCriteria.breakdown[] OBJECT Represents a sorted dimension |
|
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 ENUMERATION An optional sort order for the dimension column |
|
crossDimensionReachCriteria.dateRange OBJECT Represents a date range |
|
crossDimensionReachCriteria.dateRange.endDate DATE The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
crossDimensionReachCriteria.dateRange.kind STRING The kind of resource this is, in this case dfareporting#dateRange |
|
crossDimensionReachCriteria.dateRange.relativeDateRange ENUMERATION The date range relative to the date of when the report is run |
|
crossDimensionReachCriteria.dateRange.startDate DATE The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
crossDimensionReachCriteria.dimension ENUMERATION The dimension option |
|
crossDimensionReachCriteria.dimensionFilters[] OBJECT Represents a DimensionValue resource |
|
crossDimensionReachCriteria.dimensionFilters[].dimensionName STRING The name of the dimension |
|
crossDimensionReachCriteria.dimensionFilters[].etag STRING The eTag of this response for caching purposes |
|
crossDimensionReachCriteria.dimensionFilters[].id STRING The ID associated with the value if available |
|
crossDimensionReachCriteria.dimensionFilters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
crossDimensionReachCriteria.dimensionFilters[].value STRING The value of the dimension |
|
crossDimensionReachCriteria.metricNames[] STRING |
|
crossDimensionReachCriteria.overlapMetricNames[] STRING |
|
crossDimensionReachCriteria.pivoted BOOLEAN Whether the report is pivoted or not. Defaults to true |
|
delivery OBJECT The report's email delivery settings |
|
delivery.emailOwner BOOLEAN Whether the report should be emailed to the report owner |
|
delivery.emailOwnerDeliveryType ENUMERATION 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 Represents a recipient |
|
delivery.recipients[].deliveryType ENUMERATION The delivery type for the recipient |
|
delivery.recipients[].email STRING The email address of the recipient |
|
delivery.recipients[].kind STRING The kind of resource this is, in this case dfareporting#recipient |
|
etag STRING The eTag of this response for caching purposes |
|
fileName STRING The filename used when generating report files for this report |
|
floodlightCriteria OBJECT The report criteria for a report of type "FLOODLIGHT" |
|
floodlightCriteria.customRichMediaEvents[] OBJECT Represents a DimensionValue resource |
|
floodlightCriteria.customRichMediaEvents[].dimensionName STRING The name of the dimension |
|
floodlightCriteria.customRichMediaEvents[].etag STRING The eTag of this response for caching purposes |
|
floodlightCriteria.customRichMediaEvents[].id STRING The ID associated with the value if available |
|
floodlightCriteria.customRichMediaEvents[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
floodlightCriteria.customRichMediaEvents[].value STRING The value of the dimension |
|
floodlightCriteria.dateRange OBJECT Represents a date range |
|
floodlightCriteria.dateRange.endDate DATE The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
floodlightCriteria.dateRange.kind STRING The kind of resource this is, in this case dfareporting#dateRange |
|
floodlightCriteria.dateRange.relativeDateRange ENUMERATION The date range relative to the date of when the report is run |
|
floodlightCriteria.dateRange.startDate DATE The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
floodlightCriteria.dimensionFilters[] OBJECT Represents a DimensionValue resource |
|
floodlightCriteria.dimensionFilters[].dimensionName STRING The name of the dimension |
|
floodlightCriteria.dimensionFilters[].etag STRING The eTag of this response for caching purposes |
|
floodlightCriteria.dimensionFilters[].id STRING The ID associated with the value if available |
|
floodlightCriteria.dimensionFilters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
floodlightCriteria.dimensionFilters[].value STRING The value of the dimension |
|
floodlightCriteria.dimensions[] OBJECT Represents a sorted dimension |
|
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 ENUMERATION An optional sort order for the dimension column |
|
floodlightCriteria.floodlightConfigId OBJECT Represents a DimensionValue resource |
|
floodlightCriteria.floodlightConfigId.dimensionName STRING The name of the dimension |
|
floodlightCriteria.floodlightConfigId.etag STRING The eTag of this response for caching purposes |
|
floodlightCriteria.floodlightConfigId.id STRING The ID associated with the value if available |
|
floodlightCriteria.floodlightConfigId.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
floodlightCriteria.floodlightConfigId.value STRING The value of the dimension |
|
floodlightCriteria.metricNames[] STRING |
|
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 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 |
|
id INTEGER The unique ID identifying this report resource |
|
kind STRING The kind of resource this is, in this case dfareporting#report |
|
lastModifiedTime INTEGER The timestamp (in milliseconds since epoch) of when this report was last modified |
|
name STRING The name of the report |
|
ownerProfileId INTEGER 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[] OBJECT Represents a DimensionValue resource |
|
pathToConversionCriteria.activityFilters[].dimensionName STRING The name of the dimension |
|
pathToConversionCriteria.activityFilters[].etag STRING The eTag of this response for caching purposes |
|
pathToConversionCriteria.activityFilters[].id STRING The ID associated with the value if available |
|
pathToConversionCriteria.activityFilters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
pathToConversionCriteria.activityFilters[].value STRING The value of the dimension |
|
pathToConversionCriteria.conversionDimensions[] OBJECT Represents a sorted dimension |
|
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 ENUMERATION An optional sort order for the dimension column |
|
pathToConversionCriteria.customFloodlightVariables[] OBJECT Represents a sorted dimension |
|
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 ENUMERATION An optional sort order for the dimension column |
|
pathToConversionCriteria.customRichMediaEvents[] OBJECT Represents a DimensionValue resource |
|
pathToConversionCriteria.customRichMediaEvents[].dimensionName STRING The name of the dimension |
|
pathToConversionCriteria.customRichMediaEvents[].etag STRING The eTag of this response for caching purposes |
|
pathToConversionCriteria.customRichMediaEvents[].id STRING The ID associated with the value if available |
|
pathToConversionCriteria.customRichMediaEvents[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
pathToConversionCriteria.customRichMediaEvents[].value STRING The value of the dimension |
|
pathToConversionCriteria.dateRange OBJECT Represents a date range |
|
pathToConversionCriteria.dateRange.endDate DATE The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
pathToConversionCriteria.dateRange.kind STRING The kind of resource this is, in this case dfareporting#dateRange |
|
pathToConversionCriteria.dateRange.relativeDateRange ENUMERATION The date range relative to the date of when the report is run |
|
pathToConversionCriteria.dateRange.startDate DATE The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
pathToConversionCriteria.floodlightConfigId OBJECT Represents a DimensionValue resource |
|
pathToConversionCriteria.floodlightConfigId.dimensionName STRING The name of the dimension |
|
pathToConversionCriteria.floodlightConfigId.etag STRING The eTag of this response for caching purposes |
|
pathToConversionCriteria.floodlightConfigId.id STRING The ID associated with the value if available |
|
pathToConversionCriteria.floodlightConfigId.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
pathToConversionCriteria.floodlightConfigId.value STRING The value of the dimension |
|
pathToConversionCriteria.metricNames[] STRING |
|
pathToConversionCriteria.perInteractionDimensions[] OBJECT Represents a sorted dimension |
|
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 ENUMERATION An optional sort order for the dimension column |
|
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 OBJECT Represents an activity group |
|
reachCriteria.activities.filters[] OBJECT Represents a DimensionValue resource |
|
reachCriteria.activities.filters[].dimensionName STRING The name of the dimension |
|
reachCriteria.activities.filters[].etag STRING The eTag of this response for caching purposes |
|
reachCriteria.activities.filters[].id STRING The ID associated with the value if available |
|
reachCriteria.activities.filters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
reachCriteria.activities.filters[].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 |
|
reachCriteria.activities.filters[].value STRING The value of the dimension |
|
reachCriteria.activities.kind STRING The kind of resource this is, in this case dfareporting#activities |
|
reachCriteria.activities.metricNames[] STRING |
|
reachCriteria.customRichMediaEvents OBJECT Represents a Custom Rich Media Events group |
|
reachCriteria.customRichMediaEvents.filteredEventIds[] OBJECT Represents a DimensionValue resource |
|
reachCriteria.customRichMediaEvents.filteredEventIds[].dimensionName STRING The name of the dimension |
|
reachCriteria.customRichMediaEvents.filteredEventIds[].etag STRING The eTag of this response for caching purposes |
|
reachCriteria.customRichMediaEvents.filteredEventIds[].id STRING The ID associated with the value if available |
|
reachCriteria.customRichMediaEvents.filteredEventIds[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
reachCriteria.customRichMediaEvents.filteredEventIds[].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 |
|
reachCriteria.customRichMediaEvents.filteredEventIds[].value STRING The value of the dimension |
|
reachCriteria.customRichMediaEvents.kind STRING The kind of resource this is, in this case dfareporting#customRichMediaEvents |
|
reachCriteria.dateRange OBJECT Represents a date range |
|
reachCriteria.dateRange.endDate DATE The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
reachCriteria.dateRange.kind STRING The kind of resource this is, in this case dfareporting#dateRange |
|
reachCriteria.dateRange.relativeDateRange ENUMERATION The date range relative to the date of when the report is run |
|
reachCriteria.dateRange.startDate DATE The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
reachCriteria.dimensionFilters[] OBJECT Represents a DimensionValue resource |
|
reachCriteria.dimensionFilters[].dimensionName STRING The name of the dimension |
|
reachCriteria.dimensionFilters[].etag STRING The eTag of this response for caching purposes |
|
reachCriteria.dimensionFilters[].id STRING The ID associated with the value if available |
|
reachCriteria.dimensionFilters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
reachCriteria.dimensionFilters[].value STRING The value of the dimension |
|
reachCriteria.dimensions[] OBJECT Represents a sorted dimension |
|
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 ENUMERATION An optional sort order for the dimension column |
|
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 |
|
reachCriteria.metricNames[] STRING |
|
reachCriteria.reachByFrequencyMetricNames[] STRING |
|
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.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.expirationDate DATE The expiration date when the scheduled report stops running |
|
schedule.repeats STRING The interval for which the report is repeated. Note:
|
|
schedule.repeatsOnWeekDays[] ENUMERATION |
|
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 |
|
schedule.startDate DATE Start date of date range for which scheduled reports should be run |
|
subAccountId INTEGER The subaccount ID to which this report belongs if applicable |
|
type ENUMERATION The type of the report |