Class RunPivotReportRequest (0.50.0)

public final class RunPivotReportRequest extends GeneratedMessageV3 implements RunPivotReportRequestOrBuilder

The request to generate a pivot report.

Protobuf type google.analytics.data.v1beta.RunPivotReportRequest

Static Fields

COHORT_SPEC_FIELD_NUMBER

public static final int COHORT_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

DATE_RANGES_FIELD_NUMBER

public static final int DATE_RANGES_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSION_FILTER_FIELD_NUMBER

public static final int DIMENSION_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

KEEP_EMPTY_ROWS_FIELD_NUMBER

public static final int KEEP_EMPTY_ROWS_FIELD_NUMBER
Field Value
TypeDescription
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_FILTER_FIELD_NUMBER

public static final int METRIC_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PIVOTS_FIELD_NUMBER

public static final int PIVOTS_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
TypeDescription
int

RETURN_PROPERTY_QUOTA_FIELD_NUMBER

public static final int RETURN_PROPERTY_QUOTA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RunPivotReportRequest getDefaultInstance()
Returns
TypeDescription
RunPivotReportRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RunPivotReportRequest.Builder newBuilder()
Returns
TypeDescription
RunPivotReportRequest.Builder

newBuilder(RunPivotReportRequest prototype)

public static RunPivotReportRequest.Builder newBuilder(RunPivotReportRequest prototype)
Parameter
NameDescription
prototypeRunPivotReportRequest
Returns
TypeDescription
RunPivotReportRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunPivotReportRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RunPivotReportRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunPivotReportRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunPivotReportRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RunPivotReportRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RunPivotReportRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPivotReportRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RunPivotReportRequest> parser()
Returns
TypeDescription
Parser<RunPivotReportRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCohortSpec()

public CohortSpec getCohortSpec()

Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Returns
TypeDescription
CohortSpec

The cohortSpec.

getCohortSpecOrBuilder()

public CohortSpecOrBuilder getCohortSpecOrBuilder()

Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Returns
TypeDescription
CohortSpecOrBuilder

getCurrencyCode()

public String getCurrencyCode()

A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.

string currency_code = 8;

Returns
TypeDescription
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.

string currency_code = 8;

Returns
TypeDescription
ByteString

The bytes for currencyCode.

getDateRanges(int index)

public DateRange getDateRanges(int index)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
DateRange

getDateRangesCount()

public int getDateRangesCount()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
TypeDescription
int

getDateRangesList()

public List<DateRange> getDateRangesList()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
TypeDescription
List<DateRange>

getDateRangesOrBuilder(int index)

public DateRangeOrBuilder getDateRangesOrBuilder(int index)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
DateRangeOrBuilder

getDateRangesOrBuilderList()

public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.DateRangeOrBuilder>

getDefaultInstanceForType()

public RunPivotReportRequest getDefaultInstanceForType()
Returns
TypeDescription
RunPivotReportRequest

getDimensionFilter()

public FilterExpression getDimensionFilter()

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;

Returns
TypeDescription
FilterExpression

The dimensionFilter.

getDimensionFilterOrBuilder()

public FilterExpressionOrBuilder getDimensionFilterOrBuilder()

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;

Returns
TypeDescription
FilterExpressionOrBuilder

getDimensions(int index)

public Dimension getDimensions(int index)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Dimension

getDimensionsCount()

public int getDimensionsCount()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
TypeDescription
int

getDimensionsList()

public List<Dimension> getDimensionsList()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
TypeDescription
List<Dimension>

getDimensionsOrBuilder(int index)

public DimensionOrBuilder getDimensionsOrBuilder(int index)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
DimensionOrBuilder

getDimensionsOrBuilderList()

public List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.DimensionOrBuilder>

getKeepEmptyRows()

public boolean getKeepEmptyRows()

If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

bool keep_empty_rows = 10;

Returns
TypeDescription
boolean

The keepEmptyRows.

getMetricFilter()

public FilterExpression getMetricFilter()

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 7;

Returns
TypeDescription
FilterExpression

The metricFilter.

getMetricFilterOrBuilder()

public FilterExpressionOrBuilder getMetricFilterOrBuilder()

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 7;

Returns
TypeDescription
FilterExpressionOrBuilder

getMetrics(int index)

public Metric getMetrics(int index)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Metric

getMetricsCount()

public int getMetricsCount()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
TypeDescription
int

getMetricsList()

public List<Metric> getMetricsList()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
TypeDescription
List<Metric>

getMetricsOrBuilder(int index)

public MetricOrBuilder getMetricsOrBuilder(int index)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricOrBuilder

getMetricsOrBuilderList()

public List<? extends MetricOrBuilder> getMetricsOrBuilderList()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

repeated .google.analytics.data.v1beta.Metric metrics = 3;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.MetricOrBuilder>

getParserForType()

public Parser<RunPivotReportRequest> getParserForType()
Returns
TypeDescription
Parser<RunPivotReportRequest>
Overrides

getPivots(int index)

public Pivot getPivots(int index)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Pivot

getPivotsCount()

public int getPivotsCount()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
TypeDescription
int

getPivotsList()

public List<Pivot> getPivotsList()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
TypeDescription
List<Pivot>

getPivotsOrBuilder(int index)

public PivotOrBuilder getPivotsOrBuilder(int index)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
PivotOrBuilder

getPivotsOrBuilderList()

public List<? extends PivotOrBuilder> getPivotsOrBuilderList()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.PivotOrBuilder>

getProperty()

public String getProperty()

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1;

Returns
TypeDescription
String

The property.

getPropertyBytes()

public ByteString getPropertyBytes()

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1;

Returns
TypeDescription
ByteString

The bytes for property.

getReturnPropertyQuota()

public boolean getReturnPropertyQuota()

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

bool return_property_quota = 11;

Returns
TypeDescription
boolean

The returnPropertyQuota.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasCohortSpec()

public boolean hasCohortSpec()

Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Returns
TypeDescription
boolean

Whether the cohortSpec field is set.

hasDimensionFilter()

public boolean hasDimensionFilter()

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;

Returns
TypeDescription
boolean

Whether the dimensionFilter field is set.

hasMetricFilter()

public boolean hasMetricFilter()

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

.google.analytics.data.v1beta.FilterExpression metric_filter = 7;

Returns
TypeDescription
boolean

Whether the metricFilter field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RunPivotReportRequest.Builder newBuilderForType()
Returns
TypeDescription
RunPivotReportRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunPivotReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RunPivotReportRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RunPivotReportRequest.Builder toBuilder()
Returns
TypeDescription
RunPivotReportRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException