Interface ReportDefinitionOrBuilder (0.39.0) 

public interface ReportDefinitionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getComparisonDateRange()

public abstract ReportDefinition.DateRange getComparisonDateRange()

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

optional .google.ads.admanager.v1.ReportDefinition.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.DateRange

The comparisonDateRange.

getComparisonDateRangeOrBuilder()

public abstract ReportDefinition.DateRangeOrBuilder getComparisonDateRangeOrBuilder()

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

optional .google.ads.admanager.v1.ReportDefinition.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.DateRangeOrBuilder

getCreativeCustomFieldIds(int index)

public abstract long getCreativeCustomFieldIds(int index)

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.

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The creativeCustomFieldIds at the given index.

getCreativeCustomFieldIdsCount()

public abstract int getCreativeCustomFieldIdsCount()

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.

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of creativeCustomFieldIds.

getCreativeCustomFieldIdsList()

public abstract List<Long> getCreativeCustomFieldIdsList()

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.

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Long>

A list containing the creativeCustomFieldIds.

getCurrencyCode()

public abstract String getCurrencyCode()

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

string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public abstract ByteString getCurrencyCodeBytes()

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

string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getCustomDimensionKeyIds(int index)

public abstract long getCustomDimensionKeyIds(int index)

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.

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The customDimensionKeyIds at the given index.

getCustomDimensionKeyIdsCount()

public abstract int getCustomDimensionKeyIdsCount()

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.

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of customDimensionKeyIds.

getCustomDimensionKeyIdsList()

public abstract List<Long> getCustomDimensionKeyIdsList()

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.

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Long>

A list containing the customDimensionKeyIds.

getDateRange()

public abstract ReportDefinition.DateRange getDateRange()

Required. The primary date range of this report.

.google.ads.admanager.v1.ReportDefinition.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.DateRange

The dateRange.

getDateRangeOrBuilder()

public abstract ReportDefinition.DateRangeOrBuilder getDateRangeOrBuilder()

Required. The primary date range of this report.

.google.ads.admanager.v1.ReportDefinition.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.DateRangeOrBuilder

getDimensions(int index)

public abstract ReportDefinition.Dimension getDimensions(int index)

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

repeated .google.ads.admanager.v1.ReportDefinition.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
ReportDefinition.Dimension

The dimensions at the given index.

getDimensionsCount()

public abstract int getDimensionsCount()

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

repeated .google.ads.admanager.v1.ReportDefinition.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of dimensions.

getDimensionsList()

public abstract List<ReportDefinition.Dimension> getDimensionsList()

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

repeated .google.ads.admanager.v1.ReportDefinition.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Dimension>

A list containing the dimensions.

getDimensionsValue(int index)

public abstract int getDimensionsValue(int index)

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

repeated .google.ads.admanager.v1.ReportDefinition.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of dimensions at the given index.

getDimensionsValueList()

public abstract List<Integer> getDimensionsValueList()

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

repeated .google.ads.admanager.v1.ReportDefinition.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for dimensions.

getFilters(int index)

public abstract ReportDefinition.Filter getFilters(int index)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.Filter

getFiltersCount()

public abstract int getFiltersCount()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFiltersList()

public abstract List<ReportDefinition.Filter> getFiltersList()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Filter>

getFiltersOrBuilder(int index)

public abstract ReportDefinition.FilterOrBuilder getFiltersOrBuilder(int index)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.FilterOrBuilder

getFiltersOrBuilderList()

public abstract List<? extends ReportDefinition.FilterOrBuilder> getFiltersOrBuilderList()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ReportDefinition.FilterOrBuilder>

getFlags(int index)

public abstract ReportDefinition.Flag getFlags(int index)

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

repeated .google.ads.admanager.v1.ReportDefinition.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.Flag

getFlagsCount()

public abstract int getFlagsCount()

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

repeated .google.ads.admanager.v1.ReportDefinition.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFlagsList()

public abstract List<ReportDefinition.Flag> getFlagsList()

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

repeated .google.ads.admanager.v1.ReportDefinition.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Flag>

getFlagsOrBuilder(int index)

public abstract ReportDefinition.FlagOrBuilder getFlagsOrBuilder(int index)

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

repeated .google.ads.admanager.v1.ReportDefinition.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.FlagOrBuilder

getFlagsOrBuilderList()

