Class RunFunnelReportRequest (0.53.0)

public final class RunFunnelReportRequest extends GeneratedMessageV3 implements RunFunnelReportRequestOrBuilder

The request for a funnel report.

Protobuf type google.analytics.data.v1alpha.RunFunnelReportRequest

Static Fields

DATE_RANGES_FIELD_NUMBER

public static final int DATE_RANGES_FIELD_NUMBER
Field Value
Type Description
int

DIMENSION_FILTER_FIELD_NUMBER

public static final int DIMENSION_FILTER_FIELD_NUMBER
Field Value
Type Description
int

FUNNEL_BREAKDOWN_FIELD_NUMBER

public static final int FUNNEL_BREAKDOWN_FIELD_NUMBER
Field Value
Type Description
int

FUNNEL_FIELD_NUMBER

public static final int FUNNEL_FIELD_NUMBER
Field Value
Type Description
int

FUNNEL_NEXT_ACTION_FIELD_NUMBER

public static final int FUNNEL_NEXT_ACTION_FIELD_NUMBER
Field Value
Type Description
int

FUNNEL_VISUALIZATION_TYPE_FIELD_NUMBER

public static final int FUNNEL_VISUALIZATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
Type Description
int

RETURN_PROPERTY_QUOTA_FIELD_NUMBER

public static final int RETURN_PROPERTY_QUOTA_FIELD_NUMBER
Field Value
Type Description
int

SEGMENTS_FIELD_NUMBER

public static final int SEGMENTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunFunnelReportRequest getDefaultInstance()
Returns
Type Description
RunFunnelReportRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RunFunnelReportRequest.Builder newBuilder()
Returns
Type Description
RunFunnelReportRequest.Builder

newBuilder(RunFunnelReportRequest prototype)

public static RunFunnelReportRequest.Builder newBuilder(RunFunnelReportRequest prototype)
Parameter
Name Description
prototype RunFunnelReportRequest
Returns
Type Description
RunFunnelReportRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunFunnelReportRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunFunnelReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunFunnelReportRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunFunnelReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunFunnelReportRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunFunnelReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunFunnelReportRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunFunnelReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunFunnelReportRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunFunnelReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunFunnelReportRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunFunnelReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunFunnelReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunFunnelReportRequest> parser()
Returns
Type Description
Parser<RunFunnelReportRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDateRanges(int index)

public DateRange getDateRanges(int index)

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.

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DateRange

getDateRangesCount()

public int getDateRangesCount()

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.

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDateRangesList()

public List<DateRange> getDateRangesList()

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.

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DateRange>

getDateRangesOrBuilder(int index)

public DateRangeOrBuilder getDateRangesOrBuilder(int index)

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.

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DateRangeOrBuilder

getDateRangesOrBuilderList()

public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

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.

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.analytics.data.v1alpha.DateRangeOrBuilder>

getDefaultInstanceForType()

public RunFunnelReportRequest getDefaultInstanceForType()
Returns
Type Description
RunFunnelReportRequest

getDimensionFilter()

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

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FilterExpression

The dimensionFilter.

getDimensionFilterOrBuilder()

public FilterExpressionOrBuilder getDimensionFilterOrBuilder()

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.

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FilterExpressionOrBuilder

getFunnel()

public Funnel getFunnel()

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

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Funnel

The funnel.

getFunnelBreakdown()

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

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FunnelBreakdown

The funnelBreakdown.

getFunnelBreakdownOrBuilder()

public FunnelBreakdownOrBuilder getFunnelBreakdownOrBuilder()

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.

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FunnelBreakdownOrBuilder

getFunnelNextAction()

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

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FunnelNextAction

The funnelNextAction.

getFunnelNextActionOrBuilder()

public FunnelNextActionOrBuilder getFunnelNextActionOrBuilder()

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.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FunnelNextActionOrBuilder

getFunnelOrBuilder()

public FunnelOrBuilder getFunnelOrBuilder()

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

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FunnelOrBuilder

getFunnelVisualizationType()

public RunFunnelReportRequest.FunnelVisualizationType getFunnelVisualizationType()

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

.google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RunFunnelReportRequest.FunnelVisualizationType

The funnelVisualizationType.

getFunnelVisualizationTypeValue()

public int getFunnelVisualizationTypeValue()

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

.google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for funnelVisualizationType.

getLimit()

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

int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The limit.

getParserForType()

public Parser<RunFunnelReportRequest> getParserForType()
Returns
Type Description
Parser<RunFunnelReportRequest>
Overrides

getProperty()

public String getProperty()

Optional. A Google Analytics GA4 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

string property = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The property.

getPropertyBytes()

public ByteString getPropertyBytes()

Optional. A Google Analytics GA4 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

string property = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for property.

getReturnPropertyQuota()

public boolean getReturnPropertyQuota()

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

bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnPropertyQuota.

getSegments(int index)

public Segment getSegments(int index)

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.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Segment

getSegmentsCount()

public int getSegmentsCount()

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.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSegmentsList()

public List<Segment> getSegmentsList()

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.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Segment>

getSegmentsOrBuilder(int index)

public SegmentOrBuilder getSegmentsOrBuilder(int index)

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.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SegmentOrBuilder

getSegmentsOrBuilderList()

public List<? extends SegmentOrBuilder> getSegmentsOrBuilderList()

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.

repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.analytics.data.v1alpha.SegmentOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDimensionFilter()

public boolean hasDimensionFilter()

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.

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dimensionFilter field is set.

hasFunnel()

public boolean hasFunnel()

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

.google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the funnel field is set.

hasFunnelBreakdown()

public boolean hasFunnelBreakdown()

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.

.google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the funnelBreakdown field is set.

hasFunnelNextAction()

public boolean hasFunnelNextAction()

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.

.google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the funnelNextAction field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunFunnelReportRequest.Builder newBuilderForType()
Returns
Type Description
RunFunnelReportRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunFunnelReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunFunnelReportRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RunFunnelReportRequest.Builder toBuilder()
Returns
Type Description
RunFunnelReportRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException