Parameters

AI-generated Key Takeaways

A generated report includes parameters such as type, groupBys, filters, metrics, and options.
ReportType defines the type of the report, which influences the dimensions, filters, and metrics that can be used.
FilterPair represents a single filter rule with a type and value to limit the scope of reported data.
Options provide additional report parameters, such as whether to include data for specifically targeted audience lists.

Parameters of a generated report.

JSON representation
{ "type" : enum ( `ReportType` ) , "groupBys" : [ string ] , "filters" : [ { object ( `FilterPair` ) } ] , "metrics" : [ string ] , "options" : { object ( `Options` ) } }

Fields
`type`	`enum ( ReportType )` The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used.
`groupBys[]`	`string` Dimensions by which to segment and group the data. Defined by Filter values.
`filters[]`	`object ( FilterPair )` Filters to limit the scope of reported data.
`metrics[]`	`string` Metrics to define the data populating the report. Defined by Metric values.
`options`	`object ( Options )` Additional report parameter options.

Available types of report.

Enums
`REPORT_TYPE_UNSPECIFIED`	Default value when report type is not specified or is unknown in this version.
`STANDARD`	Standard report.
`INVENTORY_AVAILABILITY`	Inventory Availability report. See the Display & Video 360 Help Center announcement for more information on this deprecation. This item is deprecated!
`AUDIENCE_COMPOSITION`	Audience Composition report. This item is deprecated!
`FLOODLIGHT`	Floodlight report.
`YOUTUBE`	YouTube report.
`GRP`	GRP report.
`YOUTUBE_PROGRAMMATIC_GUARANTEED`	YouTube Programmatic Guaranteed report.
`REACH`	Reach report.
`UNIQUE_REACH_AUDIENCE`	Unique Reach Audience report.
`FULL_PATH`	Full Path report. This item is deprecated!
`PATH_ATTRIBUTION`	Path Attribution report. This item is deprecated!

Represents a single filter rule.

JSON representation
{ "type" : string , "value" : string }

Fields

Fields
`type`	`string` The type of value to filter by. Defined by a Filter value.
`value`	`string` The identifying value to filter by, such as a relevant resource ID.

type

string

The type of value to filter by.

Defined by a Filter value.

value

string

The identifying value to filter by, such as a relevant resource ID.

Report parameter options.

JSON representation
{ "includeOnlyTargetedUserLists" : boolean }

Fields

Fields
`includeOnlyTargetedUserLists`	`boolean` Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters.

includeOnlyTargetedUserLists

boolean

Whether to include data for audience lists specifically targeted by filtered line items or insertion orders.

Requires the use of FILTER_INSERTION_ORDER or FILTER_LINE_ITEM filters.