public final class RunFunnelReportRequest extends GeneratedMessageV3 implements RunFunnelReportRequestOrBuilder
The request for a funnel report.
Protobuf type google.analytics.data.v1alpha.RunFunnelReportRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RunFunnelReportRequest.Builder newBuilder()
newBuilder(RunFunnelReportRequest prototype)
public static RunFunnelReportRequest.Builder newBuilder(RunFunnelReportRequest prototype)
public static RunFunnelReportRequest parseDelimitedFrom(InputStream input)
public static RunFunnelReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RunFunnelReportRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunFunnelReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RunFunnelReportRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunFunnelReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunFunnelReportRequest parseFrom(CodedInputStream input)
public static RunFunnelReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RunFunnelReportRequest parseFrom(InputStream input)
public static RunFunnelReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RunFunnelReportRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunFunnelReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RunFunnelReportRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDateRanges(int index)
public DateRange getDateRanges(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
getDateRangesCount()
public int getDateRangesCount()
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;
| Returns |
|---|
| Type | Description |
int | |
getDateRangesList()
public List<DateRange> getDateRangesList()
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;
getDateRangesOrBuilder(int index)
public DateRangeOrBuilder getDateRangesOrBuilder(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
getDateRangesOrBuilderList()
public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.data.v1alpha.DateRangeOrBuilder> | |
getDefaultInstanceForType()
public RunFunnelReportRequest getDefaultInstanceForType()
getDimensionFilter()
public FilterExpression getDimensionFilter()
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;
getDimensionFilterOrBuilder()
public FilterExpressionOrBuilder getDimensionFilterOrBuilder()
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;
getFunnel()
public Funnel getFunnel()
The configuration of this request's funnel. This funnel configuration is
required.
.google.analytics.data.v1alpha.Funnel funnel = 3;
| Returns |
|---|
| Type | Description |
Funnel | The funnel.
|
getFunnelBreakdown()
public FunnelBreakdown getFunnelBreakdown()
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;
getFunnelBreakdownOrBuilder()
public FunnelBreakdownOrBuilder getFunnelBreakdownOrBuilder()
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;
getFunnelNextAction()
public FunnelNextAction getFunnelNextAction()
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 (i.e.
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;
getFunnelNextActionOrBuilder()
public FunnelNextActionOrBuilder getFunnelNextActionOrBuilder()
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 (i.e.
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;
getFunnelOrBuilder()
public FunnelOrBuilder getFunnelOrBuilder()
The configuration of this request's funnel. This funnel configuration is
required.
.google.analytics.data.v1alpha.Funnel funnel = 3;
getFunnelVisualizationType()
public RunFunnelReportRequest.FunnelVisualizationType getFunnelVisualizationType()
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;
getFunnelVisualizationTypeValue()
public int getFunnelVisualizationTypeValue()
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;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for funnelVisualizationType.
|
getLimit()
The number of rows to return. If unspecified, 10,000 rows are returned. The
API returns a maximum of 100,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;
| Returns |
|---|
| Type | Description |
long | The limit.
|
getParserForType()
public Parser<RunFunnelReportRequest> getParserForType()
Overrides
getProperty()
public String getProperty()
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;
| Returns |
|---|
| Type | Description |
String | The property.
|
getPropertyBytes()
public ByteString getPropertyBytes()
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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for property.
|
getReturnPropertyQuota()
public boolean getReturnPropertyQuota()
Toggles whether to return the current state of this Analytics Property's
quota. Quota is returned in PropertyQuota.
bool return_property_quota = 12;
| Returns |
|---|
| Type | Description |
boolean | The returnPropertyQuota.
|
getSegments(int index)
public Segment getSegments(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
getSegmentsCount()
public int getSegmentsCount()
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;
| Returns |
|---|
| Type | Description |
int | |
getSegmentsList()
public List<Segment> getSegmentsList()
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;
getSegmentsOrBuilder(int index)
public SegmentOrBuilder getSegmentsOrBuilder(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
getSegmentsOrBuilderList()
public List<? extends SegmentOrBuilder> getSegmentsOrBuilderList()
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.data.v1alpha.SegmentOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hasDimensionFilter()
public boolean hasDimensionFilter()
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the dimensionFilter field is set.
|
hasFunnel()
public boolean hasFunnel()
The configuration of this request's funnel. This funnel configuration is
required.
.google.analytics.data.v1alpha.Funnel funnel = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the funnel field is set.
|
hasFunnelBreakdown()
public boolean hasFunnelBreakdown()
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the funnelBreakdown field is set.
|
hasFunnelNextAction()
public boolean hasFunnelNextAction()
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 (i.e.
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the funnelNextAction field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RunFunnelReportRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunFunnelReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RunFunnelReportRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
