Google Analytics Data V1alpha Client - Class FunnelSubReport (0.14.0)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class FunnelSubReport.

Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.

Generated from protobuf message google.analytics.data.v1alpha.FunnelSubReport

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ dimension_headers array<Google\Analytics\Data\V1alpha\DimensionHeader>

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

↳ metric_headers array<Google\Analytics\Data\V1alpha\MetricHeader>

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

↳ rows array<Google\Analytics\Data\V1alpha\Row>

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

↳ metadata Google\Analytics\Data\V1alpha\FunnelResponseMetadata

Metadata for the funnel report.

getDimensionHeaders

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDimensionHeaders

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\DimensionHeader>
Returns
TypeDescription
$this

getMetricHeaders

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMetricHeaders

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\MetricHeader>
Returns
TypeDescription
$this

getRows

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRows

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

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\Row>
Returns
TypeDescription
$this

getMetadata

Metadata for the funnel report.

Returns
TypeDescription
Google\Analytics\Data\V1alpha\FunnelResponseMetadata|null

hasMetadata

clearMetadata

setMetadata

Metadata for the funnel report.

Parameter
NameDescription
var Google\Analytics\Data\V1alpha\FunnelResponseMetadata
Returns
TypeDescription
$this