Parameters
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
ReportType
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. |
AUDIENCE_COMPOSITION |
Audience Composition report. |
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. |
PATH_ATTRIBUTION |
Path Attribution report. |
FilterPair
Represents a single filter rule.
| JSON representation |
{
"type": string,
"value": string
} |
| 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.
|
Options
Report parameter options.
| JSON representation |
{
"includeOnlyTargetedUserLists": boolean
} |
| 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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eParameters define a generated report, including type, groupings, filters, metrics, and additional options.\u003c/p\u003e\n"],["\u003cp\u003eReports can be of various types like Standard, Inventory Availability, Floodlight, YouTube, and more, each with specific data.\u003c/p\u003e\n"],["\u003cp\u003eFilters limit report data based on type and value, allowing for focused analysis.\u003c/p\u003e\n"],["\u003cp\u003eOptions provide further customization, such as including data only for targeted user lists with specific filters.\u003c/p\u003e\n"]]],["The core content outlines parameters for generating reports, including report type, data segmentation, filtering, metrics, and options. Reports are defined by a `type` (e.g., STANDARD, YOUTUBE), `groupBys` for data segmentation, `filters` to limit data scope using `FilterPair` (type and value), `metrics` to specify data to populate the report, and `options` for additional settings like targeting filters. Available types of reports are specified by `ReportType` enums.\n"],null,["# Parameters\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ReportType](#ReportType)\n- [FilterPair](#FilterPair)\n - [JSON representation](#FilterPair.SCHEMA_REPRESENTATION)\n- [Options](#Options)\n - [JSON representation](#Options.SCHEMA_REPRESENTATION)\n\nParameters of a generated report.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"type\": enum (/bid-manager/reference/rest/v2/Parameters#ReportType), \"groupBys\": [ string ], \"filters\": [ { object (/bid-manager/reference/rest/v2/Parameters#FilterPair) } ], \"metrics\": [ string ], \"options\": { object (/bid-manager/reference/rest/v2/Parameters#Options) } } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `type` | `enum (`[ReportType](/bid-manager/reference/rest/v2/Parameters#ReportType)`)` The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used. |\n| `groupBys[]` | `string` Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values. |\n| `filters[]` | `object (`[FilterPair](/bid-manager/reference/rest/v2/Parameters#FilterPair)`)` Filters to limit the scope of reported data. |\n| `metrics[]` | `string` Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values. |\n| `options` | `object (`[Options](/bid-manager/reference/rest/v2/Parameters#Options)`)` Additional report parameter options. |\n\nReportType\n----------\n\nAvailable types of report.\n\n| Enums ||\n|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `REPORT_TYPE_UNSPECIFIED` | Default value when report type is not specified or is unknown in this version. |\n| `STANDARD` | Standard report. |\n| `INVENTORY_AVAILABILITY` | Inventory Availability report. See the [Display \\& Video 360 Help Center announcement](https://support.google.com/displayvideo/answer/15874746) for more information on this deprecation. | This item is deprecated! |\n| `AUDIENCE_COMPOSITION` | Audience Composition report. | This item is deprecated! |\n| `FLOODLIGHT` | Floodlight report. |\n| `YOUTUBE` | YouTube report. |\n| `GRP` | GRP report. |\n| `YOUTUBE_PROGRAMMATIC_GUARANTEED` | YouTube Programmatic Guaranteed report. |\n| `REACH` | Reach report. |\n| `UNIQUE_REACH_AUDIENCE` | Unique Reach Audience report. |\n| `FULL_PATH` | Full Path report. | This item is deprecated! |\n| `PATH_ATTRIBUTION` | Path Attribution report. | This item is deprecated! |\n\nFilterPair\n----------\n\nRepresents a single filter rule.\n\n| JSON representation |\n|---------------------------------------------|\n| ``` { \"type\": string, \"value\": string } ``` |\n\n| Fields ||\n|---------|-------------------------------------------------------------------------------------------------------------------------------|\n| `type` | `string` The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value. |\n| `value` | `string` The identifying value to filter by, such as a relevant resource ID. |\n\nOptions\n-------\n\nReport parameter options.\n\n| JSON representation |\n|-----------------------------------------------------|\n| ``` { \"includeOnlyTargetedUserLists\": boolean } ``` |\n\n| Fields ||\n|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |"]]
