Show / Hide Table of Contents

Class ReportDefinition

The definition of how a report should be run.

Inheritance
object
ReportDefinition
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CurationPartners.v1.Data
Assembly: Google.Apis.CurationPartners.v1.dll
Syntax
public class ReportDefinition : IDirectResponseSchema

Properties

CurrencyCode

Optional. The ISO 4217 currency code for this report. Defaults to account currency code if not specified.

Declaration
[JsonProperty("currencyCode")]
public virtual string CurrencyCode { get; set; }
Property Value
Type Description
string

DateRange

Required. The primary date range of this report.

Declaration
[JsonProperty("dateRange")]
public virtual DateRange DateRange { get; set; }
Property Value
Type Description
DateRange

Dimensions

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

Declaration
[JsonProperty("dimensions")]
public virtual IList<string> Dimensions { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Filters

Optional. The filters for this report.

Declaration
[JsonProperty("filters")]
public virtual IList<Filter> Filters { get; set; }
Property Value
Type Description
IList<Filter>

Metrics

Required. The list of metrics to report on. If empty, the report will have no metrics.

Declaration
[JsonProperty("metrics")]
public virtual IList<string> Metrics { get; set; }
Property Value
Type Description
IList<string>

Sorts

Optional. Default sorts to apply to this report.

Declaration
[JsonProperty("sorts")]
public virtual IList<Sort> Sorts { get; set; }
Property Value
Type Description
IList<Sort>

TimeZone

Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format. For example, "America/New_York".

Declaration
[JsonProperty("timeZone")]
public virtual string TimeZone { get; set; }
Property Value
Type Description
string

TimeZoneSource

Optional. Where to get the time zone for this report. Defaults to using the Pacific time zone (PT). If source is PROVIDED, the time_zone field in the report definition must also set a time zone.

Declaration
[JsonProperty("timeZoneSource")]
public virtual string TimeZoneSource { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX