Class ReportApiColumnSpec
A request object used to create a DoubleClick Search report.
Implements
Inherited Members
Namespace: Google.Apis.Doubleclicksearch.v2.Data
Assembly: Google.Apis.Doubleclicksearch.v2.dll
Syntax
public class ReportApiColumnSpec : IDirectResponseSchema
Properties
ColumnName
Name of a DoubleClick Search column to include in the report.
Declaration
[JsonProperty("columnName")]
public virtual string ColumnName { get; set; }
Property Value
Type | Description |
---|---|
string |
CustomDimensionName
Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.\ If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
Declaration
[JsonProperty("customDimensionName")]
public virtual string CustomDimensionName { get; set; }
Property Value
Type | Description |
---|---|
string |
CustomMetricName
Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
Declaration
[JsonProperty("customMetricName")]
public virtual string CustomMetricName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EndDate
Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for
this column only. Must be provided together with startDate
.
Declaration
[JsonProperty("endDate")]
public virtual string EndDate { get; set; }
Property Value
Type | Description |
---|---|
string |
GroupByColumn
Synchronous report only. Set to true
to group by this column. Defaults to false
.
Declaration
[JsonProperty("groupByColumn")]
public virtual bool? GroupByColumn { get; set; }
Property Value
Type | Description |
---|---|
bool? |
HeaderText
Text used to identify this column in the report output; defaults to columnName
or savedColumnName
when
not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns
with the same name.
Declaration
[JsonProperty("headerText")]
public virtual string HeaderText { get; set; }
Property Value
Type | Description |
---|---|
string |
PlatformSource
The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
Declaration
[JsonProperty("platformSource")]
public virtual string PlatformSource { get; set; }
Property Value
Type | Description |
---|---|
string |
ProductReportPerspective
Returns metrics only for a specific type of product activity. Accepted values are: - "sold
": returns
metrics only for products that were sold - "advertised
": returns metrics only for products that were
advertised in a Shopping campaign, and that might or might not have been sold
Declaration
[JsonProperty("productReportPerspective")]
public virtual string ProductReportPerspective { get; set; }
Property Value
Type | Description |
---|---|
string |
SavedColumnName
Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
Declaration
[JsonProperty("savedColumnName")]
public virtual string SavedColumnName { get; set; }
Property Value
Type | Description |
---|---|
string |
StartDate
Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for
this column only. Must be provided together with endDate
.
Declaration
[JsonProperty("startDate")]
public virtual string StartDate { get; set; }
Property Value
Type | Description |
---|---|
string |