Interface Report.SortOrBuilder (0.12.0)

Version 0.12.0

• 0.13.0 (latest)
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface Report.SortOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescending()

public abstract boolean getDescending()

Optional. The sort order. If true the sort will be descending.

bool descending = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The descending.

getField()

public abstract Report.Field getField()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Report.Field	The field.

getFieldOrBuilder()

public abstract Report.FieldOrBuilder getFieldOrBuilder()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Report.FieldOrBuilder

getMetricValueType()

public abstract Report.MetricValueType getMetricValueType()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Report.MetricValueType	The metricValueType.

getMetricValueTypeValue()

public abstract int getMetricValueTypeValue()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for metricValueType.

getSlice()

public abstract Report.Slice getSlice()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Report.Slice	The slice.

getSliceOrBuilder()

public abstract Report.SliceOrBuilder getSliceOrBuilder()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Report.SliceOrBuilder

getTimePeriodIndex()

public abstract int getTimePeriodIndex()

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The timePeriodIndex.

hasField()

public abstract boolean hasField()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the field field is set.

hasMetricValueType()

public abstract boolean hasMetricValueType()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the metricValueType field is set.

hasSlice()

public abstract boolean hasSlice()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the slice field is set.

hasTimePeriodIndex()

public abstract boolean hasTimePeriodIndex()

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the timePeriodIndex field is set.