View Source GoogleApi.DoubleClickSearch.V2.Model.ReportRequest (google_api_double_click_search v0.19.0)
A request object used to create a DoubleClick Search report.
Attributes
-
columns
(type:list(GoogleApi.DoubleClickSearch.V2.Model.ReportApiColumnSpec.t)
, default:nil
) - The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only thecolumnName
parameter is required. For saved columns only thesavedColumnName
parameter is required. BothcolumnName
andsavedColumnName
cannot be set in the same stanza.\ The maximum number of columns per request is 300. -
downloadFormat
(type:String.t
, default:nil
) - Format that the report should be returned in. Currentlycsv
ortsv
is supported. -
filters
(type:list(GoogleApi.DoubleClickSearch.V2.Model.ReportRequestFilters.t)
, default:nil
) - A list of filters to be applied to the report.\ The maximum number of filters per request is 300. -
includeDeletedEntities
(type:boolean()
, default:nil
) - Determines if removed entities should be included in the report. Defaults tofalse
. Deprecated, please useincludeRemovedEntities
instead. -
includeRemovedEntities
(type:boolean()
, default:nil
) - Determines if removed entities should be included in the report. Defaults tofalse
. -
maxRowsPerFile
(type:integer()
, default:nil
) - Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are1000000
to100000000
, inclusive. -
orderBy
(type:list(GoogleApi.DoubleClickSearch.V2.Model.ReportRequestOrderBy.t)
, default:nil
) - Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\ The maximum number of orderings per request is 300. -
reportScope
(type:GoogleApi.DoubleClickSearch.V2.Model.ReportRequestReportScope.t
, default:nil
) - The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required. -
reportType
(type:String.t
, default:nil
) - Determines the type of rows that are returned in the report. For example, if you specifyreportType: keyword
, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type. -
rowCount
(type:integer()
, default:nil
) - Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are0
to10000
, inclusive. Defaults to10000
. -
startRow
(type:integer()
, default:nil
) - Synchronous report only. Zero-based index of the first row to return. Acceptable values are0
to50000
, inclusive. Defaults to0
. -
statisticsCurrency
(type:String.t
, default:nil
) - Specifies the currency in which monetary will be returned. Possible values are:usd
,agency
(valid if the report is scoped to agency or lower),advertiser
(valid if the report is scoped to * advertiser or lower), oraccount
(valid if the report is scoped to engine account or lower). -
timeRange
(type:GoogleApi.DoubleClickSearch.V2.Model.ReportRequestTimeRange.t
, default:nil
) - If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range. -
verifySingleTimeZone
(type:boolean()
, default:nil
) - Iftrue
, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults tofalse
.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DoubleClickSearch.V2.Model.ReportRequest{ columns: [GoogleApi.DoubleClickSearch.V2.Model.ReportApiColumnSpec.t()] | nil, downloadFormat: String.t() | nil, filters: [GoogleApi.DoubleClickSearch.V2.Model.ReportRequestFilters.t()] | nil, includeDeletedEntities: boolean() | nil, includeRemovedEntities: boolean() | nil, maxRowsPerFile: integer() | nil, orderBy: [GoogleApi.DoubleClickSearch.V2.Model.ReportRequestOrderBy.t()] | nil, reportScope: GoogleApi.DoubleClickSearch.V2.Model.ReportRequestReportScope.t() | nil, reportType: String.t() | nil, rowCount: integer() | nil, startRow: integer() | nil, statisticsCurrency: String.t() | nil, timeRange: GoogleApi.DoubleClickSearch.V2.Model.ReportRequestTimeRange.t() | nil, verifySingleTimeZone: boolean() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.