Class ReportDefinition

The definition of how a report should be run.

Inheritance

object

ReportDefinition

Implements

IMessage<ReportDefinition>

IEquatable<ReportDefinition>

IDeepCloneable<ReportDefinition>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class ReportDefinition : IMessage<ReportDefinition>, IEquatable<ReportDefinition>, IDeepCloneable<ReportDefinition>, IBufferMessage, IMessage

Constructors

ReportDefinition()

Declaration

public ReportDefinition()

ReportDefinition(ReportDefinition)

Declaration

public ReportDefinition(ReportDefinition other)

Parameters

Type	Name	Description
ReportDefinition	other

Properties

CmsMetadataDimensionKeyIds

Optional. CMS Metadata Dimension keys that represent CMS_METADATA_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, cms_metadata_dimension_key_ids[0] describes CMS_METADATA_DIMENSION_0_VALUE_ID and CMS_METADATA_DIMENSION_0_VALUE.

Declaration

public RepeatedField<long> CmsMetadataDimensionKeyIds { get; }

Property Value

Type	Description
RepeatedField<long>

ComparisonDateRange

Optional. The comparison date range of this report. If unspecified, the report won't have any comparison metrics.

Declaration

public ReportDefinition.Types.DateRange ComparisonDateRange { get; set; }

Property Value

Type	Description
ReportDefinition.Types.DateRange

CreativeCustomFieldIds

Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.

Declaration

public RepeatedField<long> CreativeCustomFieldIds { get; }

Property Value

Type	Description
RepeatedField<long>

CurrencyCode

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

Declaration

public string CurrencyCode { get; set; }

Property Value

Type	Description
string

CustomDimensionKeyIds

Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.

Declaration

public RepeatedField<long> CustomDimensionKeyIds { get; }

Property Value

Type	Description
RepeatedField<long>

DateRange

Required. The primary date range of this report.

Declaration

public ReportDefinition.Types.DateRange DateRange { get; set; }

Property Value

Type	Description
ReportDefinition.Types.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

public RepeatedField<ReportDefinition.Types.Dimension> Dimensions { get; }

Property Value

Type	Description
RepeatedField<ReportDefinition.Types.Dimension>

EkvDimensionKeyIds

Optional. Enhanced Key-values Dimension keys that represent EKV_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, ekv_dimension_key_ids[0] describes EKV_DIMENSION_0_VALUE_ID and EKV_DIMENSION_0_VALUE.

Declaration

public RepeatedField<long> EkvDimensionKeyIds { get; }

Property Value

Type	Description
RepeatedField<long>

ExpandedCompatibility

Optional. Whether to use expanded compatibility for this report.

If true, this setting enables certain combinations of dimensions and metrics for this report that would otherwise be incompatible. Enabling this will collapse reservation data into a single row even if the report's dimensions would normally result in multiple rows for reservation data. This impacts dimensions related to line items, orders, creatives, and advertisers.

This is equivalent to the "Access more dimension and metric combinations" setting in the Interactive Reports UI. For more details, see: https://support.google.com/admanager/answer/16865393#combinations

Declaration

public bool ExpandedCompatibility { get; set; }

Property Value

Type	Description
bool

Filters

Optional. The filters for this report.

Declaration

public RepeatedField<ReportDefinition.Types.Filter> Filters { get; }

Property Value

Type	Description
RepeatedField<ReportDefinition.Types.Filter>

Flags

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

Declaration

public RepeatedField<ReportDefinition.Types.Flag> Flags { get; }

Property Value

Type	Description
RepeatedField<ReportDefinition.Types.Flag>

LineItemCustomFieldIds

Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.

Declaration

public RepeatedField<long> LineItemCustomFieldIds { get; }

Property Value

Type	Description
RepeatedField<long>

Metrics

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

Declaration

public RepeatedField<ReportDefinition.Types.Metric> Metrics { get; }

Property Value

Type	Description
RepeatedField<ReportDefinition.Types.Metric>

OrderCustomFieldIds

Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.

Declaration

public RepeatedField<long> OrderCustomFieldIds { get; }

Property Value

Type	Description
RepeatedField<long>

ReportType

Required. The type of this report.

Declaration

public ReportDefinition.Types.ReportType ReportType { get; set; }

Property Value

Type	Description
ReportDefinition.Types.ReportType

Sorts

Optional. Default sorts to apply to this report.

Declaration

public RepeatedField<ReportDefinition.Types.Sort> Sorts { get; }

Property Value

Type	Description
RepeatedField<ReportDefinition.Types.Sort>

TimePeriodColumn

Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.

Declaration

public ReportDefinition.Types.TimePeriodColumn TimePeriodColumn { get; set; }

Property Value

Type	Description
ReportDefinition.Types.TimePeriodColumn

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

public string TimeZone { get; set; }

Property Value

Type	Description
string

TimeZoneSource

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

Declaration

public ReportDefinition.Types.TimeZoneSource TimeZoneSource { get; set; }

Property Value

Type	Description
ReportDefinition.Types.TimeZoneSource