Google Analytics Data V1alpha Client - Class RunFunnelReportRequest (0.20.1)

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

The request for a funnel report.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ property string

Optional. A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234
↳ date_ranges array<DateRange>

Optional. Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges.
↳ funnel Funnel

Optional. The configuration of this request's funnel. This funnel configuration is required.
↳ funnel_breakdown FunnelBreakdown

Optional. If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the deviceCategory dimension will create rows for mobile, tablet, desktop, and the total.
↳ funnel_next_action FunnelNextAction

Optional. If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the eventName dimension will create rows for several events (for example session_start & click) and the total. Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.
↳ funnel_visualization_type int

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.
↳ segments array<Segment>

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment. Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name. The segments parameter is optional. Requests are limited to 4 segments.
↳ limit int|string

Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive. The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit.
↳ dimension_filter FilterExpression

Optional. Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Creating a Report: Dimension Filters for examples. Metrics cannot be used in this filter.
↳ return_property_quota bool

Optional. Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

getProperty

Optional. A Google Analytics property identifier whose events are tracked.

Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

Returns
Type Description
string

setProperty

Optional. A Google Analytics property identifier whose events are tracked.

Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

Parameter
Name Description
var string
Returns
Type Description
$this

getDateRanges

Optional. Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDateRanges

Optional. Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges.

Parameter
Name Description
var array<DateRange>
Returns
Type Description
$this

getFunnel

Optional. The configuration of this request's funnel. This funnel configuration is required.

Returns
Type Description
Funnel|null

hasFunnel

clearFunnel

setFunnel

Optional. The configuration of this request's funnel. This funnel configuration is required.

Parameter
Name Description
var Funnel
Returns
Type Description
$this

getFunnelBreakdown

Optional. If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the deviceCategory dimension will create rows for mobile, tablet, desktop, and the total.

Returns
Type Description
FunnelBreakdown|null

hasFunnelBreakdown

clearFunnelBreakdown

setFunnelBreakdown

Optional. If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the deviceCategory dimension will create rows for mobile, tablet, desktop, and the total.

Parameter
Name Description
var FunnelBreakdown
Returns
Type Description
$this

getFunnelNextAction

Optional. If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the eventName dimension will create rows for several events (for example session_start & click) and the total.

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

Returns
Type Description
FunnelNextAction|null

hasFunnelNextAction

clearFunnelNextAction

setFunnelNextAction

Optional. If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the eventName dimension will create rows for several events (for example session_start & click) and the total.

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

Parameter
Name Description
var FunnelNextAction
Returns
Type Description
$this

getFunnelVisualizationType

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

Returns
Type Description
int

setFunnelVisualizationType

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

Parameter
Name Description
var int
Returns
Type Description
$this

getSegments

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name. The segments parameter is optional. Requests are limited to 4 segments.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSegments

Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name. The segments parameter is optional. Requests are limited to 4 segments.

Parameter
Name Description
var array<Segment>
Returns
Type Description
$this

getLimit

Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit.

Returns
Type Description
int|string

setLimit

Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDimensionFilter

Optional. Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Creating a Report: Dimension Filters for examples. Metrics cannot be used in this filter.

Returns
Type Description
FilterExpression|null

hasDimensionFilter

clearDimensionFilter

setDimensionFilter

Optional. Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Creating a Report: Dimension Filters for examples. Metrics cannot be used in this filter.

Parameter
Name Description
var FilterExpression
Returns
Type Description
$this

getReturnPropertyQuota

Optional. Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

Returns
Type Description
bool

setReturnPropertyQuota

Optional. Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

Parameter
Name Description
var bool
Returns
Type Description
$this