Google Analytics Data V1alpha Client - Class RunFunnelReportResponse (0.21.1)

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

The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ funnel_table FunnelSubReport

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate. The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

↳ funnel_visualization FunnelSubReport

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users. The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

↳ property_quota PropertyQuota

This Analytics Property's quota state including this request.

↳ kind string

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

getFunnelTable

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

Returns
Type Description
FunnelSubReport|null

hasFunnelTable

clearFunnelTable

setFunnelTable

The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.

The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.

Parameter
Name Description
var FunnelSubReport
Returns
Type Description
$this

getFunnelVisualization

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

Returns
Type Description
FunnelSubReport|null

hasFunnelVisualization

clearFunnelVisualization

setFunnelVisualization

The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.

The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the TRENDED_FUNNEL funnel type. The next action dimension is only present in the response if it was requested.

Parameter
Name Description
var FunnelSubReport
Returns
Type Description
$this

getPropertyQuota

This Analytics Property's quota state including this request.

Returns
Type Description
PropertyQuota|null

hasPropertyQuota

clearPropertyQuota

setPropertyQuota

This Analytics Property's quota state including this request.

Parameter
Name Description
var PropertyQuota
Returns
Type Description
$this

getKind

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

Returns
Type Description
string

setKind

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

Parameter
Name Description
var string
Returns
Type Description
$this