Class RunPivotReportResponse.Builder (0.63.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunPivotReportResponse.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
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
Name Description
value Row
Returns
Type Description
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
Name Description
builderForValue Row.Builder
Returns
Type Description
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
Name Description
index int
value Row
Returns
Type Description
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
Name Description
index int
builderForValue Row.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.Row>
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.DimensionHeader>
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.MetricHeader>
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.PivotHeader>
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.Row>
Returns
Type Description
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
Name Description
value DimensionHeader
Returns
Type Description
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
Name Description
builderForValue DimensionHeader.Builder
Returns
Type Description
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
Name Description
index int
value DimensionHeader
Returns
Type Description
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
Name Description
index int
builderForValue DimensionHeader.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
value MetricHeader
Returns
Type Description
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
Name Description
builderForValue MetricHeader.Builder
Returns
Type Description
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
Name Description
index int
value MetricHeader
Returns
Type Description
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
Name Description
index int
builderForValue MetricHeader.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
value PivotHeader
Returns
Type Description
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
Name Description
builderForValue PivotHeader.Builder
Returns
Type Description
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
Name Description
index int
value PivotHeader
Returns
Type Description
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
Name Description
index int
builderForValue PivotHeader.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
PivotHeader.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunPivotReportResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value Row
Returns
Type Description
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
Name Description
builderForValue Row.Builder
Returns
Type Description
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
Name Description
index int
value Row
Returns
Type Description
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
Name Description
index int
builderForValue Row.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
Row.Builder

build()

public RunPivotReportResponse build()
Returns
Type Description
RunPivotReportResponse

buildPartial()

public RunPivotReportResponse buildPartial()
Returns
Type Description
RunPivotReportResponse

clear()

public RunPivotReportResponse.Builder clear()
Returns
Type Description
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
Type Description
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
Type Description
RunPivotReportResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public RunPivotReportResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
RunPivotReportResponse.Builder

This builder for chaining.

clearMetadata()

public RunPivotReportResponse.Builder clearMetadata()

Metadata for the report.

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

Returns
Type Description
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
Type Description
RunPivotReportResponse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RunPivotReportResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
RunPivotReportResponse.Builder

clone()

public RunPivotReportResponse.Builder clone()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getDefaultInstanceForType()

public RunPivotReportResponse getDefaultInstanceForType()
Returns
Type Description
RunPivotReportResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for kind.

getMetadata()

public ResponseMetaData getMetadata()

Metadata for the report.

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

Returns
Type Description
ResponseMetaData

The metadata.

getMetadataBuilder()

public ResponseMetaData.Builder getMetadataBuilder()

Metadata for the report.

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

Returns
Type Description
ResponseMetaData.Builder

getMetadataOrBuilder()

public ResponseMetaDataOrBuilder getMetadataOrBuilder()

Metadata for the report.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
PropertyQuota.Builder

getPropertyQuotaOrBuilder()

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

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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

hasMetadata()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RunPivotReportResponse other)

public RunPivotReportResponse.Builder mergeFrom(RunPivotReportResponse other)
Parameter
Name Description
other RunPivotReportResponse
Returns
Type Description
RunPivotReportResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunPivotReportResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunPivotReportResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunPivotReportResponse.Builder
Overrides

mergeMetadata(ResponseMetaData value)

public RunPivotReportResponse.Builder mergeMetadata(ResponseMetaData value)

Metadata for the report.

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

Parameter
Name Description
value ResponseMetaData
Returns
Type Description
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
Name Description
value PropertyQuota
Returns
Type Description
RunPivotReportResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunPivotReportResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
value Row
Returns
Type Description
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
Name Description
index int
builderForValue Row.Builder
Returns
Type Description
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
Name Description
index int
value DimensionHeader
Returns
Type Description
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
Name Description
index int
builderForValue DimensionHeader.Builder
Returns
Type Description
RunPivotReportResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunPivotReportResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The kind to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
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
Name Description
value ResponseMetaData
Returns
Type Description
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
Name Description
builderForValue ResponseMetaData.Builder
Returns
Type Description
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
Name Description
index int
value MetricHeader
Returns
Type Description
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
Name Description
index int
builderForValue MetricHeader.Builder
Returns
Type Description
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
Name Description
index int
value PivotHeader
Returns
Type Description
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
Name Description
index int
builderForValue PivotHeader.Builder
Returns
Type Description
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
Name Description
value PropertyQuota
Returns
Type Description
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
Name Description
builderForValue PropertyQuota.Builder
Returns
Type Description
RunPivotReportResponse.Builder

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

public RunPivotReportResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
index int
value Row
Returns
Type Description
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
Name Description
index int
builderForValue Row.Builder
Returns
Type Description
RunPivotReportResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RunPivotReportResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunPivotReportResponse.Builder
Overrides