public static final class RunFunnelReportRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder> implements RunFunnelReportRequestOrBuilder
The request for a funnel report.Protobuf type
google.analytics.data.v1alpha.RunFunnelReportRequest| Modifier and Type | Method and Description |
|---|---|
RunFunnelReportRequest.Builder |
addAllDateRanges(Iterable<? extends DateRange> values)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
addAllSegments(Iterable<? extends Segment> values)
The configurations of segments.
|
RunFunnelReportRequest.Builder |
addDateRanges(DateRange.Builder builderForValue)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
addDateRanges(DateRange value)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
addDateRanges(int index,
DateRange.Builder builderForValue)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
addDateRanges(int index,
DateRange value)
Date ranges of data to read.
|
DateRange.Builder |
addDateRangesBuilder()
Date ranges of data to read.
|
DateRange.Builder |
addDateRangesBuilder(int index)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RunFunnelReportRequest.Builder |
addSegments(int index,
Segment.Builder builderForValue)
The configurations of segments.
|
RunFunnelReportRequest.Builder |
addSegments(int index,
Segment value)
The configurations of segments.
|
RunFunnelReportRequest.Builder |
addSegments(Segment.Builder builderForValue)
The configurations of segments.
|
RunFunnelReportRequest.Builder |
addSegments(Segment value)
The configurations of segments.
|
Segment.Builder |
addSegmentsBuilder()
The configurations of segments.
|
Segment.Builder |
addSegmentsBuilder(int index)
The configurations of segments.
|
RunFunnelReportRequest |
build() |
RunFunnelReportRequest |
buildPartial() |
RunFunnelReportRequest.Builder |
clear() |
RunFunnelReportRequest.Builder |
clearDateRanges()
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
clearDimensionFilter()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
RunFunnelReportRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
RunFunnelReportRequest.Builder |
clearFunnel()
The configuration of this request's funnel.
|
RunFunnelReportRequest.Builder |
clearFunnelBreakdown()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
RunFunnelReportRequest.Builder |
clearFunnelNextAction()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
RunFunnelReportRequest.Builder |
clearFunnelVisualizationType()
The funnel visualization type controls the dimensions present in the funnel
visualization sub report response.
|
RunFunnelReportRequest.Builder |
clearLimit()
The number of rows to return.
|
RunFunnelReportRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
RunFunnelReportRequest.Builder |
clearProperty()
A Google Analytics GA4 property identifier whose events are tracked.
|
RunFunnelReportRequest.Builder |
clearReturnPropertyQuota()
Toggles whether to return the current state of this Analytics Property's
quota.
|
RunFunnelReportRequest.Builder |
clearSegments()
The configurations of segments.
|
RunFunnelReportRequest.Builder |
clone() |
DateRange |
getDateRanges(int index)
Date ranges of data to read.
|
DateRange.Builder |
getDateRangesBuilder(int index)
Date ranges of data to read.
|
List<DateRange.Builder> |
getDateRangesBuilderList()
Date ranges of data to read.
|
int |
getDateRangesCount()
Date ranges of data to read.
|
List<DateRange> |
getDateRangesList()
Date ranges of data to read.
|
DateRangeOrBuilder |
getDateRangesOrBuilder(int index)
Date ranges of data to read.
|
List<? extends DateRangeOrBuilder> |
getDateRangesOrBuilderList()
Date ranges of data to read.
|
RunFunnelReportRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
FilterExpression |
getDimensionFilter()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
FilterExpression.Builder |
getDimensionFilterBuilder()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
FilterExpressionOrBuilder |
getDimensionFilterOrBuilder()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
Funnel |
getFunnel()
The configuration of this request's funnel.
|
FunnelBreakdown |
getFunnelBreakdown()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
FunnelBreakdown.Builder |
getFunnelBreakdownBuilder()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
FunnelBreakdownOrBuilder |
getFunnelBreakdownOrBuilder()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
Funnel.Builder |
getFunnelBuilder()
The configuration of this request's funnel.
|
FunnelNextAction |
getFunnelNextAction()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
FunnelNextAction.Builder |
getFunnelNextActionBuilder()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
FunnelNextActionOrBuilder |
getFunnelNextActionOrBuilder()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
FunnelOrBuilder |
getFunnelOrBuilder()
The configuration of this request's funnel.
|
RunFunnelReportRequest.FunnelVisualizationType |
getFunnelVisualizationType()
The funnel visualization type controls the dimensions present in the funnel
visualization sub report response.
|
int |
getFunnelVisualizationTypeValue()
The funnel visualization type controls the dimensions present in the funnel
visualization sub report response.
|
long |
getLimit()
The number of rows to return.
|
String |
getProperty()
A Google Analytics GA4 property identifier whose events are tracked.
|
com.google.protobuf.ByteString |
getPropertyBytes()
A Google Analytics GA4 property identifier whose events are tracked.
|
boolean |
getReturnPropertyQuota()
Toggles whether to return the current state of this Analytics Property's
quota.
|
Segment |
getSegments(int index)
The configurations of segments.
|
Segment.Builder |
getSegmentsBuilder(int index)
The configurations of segments.
|
List<Segment.Builder> |
getSegmentsBuilderList()
The configurations of segments.
|
int |
getSegmentsCount()
The configurations of segments.
|
List<Segment> |
getSegmentsList()
The configurations of segments.
|
SegmentOrBuilder |
getSegmentsOrBuilder(int index)
The configurations of segments.
|
List<? extends SegmentOrBuilder> |
getSegmentsOrBuilderList()
The configurations of segments.
|
boolean |
hasDimensionFilter()
Dimension filters allow you to ask for only specific dimension values in
the report.
|
boolean |
hasFunnel()
The configuration of this request's funnel.
|
boolean |
hasFunnelBreakdown()
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
boolean |
hasFunnelNextAction()
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
RunFunnelReportRequest.Builder |
mergeDimensionFilter(FilterExpression value)
Dimension filters allow you to ask for only specific dimension values in
the report.
|
RunFunnelReportRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
RunFunnelReportRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
RunFunnelReportRequest.Builder |
mergeFrom(RunFunnelReportRequest other) |
RunFunnelReportRequest.Builder |
mergeFunnel(Funnel value)
The configuration of this request's funnel.
|
RunFunnelReportRequest.Builder |
mergeFunnelBreakdown(FunnelBreakdown value)
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
RunFunnelReportRequest.Builder |
mergeFunnelNextAction(FunnelNextAction value)
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
RunFunnelReportRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
RunFunnelReportRequest.Builder |
removeDateRanges(int index)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
removeSegments(int index)
The configurations of segments.
|
RunFunnelReportRequest.Builder |
setDateRanges(int index,
DateRange.Builder builderForValue)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
setDateRanges(int index,
DateRange value)
Date ranges of data to read.
|
RunFunnelReportRequest.Builder |
setDimensionFilter(FilterExpression.Builder builderForValue)
Dimension filters allow you to ask for only specific dimension values in
the report.
|
RunFunnelReportRequest.Builder |
setDimensionFilter(FilterExpression value)
Dimension filters allow you to ask for only specific dimension values in
the report.
|
RunFunnelReportRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RunFunnelReportRequest.Builder |
setFunnel(Funnel.Builder builderForValue)
The configuration of this request's funnel.
|
RunFunnelReportRequest.Builder |
setFunnel(Funnel value)
The configuration of this request's funnel.
|
RunFunnelReportRequest.Builder |
setFunnelBreakdown(FunnelBreakdown.Builder builderForValue)
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
RunFunnelReportRequest.Builder |
setFunnelBreakdown(FunnelBreakdown value)
If specified, this breakdown adds a dimension to the funnel table sub
report response.
|
RunFunnelReportRequest.Builder |
setFunnelNextAction(FunnelNextAction.Builder builderForValue)
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
RunFunnelReportRequest.Builder |
setFunnelNextAction(FunnelNextAction value)
If specified, next action adds a dimension to the funnel visualization sub
report response.
|
RunFunnelReportRequest.Builder |
setFunnelVisualizationType(RunFunnelReportRequest.FunnelVisualizationType value)
The funnel visualization type controls the dimensions present in the funnel
visualization sub report response.
|
RunFunnelReportRequest.Builder |
setFunnelVisualizationTypeValue(int value)
The funnel visualization type controls the dimensions present in the funnel
visualization sub report response.
|
RunFunnelReportRequest.Builder |
setLimit(long value)
The number of rows to return.
|
RunFunnelReportRequest.Builder |
setProperty(String value)
A Google Analytics GA4 property identifier whose events are tracked.
|
RunFunnelReportRequest.Builder |
setPropertyBytes(com.google.protobuf.ByteString value)
A Google Analytics GA4 property identifier whose events are tracked.
|
RunFunnelReportRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
RunFunnelReportRequest.Builder |
setReturnPropertyQuota(boolean value)
Toggles whether to return the current state of this Analytics Property's
quota.
|
RunFunnelReportRequest.Builder |
setSegments(int index,
Segment.Builder builderForValue)
The configurations of segments.
|
RunFunnelReportRequest.Builder |
setSegments(int index,
Segment value)
The configurations of segments.
|
RunFunnelReportRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RunFunnelReportRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RunFunnelReportRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RunFunnelReportRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder mergeFrom(RunFunnelReportRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public RunFunnelReportRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunFunnelReportRequest.Builder>IOExceptionpublic 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](https://developers.google.com/analytics/devguides/reporting/data/v1/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;getProperty in interface RunFunnelReportRequestOrBuilderpublic com.google.protobuf.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](https://developers.google.com/analytics/devguides/reporting/data/v1/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;getPropertyBytes in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setProperty(String value)
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](https://developers.google.com/analytics/devguides/reporting/data/v1/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;value - The property to set.public RunFunnelReportRequest.Builder clearProperty()
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](https://developers.google.com/analytics/devguides/reporting/data/v1/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;public RunFunnelReportRequest.Builder setPropertyBytes(com.google.protobuf.ByteString value)
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](https://developers.google.com/analytics/devguides/reporting/data/v1/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;value - The bytes for property to set.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;getDateRangesList in interface RunFunnelReportRequestOrBuilderpublic 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;getDateRangesCount in interface RunFunnelReportRequestOrBuilderpublic 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;getDateRanges in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setDateRanges(int index, DateRange value)
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;public RunFunnelReportRequest.Builder setDateRanges(int index, DateRange.Builder builderForValue)
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;public RunFunnelReportRequest.Builder addDateRanges(DateRange value)
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;public RunFunnelReportRequest.Builder addDateRanges(int index, DateRange value)
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;public RunFunnelReportRequest.Builder addDateRanges(DateRange.Builder builderForValue)
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;public RunFunnelReportRequest.Builder addDateRanges(int index, DateRange.Builder builderForValue)
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;public RunFunnelReportRequest.Builder addAllDateRanges(Iterable<? extends DateRange> values)
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;public RunFunnelReportRequest.Builder clearDateRanges()
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;public RunFunnelReportRequest.Builder removeDateRanges(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;public DateRange.Builder getDateRangesBuilder(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;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;getDateRangesOrBuilder in interface RunFunnelReportRequestOrBuilderpublic 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;getDateRangesOrBuilderList in interface RunFunnelReportRequestOrBuilderpublic DateRange.Builder addDateRangesBuilder()
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;public DateRange.Builder addDateRangesBuilder(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;public List<DateRange.Builder> getDateRangesBuilderList()
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;public boolean hasFunnel()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;hasFunnel in interface RunFunnelReportRequestOrBuilderpublic Funnel getFunnel()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;getFunnel in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setFunnel(Funnel value)
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;public RunFunnelReportRequest.Builder setFunnel(Funnel.Builder builderForValue)
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;public RunFunnelReportRequest.Builder mergeFunnel(Funnel value)
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;public RunFunnelReportRequest.Builder clearFunnel()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;public Funnel.Builder getFunnelBuilder()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;public FunnelOrBuilder getFunnelOrBuilder()
The configuration of this request's funnel. This funnel configuration is required.
.google.analytics.data.v1alpha.Funnel funnel = 3;getFunnelOrBuilder in interface RunFunnelReportRequestOrBuilderpublic 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;hasFunnelBreakdown in interface RunFunnelReportRequestOrBuilderpublic 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;getFunnelBreakdown in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setFunnelBreakdown(FunnelBreakdown value)
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;public RunFunnelReportRequest.Builder setFunnelBreakdown(FunnelBreakdown.Builder builderForValue)
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;public RunFunnelReportRequest.Builder mergeFunnelBreakdown(FunnelBreakdown value)
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;public RunFunnelReportRequest.Builder clearFunnelBreakdown()
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;public FunnelBreakdown.Builder getFunnelBreakdownBuilder()
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;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;getFunnelBreakdownOrBuilder in interface RunFunnelReportRequestOrBuilderpublic 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;hasFunnelNextAction in interface RunFunnelReportRequestOrBuilderpublic 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;getFunnelNextAction in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setFunnelNextAction(FunnelNextAction value)
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;public RunFunnelReportRequest.Builder setFunnelNextAction(FunnelNextAction.Builder builderForValue)
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;public RunFunnelReportRequest.Builder mergeFunnelNextAction(FunnelNextAction value)
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;public RunFunnelReportRequest.Builder clearFunnelNextAction()
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;public FunnelNextAction.Builder getFunnelNextActionBuilder()
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;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;getFunnelNextActionOrBuilder in interface RunFunnelReportRequestOrBuilderpublic 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;
getFunnelVisualizationTypeValue in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setFunnelVisualizationTypeValue(int value)
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;
value - The enum numeric value on the wire for funnelVisualizationType to set.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;
getFunnelVisualizationType in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setFunnelVisualizationType(RunFunnelReportRequest.FunnelVisualizationType value)
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;
value - The funnelVisualizationType to set.public RunFunnelReportRequest.Builder clearFunnelVisualizationType()
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;
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;getSegmentsList in interface RunFunnelReportRequestOrBuilderpublic 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;getSegmentsCount in interface RunFunnelReportRequestOrBuilderpublic 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;getSegments in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setSegments(int index, Segment value)
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;public RunFunnelReportRequest.Builder setSegments(int index, Segment.Builder builderForValue)
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;public RunFunnelReportRequest.Builder addSegments(Segment value)
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;public RunFunnelReportRequest.Builder addSegments(int index, Segment value)
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;public RunFunnelReportRequest.Builder addSegments(Segment.Builder builderForValue)
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;public RunFunnelReportRequest.Builder addSegments(int index, Segment.Builder builderForValue)
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;public RunFunnelReportRequest.Builder addAllSegments(Iterable<? extends Segment> values)
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;public RunFunnelReportRequest.Builder clearSegments()
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;public RunFunnelReportRequest.Builder removeSegments(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;public Segment.Builder getSegmentsBuilder(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;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;getSegmentsOrBuilder in interface RunFunnelReportRequestOrBuilderpublic 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;getSegmentsOrBuilderList in interface RunFunnelReportRequestOrBuilderpublic Segment.Builder addSegmentsBuilder()
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;public Segment.Builder addSegmentsBuilder(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;public List<Segment.Builder> getSegmentsBuilderList()
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;public long 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;getLimit in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setLimit(long value)
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;value - The limit to set.public RunFunnelReportRequest.Builder clearLimit()
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;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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;hasDimensionFilter in interface RunFunnelReportRequestOrBuilderpublic 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;getDimensionFilter in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setDimensionFilter(FilterExpression value)
Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Creating a Report: Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;public RunFunnelReportRequest.Builder setDimensionFilter(FilterExpression.Builder builderForValue)
Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Creating a Report: Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;public RunFunnelReportRequest.Builder mergeDimensionFilter(FilterExpression value)
Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Creating a Report: Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;public RunFunnelReportRequest.Builder clearDimensionFilter()
Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Creating a Report: Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;public FilterExpression.Builder getDimensionFilterBuilder()
Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Creating a Report: Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;getDimensionFilterOrBuilder in interface RunFunnelReportRequestOrBuilderpublic boolean getReturnPropertyQuota()
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
bool return_property_quota = 12;getReturnPropertyQuota in interface RunFunnelReportRequestOrBuilderpublic RunFunnelReportRequest.Builder setReturnPropertyQuota(boolean value)
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
bool return_property_quota = 12;value - The returnPropertyQuota to set.public RunFunnelReportRequest.Builder clearReturnPropertyQuota()
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
bool return_property_quota = 12;public final RunFunnelReportRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>public final RunFunnelReportRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunFunnelReportRequest.Builder>Copyright © 2023 Google LLC. All rights reserved.