Class RunPivotReportResponse.Builder (0.50.0)

public static final class RunPivotReportResponse.Builder extends GeneratedMessageV3.Builder<RunPivotReportResponse.Builder> implements RunPivotReportResponseOrBuilder

The response pivot report table corresponding to a pivot request.

Protobuf type google.analytics.data.v1beta.RunPivotReportResponse

Static Methods

getDescriptor()

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

Methods

addAggregates(Row value)

public RunPivotReportResponse.Builder addAggregates(Row value)

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
NameDescription
valueRow
Returns
TypeDescription
RunPivotReportResponse.Builder

addAggregates(Row.Builder builderForValue)

public RunPivotReportResponse.Builder addAggregates(Row.Builder builderForValue)

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
NameDescription
builderForValueRow.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addAggregates(int index, Row value)

public RunPivotReportResponse.Builder addAggregates(int index, Row value)

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;

Parameters
NameDescription
indexint
valueRow
Returns
TypeDescription
RunPivotReportResponse.Builder

addAggregates(int index, Row.Builder builderForValue)

public RunPivotReportResponse.Builder addAggregates(int index, Row.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueRow.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addAggregatesBuilder()

public Row.Builder addAggregatesBuilder()

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
TypeDescription
Row.Builder

addAggregatesBuilder(int index)

public Row.Builder addAggregatesBuilder(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
NameDescription
indexint
Returns
TypeDescription
Row.Builder

addAllAggregates(Iterable<? extends Row> values)

public RunPivotReportResponse.Builder addAllAggregates(Iterable<? extends Row> values)

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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.Row>
Returns
TypeDescription
RunPivotReportResponse.Builder

addAllDimensionHeaders(Iterable<? extends DimensionHeader> values)

public RunPivotReportResponse.Builder addAllDimensionHeaders(Iterable<? extends DimensionHeader> values)

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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.DimensionHeader>
Returns
TypeDescription
RunPivotReportResponse.Builder

addAllMetricHeaders(Iterable<? extends MetricHeader> values)

public RunPivotReportResponse.Builder addAllMetricHeaders(Iterable<? extends MetricHeader> values)

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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.MetricHeader>
Returns
TypeDescription
RunPivotReportResponse.Builder

addAllPivotHeaders(Iterable<? extends PivotHeader> values)

public RunPivotReportResponse.Builder addAllPivotHeaders(Iterable<? extends PivotHeader> values)

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
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.PivotHeader>
Returns
TypeDescription
RunPivotReportResponse.Builder

addAllRows(Iterable<? extends Row> values)

public RunPivotReportResponse.Builder addAllRows(Iterable<? extends Row> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.analytics.data.v1beta.Row>
Returns
TypeDescription
RunPivotReportResponse.Builder

addDimensionHeaders(DimensionHeader value)

public RunPivotReportResponse.Builder addDimensionHeaders(DimensionHeader value)

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
NameDescription
valueDimensionHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

addDimensionHeaders(DimensionHeader.Builder builderForValue)

public RunPivotReportResponse.Builder addDimensionHeaders(DimensionHeader.Builder builderForValue)

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
NameDescription
builderForValueDimensionHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addDimensionHeaders(int index, DimensionHeader value)

public RunPivotReportResponse.Builder addDimensionHeaders(int index, DimensionHeader value)

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;

Parameters
NameDescription
indexint
valueDimensionHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

addDimensionHeaders(int index, DimensionHeader.Builder builderForValue)

public RunPivotReportResponse.Builder addDimensionHeaders(int index, DimensionHeader.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueDimensionHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addDimensionHeadersBuilder()

public DimensionHeader.Builder addDimensionHeadersBuilder()

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
TypeDescription
DimensionHeader.Builder

addDimensionHeadersBuilder(int index)

public DimensionHeader.Builder addDimensionHeadersBuilder(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
NameDescription
indexint
Returns
TypeDescription
DimensionHeader.Builder

addMetricHeaders(MetricHeader value)

public RunPivotReportResponse.Builder addMetricHeaders(MetricHeader value)

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
NameDescription
valueMetricHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

addMetricHeaders(MetricHeader.Builder builderForValue)

public RunPivotReportResponse.Builder addMetricHeaders(MetricHeader.Builder builderForValue)

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
NameDescription
builderForValueMetricHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addMetricHeaders(int index, MetricHeader value)

public RunPivotReportResponse.Builder addMetricHeaders(int index, MetricHeader value)

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;

Parameters
NameDescription
indexint
valueMetricHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

addMetricHeaders(int index, MetricHeader.Builder builderForValue)

public RunPivotReportResponse.Builder addMetricHeaders(int index, MetricHeader.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueMetricHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addMetricHeadersBuilder()

public MetricHeader.Builder addMetricHeadersBuilder()

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
TypeDescription
MetricHeader.Builder

addMetricHeadersBuilder(int index)

public MetricHeader.Builder addMetricHeadersBuilder(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
NameDescription
indexint
Returns
TypeDescription
MetricHeader.Builder

addPivotHeaders(PivotHeader value)

public RunPivotReportResponse.Builder addPivotHeaders(PivotHeader value)

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
NameDescription
valuePivotHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

addPivotHeaders(PivotHeader.Builder builderForValue)

public RunPivotReportResponse.Builder addPivotHeaders(PivotHeader.Builder builderForValue)

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
NameDescription
builderForValuePivotHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addPivotHeaders(int index, PivotHeader value)

public RunPivotReportResponse.Builder addPivotHeaders(int index, PivotHeader value)

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;

Parameters
NameDescription
indexint
valuePivotHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

addPivotHeaders(int index, PivotHeader.Builder builderForValue)

public RunPivotReportResponse.Builder addPivotHeaders(int index, PivotHeader.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValuePivotHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addPivotHeadersBuilder()

public PivotHeader.Builder addPivotHeadersBuilder()

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
TypeDescription
PivotHeader.Builder

addPivotHeadersBuilder(int index)

public PivotHeader.Builder addPivotHeadersBuilder(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
NameDescription
indexint
Returns
TypeDescription
PivotHeader.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunPivotReportResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

addRows(Row value)

public RunPivotReportResponse.Builder addRows(Row value)

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

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

Parameter
NameDescription
valueRow
Returns
TypeDescription
RunPivotReportResponse.Builder

addRows(Row.Builder builderForValue)

public RunPivotReportResponse.Builder addRows(Row.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueRow.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addRows(int index, Row value)

public RunPivotReportResponse.Builder addRows(int index, Row value)

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

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

Parameters
NameDescription
indexint
valueRow
Returns
TypeDescription
RunPivotReportResponse.Builder

addRows(int index, Row.Builder builderForValue)

public RunPivotReportResponse.Builder addRows(int index, Row.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueRow.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

addRowsBuilder()

public Row.Builder addRowsBuilder()

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

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

Returns
TypeDescription
Row.Builder

addRowsBuilder(int index)

public Row.Builder addRowsBuilder(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Row.Builder

build()

public RunPivotReportResponse build()
Returns
TypeDescription
RunPivotReportResponse

buildPartial()

public RunPivotReportResponse buildPartial()
Returns
TypeDescription
RunPivotReportResponse

clear()

public RunPivotReportResponse.Builder clear()
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

clearAggregates()

public RunPivotReportResponse.Builder clearAggregates()

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
TypeDescription
RunPivotReportResponse.Builder

clearDimensionHeaders()

public RunPivotReportResponse.Builder clearDimensionHeaders()

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
TypeDescription
RunPivotReportResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public RunPivotReportResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

clearKind()

public RunPivotReportResponse.Builder clearKind()

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
TypeDescription
RunPivotReportResponse.Builder

This builder for chaining.

clearMetadata()

public RunPivotReportResponse.Builder clearMetadata()

Metadata for the report.

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

Returns
TypeDescription
RunPivotReportResponse.Builder

clearMetricHeaders()

public RunPivotReportResponse.Builder clearMetricHeaders()

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
TypeDescription
RunPivotReportResponse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RunPivotReportResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

clearPivotHeaders()

public RunPivotReportResponse.Builder clearPivotHeaders()

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
TypeDescription
RunPivotReportResponse.Builder

clearPropertyQuota()

public RunPivotReportResponse.Builder clearPropertyQuota()

This Analytics Property's quota state including this request.

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

Returns
TypeDescription
RunPivotReportResponse.Builder

clearRows()

public RunPivotReportResponse.Builder clearRows()

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

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

Returns
TypeDescription
RunPivotReportResponse.Builder

clone()

public RunPivotReportResponse.Builder clone()
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

getAggregates(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
Row

getAggregatesBuilder(int index)

public Row.Builder getAggregatesBuilder(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
NameDescription
indexint
Returns
TypeDescription
Row.Builder

getAggregatesBuilderList()

public List<Row.Builder> getAggregatesBuilderList()

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
TypeDescription
List<Builder>

getAggregatesCount()

public 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
TypeDescription
int

getAggregatesList()

public 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
TypeDescription
List<Row>

getAggregatesOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
RowOrBuilder

getAggregatesOrBuilderList()

public 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
TypeDescription
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getDefaultInstanceForType()

public RunPivotReportResponse getDefaultInstanceForType()
Returns
TypeDescription
RunPivotReportResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDimensionHeaders(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
DimensionHeader

getDimensionHeadersBuilder(int index)

public DimensionHeader.Builder getDimensionHeadersBuilder(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
NameDescription
indexint
Returns
TypeDescription
DimensionHeader.Builder

getDimensionHeadersBuilderList()

public List<DimensionHeader.Builder> getDimensionHeadersBuilderList()

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
TypeDescription
List<Builder>

getDimensionHeadersCount()

public 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
TypeDescription
int

getDimensionHeadersList()

public 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
TypeDescription
List<DimensionHeader>

getDimensionHeadersOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
DimensionHeaderOrBuilder

getDimensionHeadersOrBuilderList()

public 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
TypeDescription
List<? extends com.google.analytics.data.v1beta.DimensionHeaderOrBuilder>

getKind()

public 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
TypeDescription
String

The kind.

getKindBytes()

public 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
TypeDescription
ByteString

The bytes for kind.

getMetadata()

public ResponseMetaData getMetadata()

Metadata for the report.

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

Returns
TypeDescription
ResponseMetaData

The metadata.

getMetadataBuilder()

public ResponseMetaData.Builder getMetadataBuilder()

Metadata for the report.

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

Returns
TypeDescription
ResponseMetaData.Builder

getMetadataOrBuilder()

public ResponseMetaDataOrBuilder getMetadataOrBuilder()

Metadata for the report.

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

Returns
TypeDescription
ResponseMetaDataOrBuilder

getMetricHeaders(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
MetricHeader

getMetricHeadersBuilder(int index)

public MetricHeader.Builder getMetricHeadersBuilder(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
NameDescription
indexint
Returns
TypeDescription
MetricHeader.Builder

getMetricHeadersBuilderList()

public List<MetricHeader.Builder> getMetricHeadersBuilderList()

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
TypeDescription
List<Builder>

getMetricHeadersCount()

public 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
TypeDescription
int

getMetricHeadersList()

public 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
TypeDescription
List<MetricHeader>

getMetricHeadersOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
MetricHeaderOrBuilder

getMetricHeadersOrBuilderList()

public 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
TypeDescription
List<? extends com.google.analytics.data.v1beta.MetricHeaderOrBuilder>

getPivotHeaders(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
PivotHeader

getPivotHeadersBuilder(int index)

public PivotHeader.Builder getPivotHeadersBuilder(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
NameDescription
indexint
Returns
TypeDescription
PivotHeader.Builder

getPivotHeadersBuilderList()

public List<PivotHeader.Builder> getPivotHeadersBuilderList()

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
TypeDescription
List<Builder>

getPivotHeadersCount()

public 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
TypeDescription
int

getPivotHeadersList()

public 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
TypeDescription
List<PivotHeader>

getPivotHeadersOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
PivotHeaderOrBuilder

getPivotHeadersOrBuilderList()

public 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
TypeDescription
List<? extends com.google.analytics.data.v1beta.PivotHeaderOrBuilder>

getPropertyQuota()

public PropertyQuota getPropertyQuota()

This Analytics Property's quota state including this request.

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

Returns
TypeDescription
PropertyQuota

The propertyQuota.

getPropertyQuotaBuilder()

public PropertyQuota.Builder getPropertyQuotaBuilder()

This Analytics Property's quota state including this request.

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

Returns
TypeDescription
PropertyQuota.Builder

getPropertyQuotaOrBuilder()

public PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()

This Analytics Property's quota state including this request.

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

Returns
TypeDescription
PropertyQuotaOrBuilder

getRows(int index)

public Row getRows(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Row

getRowsBuilder(int index)

public Row.Builder getRowsBuilder(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Row.Builder

getRowsBuilderList()

public List<Row.Builder> getRowsBuilderList()

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

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

Returns
TypeDescription
List<Builder>

getRowsCount()

public int getRowsCount()

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

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

Returns
TypeDescription
int

getRowsList()

public List<Row> getRowsList()

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

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

Returns
TypeDescription
List<Row>

getRowsOrBuilder(int index)

public RowOrBuilder getRowsOrBuilder(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
RowOrBuilder

getRowsOrBuilderList()

public List<? extends RowOrBuilder> getRowsOrBuilderList()

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

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

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

hasMetadata()

public boolean hasMetadata()

Metadata for the report.

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

Returns
TypeDescription
boolean

Whether the metadata field is set.

hasPropertyQuota()

public boolean hasPropertyQuota()

This Analytics Property's quota state including this request.

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

Returns
TypeDescription
boolean

Whether the propertyQuota field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RunPivotReportResponse other)

public RunPivotReportResponse.Builder mergeFrom(RunPivotReportResponse other)
Parameter
NameDescription
otherRunPivotReportResponse
Returns
TypeDescription
RunPivotReportResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunPivotReportResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunPivotReportResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

mergeMetadata(ResponseMetaData value)

public RunPivotReportResponse.Builder mergeMetadata(ResponseMetaData value)

Metadata for the report.

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

Parameter
NameDescription
valueResponseMetaData
Returns
TypeDescription
RunPivotReportResponse.Builder

mergePropertyQuota(PropertyQuota value)

public RunPivotReportResponse.Builder mergePropertyQuota(PropertyQuota value)

This Analytics Property's quota state including this request.

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

Parameter
NameDescription
valuePropertyQuota
Returns
TypeDescription
RunPivotReportResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunPivotReportResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

removeAggregates(int index)

public RunPivotReportResponse.Builder removeAggregates(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
NameDescription
indexint
Returns
TypeDescription
RunPivotReportResponse.Builder

removeDimensionHeaders(int index)

public RunPivotReportResponse.Builder removeDimensionHeaders(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
NameDescription
indexint
Returns
TypeDescription
RunPivotReportResponse.Builder

removeMetricHeaders(int index)

public RunPivotReportResponse.Builder removeMetricHeaders(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
NameDescription
indexint
Returns
TypeDescription
RunPivotReportResponse.Builder

removePivotHeaders(int index)

public RunPivotReportResponse.Builder removePivotHeaders(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
NameDescription
indexint
Returns
TypeDescription
RunPivotReportResponse.Builder

removeRows(int index)

public RunPivotReportResponse.Builder removeRows(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
RunPivotReportResponse.Builder

setAggregates(int index, Row value)

public RunPivotReportResponse.Builder setAggregates(int index, Row value)

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;

Parameters
NameDescription
indexint
valueRow
Returns
TypeDescription
RunPivotReportResponse.Builder

setAggregates(int index, Row.Builder builderForValue)

public RunPivotReportResponse.Builder setAggregates(int index, Row.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueRow.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

setDimensionHeaders(int index, DimensionHeader value)

public RunPivotReportResponse.Builder setDimensionHeaders(int index, DimensionHeader value)

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;

Parameters
NameDescription
indexint
valueDimensionHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

setDimensionHeaders(int index, DimensionHeader.Builder builderForValue)

public RunPivotReportResponse.Builder setDimensionHeaders(int index, DimensionHeader.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueDimensionHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunPivotReportResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

setKind(String value)

public RunPivotReportResponse.Builder setKind(String value)

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;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
RunPivotReportResponse.Builder

This builder for chaining.

setKindBytes(ByteString value)

public RunPivotReportResponse.Builder setKindBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
RunPivotReportResponse.Builder

This builder for chaining.

setMetadata(ResponseMetaData value)

public RunPivotReportResponse.Builder setMetadata(ResponseMetaData value)

Metadata for the report.

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

Parameter
NameDescription
valueResponseMetaData
Returns
TypeDescription
RunPivotReportResponse.Builder

setMetadata(ResponseMetaData.Builder builderForValue)

public RunPivotReportResponse.Builder setMetadata(ResponseMetaData.Builder builderForValue)

Metadata for the report.

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

Parameter
NameDescription
builderForValueResponseMetaData.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

setMetricHeaders(int index, MetricHeader value)

public RunPivotReportResponse.Builder setMetricHeaders(int index, MetricHeader value)

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;

Parameters
NameDescription
indexint
valueMetricHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

setMetricHeaders(int index, MetricHeader.Builder builderForValue)

public RunPivotReportResponse.Builder setMetricHeaders(int index, MetricHeader.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueMetricHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

setPivotHeaders(int index, PivotHeader value)

public RunPivotReportResponse.Builder setPivotHeaders(int index, PivotHeader value)

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;

Parameters
NameDescription
indexint
valuePivotHeader
Returns
TypeDescription
RunPivotReportResponse.Builder

setPivotHeaders(int index, PivotHeader.Builder builderForValue)

public RunPivotReportResponse.Builder setPivotHeaders(int index, PivotHeader.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValuePivotHeader.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

setPropertyQuota(PropertyQuota value)

public RunPivotReportResponse.Builder setPropertyQuota(PropertyQuota value)

This Analytics Property's quota state including this request.

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

Parameter
NameDescription
valuePropertyQuota
Returns
TypeDescription
RunPivotReportResponse.Builder

setPropertyQuota(PropertyQuota.Builder builderForValue)

public RunPivotReportResponse.Builder setPropertyQuota(PropertyQuota.Builder builderForValue)

This Analytics Property's quota state including this request.

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

Parameter
NameDescription
builderForValuePropertyQuota.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunPivotReportResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides

setRows(int index, Row value)

public RunPivotReportResponse.Builder setRows(int index, Row value)

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

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

Parameters
NameDescription
indexint
valueRow
Returns
TypeDescription
RunPivotReportResponse.Builder

setRows(int index, Row.Builder builderForValue)

public RunPivotReportResponse.Builder setRows(int index, Row.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueRow.Builder
Returns
TypeDescription
RunPivotReportResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RunPivotReportResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunPivotReportResponse.Builder
Overrides