public abstract List<? extends ReportDefinition.FlagOrBuilder> getFlagsOrBuilderList()

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

repeated .google.ads.admanager.v1.ReportDefinition.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ReportDefinition.FlagOrBuilder>

getLineItemCustomFieldIds(int index)

public abstract long getLineItemCustomFieldIds(int index)

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.

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The lineItemCustomFieldIds at the given index.

getLineItemCustomFieldIdsCount()

public abstract int getLineItemCustomFieldIdsCount()

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.

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of lineItemCustomFieldIds.

getLineItemCustomFieldIdsList()

public abstract List<Long> getLineItemCustomFieldIdsList()

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.

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Long>

A list containing the lineItemCustomFieldIds.

getMetrics(int index)

public abstract ReportDefinition.Metric getMetrics(int index)

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

repeated .google.ads.admanager.v1.ReportDefinition.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
ReportDefinition.Metric

The metrics at the given index.

getMetricsCount()

public abstract int getMetricsCount()

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

repeated .google.ads.admanager.v1.ReportDefinition.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of metrics.

getMetricsList()

public abstract List<ReportDefinition.Metric> getMetricsList()

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

repeated .google.ads.admanager.v1.ReportDefinition.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Metric>

A list containing the metrics.

getMetricsValue(int index)

public abstract int getMetricsValue(int index)

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

repeated .google.ads.admanager.v1.ReportDefinition.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of metrics at the given index.

getMetricsValueList()

public abstract List<Integer> getMetricsValueList()

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

repeated .google.ads.admanager.v1.ReportDefinition.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for metrics.

getOrderCustomFieldIds(int index)

public abstract long getOrderCustomFieldIds(int index)

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.

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The orderCustomFieldIds at the given index.

getOrderCustomFieldIdsCount()

public abstract int getOrderCustomFieldIdsCount()

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.

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of orderCustomFieldIds.

getOrderCustomFieldIdsList()

public abstract List<Long> getOrderCustomFieldIdsList()

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.

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Long>

A list containing the orderCustomFieldIds.

getReportType()

public abstract ReportDefinition.ReportType getReportType()

Required. The type of this report.

.google.ads.admanager.v1.ReportDefinition.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.ReportType

The reportType.

getReportTypeValue()

public abstract int getReportTypeValue()

Required. The type of this report.

.google.ads.admanager.v1.ReportDefinition.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for reportType.

getSorts(int index)

public abstract ReportDefinition.Sort getSorts(int index)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.ReportDefinition.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.Sort

getSortsCount()

public abstract int getSortsCount()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.ReportDefinition.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSortsList()

public abstract List<ReportDefinition.Sort> getSortsList()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.ReportDefinition.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Sort>

getSortsOrBuilder(int index)

public abstract ReportDefinition.SortOrBuilder getSortsOrBuilder(int index)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.ReportDefinition.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.SortOrBuilder

getSortsOrBuilderList()

public abstract List<? extends ReportDefinition.SortOrBuilder> getSortsOrBuilderList()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.ReportDefinition.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ReportDefinition.SortOrBuilder>

getTimePeriodColumn()

public abstract ReportDefinition.TimePeriodColumn getTimePeriodColumn()

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.

.google.ads.admanager.v1.ReportDefinition.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.TimePeriodColumn

The timePeriodColumn.

getTimePeriodColumnValue()

public abstract int getTimePeriodColumnValue()

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.

.google.ads.admanager.v1.ReportDefinition.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for timePeriodColumn.

getTimeZone()

public abstract String getTimeZone()

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".

string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

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".

string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for timeZone.

getTimeZoneSource()

public abstract ReportDefinition.TimeZoneSource getTimeZoneSource()

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.

.google.ads.admanager.v1.ReportDefinition.TimeZoneSource time_zone_source = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.TimeZoneSource

The timeZoneSource.

getTimeZoneSourceValue()

public abstract int getTimeZoneSourceValue()

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.

.google.ads.admanager.v1.ReportDefinition.TimeZoneSource time_zone_source = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for timeZoneSource.

hasComparisonDateRange()

public abstract boolean hasComparisonDateRange()

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

optional .google.ads.admanager.v1.ReportDefinition.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the comparisonDateRange field is set.

hasDateRange()

public abstract boolean hasDateRange()

Required. The primary date range of this report.

.google.ads.admanager.v1.ReportDefinition.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the dateRange field is set.