Interface RunPivotReportResponseOrBuilder (0.52.0)

Version 0.52.0

• 0.65.0 (latest)
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0

public interface RunPivotReportResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregates(int index)

public abstract Row getAggregates(int index)

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Row

getAggregatesCount()

public abstract int getAggregatesCount()

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Returns
Type	Description
int

getAggregatesList()

public abstract List<Row> getAggregatesList()

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Returns
Type	Description
List<Row>

getAggregatesOrBuilder(int index)

public abstract RowOrBuilder getAggregatesOrBuilder(int index)

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
RowOrBuilder

getAggregatesOrBuilderList()

public abstract List<? extends RowOrBuilder> getAggregatesOrBuilderList()

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Returns
Type	Description
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getDimensionHeaders(int index)

public abstract DimensionHeader getDimensionHeaders(int index)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
DimensionHeader

getDimensionHeadersCount()

public abstract int getDimensionHeadersCount()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Returns
Type	Description
int

getDimensionHeadersList()

public abstract List<DimensionHeader> getDimensionHeadersList()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Returns
Type	Description
List<DimensionHeader>

getDimensionHeadersOrBuilder(int index)

public abstract DimensionHeaderOrBuilder getDimensionHeadersOrBuilder(int index)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
DimensionHeaderOrBuilder

getDimensionHeadersOrBuilderList()

public abstract List<? extends DimensionHeaderOrBuilder> getDimensionHeadersOrBuilderList()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Returns
Type	Description
List<? extends com.google.analytics.data.v1beta.DimensionHeaderOrBuilder>

getKind()

public abstract String getKind()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

string kind = 8;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

string kind = 8;

Returns
Type	Description
ByteString	The bytes for kind.

getMetadata()

public abstract ResponseMetaData getMetadata()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 6;

Returns
Type	Description
ResponseMetaData	The metadata.

getMetadataOrBuilder()

public abstract ResponseMetaDataOrBuilder getMetadataOrBuilder()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 6;

Returns
Type	Description
ResponseMetaDataOrBuilder

getMetricHeaders(int index)

public abstract MetricHeader getMetricHeaders(int index)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
MetricHeader

getMetricHeadersCount()

public abstract int getMetricHeadersCount()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Returns
Type	Description
int

getMetricHeadersList()

public abstract List<MetricHeader> getMetricHeadersList()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Returns
Type	Description
List<MetricHeader>

getMetricHeadersOrBuilder(int index)

public abstract MetricHeaderOrBuilder getMetricHeadersOrBuilder(int index)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
MetricHeaderOrBuilder

getMetricHeadersOrBuilderList()

public abstract List<? extends MetricHeaderOrBuilder> getMetricHeadersOrBuilderList()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Returns
Type	Description
List<? extends com.google.analytics.data.v1beta.MetricHeaderOrBuilder>

getPivotHeaders(int index)

public abstract PivotHeader getPivotHeaders(int index)

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PivotHeader

getPivotHeadersCount()

public abstract int getPivotHeadersCount()

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Returns
Type	Description
int

getPivotHeadersList()

public abstract List<PivotHeader> getPivotHeadersList()

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Returns
Type	Description
List<PivotHeader>

getPivotHeadersOrBuilder(int index)

public abstract PivotHeaderOrBuilder getPivotHeadersOrBuilder(int index)

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PivotHeaderOrBuilder

getPivotHeadersOrBuilderList()

public abstract List<? extends PivotHeaderOrBuilder> getPivotHeadersOrBuilderList()

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Returns
Type	Description
List<? extends com.google.analytics.data.v1beta.PivotHeaderOrBuilder>

getPropertyQuota()

public abstract PropertyQuota getPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 7;

Returns
Type	Description
PropertyQuota	The propertyQuota.

getPropertyQuotaOrBuilder()

public abstract PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 7;

Returns
Type	Description
PropertyQuotaOrBuilder

getRows(int index)

public abstract Row getRows(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Row

getRowsCount()

public abstract int getRowsCount()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Returns
Type	Description
int

getRowsList()

public abstract List<Row> getRowsList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Returns
Type	Description
List<Row>

getRowsOrBuilder(int index)

public abstract RowOrBuilder getRowsOrBuilder(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
RowOrBuilder

getRowsOrBuilderList()

public abstract List<? extends RowOrBuilder> getRowsOrBuilderList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Returns
Type	Description
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

hasMetadata()

public abstract boolean hasMetadata()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 6;

Returns
Type	Description
boolean	Whether the metadata field is set.

hasPropertyQuota()

public abstract boolean hasPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 7;

Returns
Type	Description
boolean	Whether the propertyQuota field is set.