Package com.google.analytics.data.v1alpha

Class RunFunnelReportRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RunFunnelReportRequest.Builder>
com.google.analytics.data.v1alpha.RunFunnelReportRequest.Builder
All Implemented Interfaces:
RunFunnelReportRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RunFunnelReportRequest
public static final class RunFunnelReportRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<RunFunnelReportRequest.Builder> implements RunFunnelReportRequestOrBuilder
 The request for a funnel report.
Protobuf type google.analytics.data.v1alpha.RunFunnelReportRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RunFunnelReportRequest.Builder>

    • clear

      public RunFunnelReportRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<RunFunnelReportRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RunFunnelReportRequest.Builder>

    • getDefaultInstanceForType

      public RunFunnelReportRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public RunFunnelReportRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RunFunnelReportRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public RunFunnelReportRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunFunnelReportRequest.Builder>

    • mergeFrom

      public RunFunnelReportRequest.Builder mergeFrom(RunFunnelReportRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RunFunnelReportRequest.Builder>

    • mergeFrom

      public RunFunnelReportRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunFunnelReportRequest.Builder>
      Throws:
      IOException

    • getProperty

      public String getProperty()
       Optional. A Google Analytics property identifier whose events are tracked.
 Specified in the URL path and not the body. To learn more, see [where to
 find your Property
 ID](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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getProperty in interface RunFunnelReportRequestOrBuilder
      Returns:
      The property.

    • getPropertyBytes

      public com.google.protobuf.ByteString getPropertyBytes()
       Optional. A Google Analytics property identifier whose events are tracked.
 Specified in the URL path and not the body. To learn more, see [where to
 find your Property
 ID](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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPropertyBytes in interface RunFunnelReportRequestOrBuilder
      Returns:
      The bytes for property.

    • setProperty

      public RunFunnelReportRequest.Builder setProperty(String value)
       Optional. A Google Analytics property identifier whose events are tracked.
 Specified in the URL path and not the body. To learn more, see [where to
 find your Property
 ID](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 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The property to set.
      Returns:
      This builder for chaining.

    • clearProperty

      public RunFunnelReportRequest.Builder clearProperty()
       Optional. A Google Analytics property identifier whose events are tracked.
 Specified in the URL path and not the body. To learn more, see [where to
 find your Property
 ID](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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setPropertyBytes

      public RunFunnelReportRequest.Builder setPropertyBytes(com.google.protobuf.ByteString value)
       Optional. A Google Analytics property identifier whose events are tracked.
 Specified in the URL path and not the body. To learn more, see [where to
 find your Property
 ID](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 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for property to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getDateRangesList in interface RunFunnelReportRequestOrBuilder

    • 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];
      Specified by:
      getDateRangesCount in interface RunFunnelReportRequestOrBuilder

    • getDateRanges

      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];
      Specified by:
      getDateRanges in interface RunFunnelReportRequestOrBuilder

    • setDateRanges

      public RunFunnelReportRequest.Builder setDateRanges(int index, DateRange value)
       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];

    • setDateRanges

      public RunFunnelReportRequest.Builder setDateRanges(int index, DateRange.Builder builderForValue)
       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];

    • addDateRanges

      public RunFunnelReportRequest.Builder addDateRanges(DateRange value)
       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];

    • addDateRanges

      public RunFunnelReportRequest.Builder addDateRanges(int index, DateRange value)
       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];

    • addDateRanges

      public RunFunnelReportRequest.Builder addDateRanges(DateRange.Builder builderForValue)
       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];

    • addDateRanges

      public RunFunnelReportRequest.Builder addDateRanges(int index, DateRange.Builder builderForValue)
       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];

    • addAllDateRanges

      public RunFunnelReportRequest.Builder addAllDateRanges(Iterable<? extends DateRange> values)
       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];

    • clearDateRanges

      public RunFunnelReportRequest.Builder clearDateRanges()
       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];

    • removeDateRanges

      public RunFunnelReportRequest.Builder removeDateRanges(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];

    • getDateRangesBuilder

      public DateRange.Builder getDateRangesBuilder(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];

    • getDateRangesOrBuilder

      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];
      Specified by:
      getDateRangesOrBuilder in interface RunFunnelReportRequestOrBuilder

    • 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];
      Specified by:
      getDateRangesOrBuilderList in interface RunFunnelReportRequestOrBuilder

    • addDateRangesBuilder

      public DateRange.Builder addDateRangesBuilder()
       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];

    • addDateRangesBuilder

      public DateRange.Builder addDateRangesBuilder(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];

    • getDateRangesBuilderList

      public List<DateRange.Builder> getDateRangesBuilderList()
       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];

    • 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];
      Specified by:
      hasFunnel in interface RunFunnelReportRequestOrBuilder
      Returns:
      Whether the funnel field is set.

    • 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];
      Specified by:
      getFunnel in interface RunFunnelReportRequestOrBuilder
      Returns:
      The funnel.

    • setFunnel

      public RunFunnelReportRequest.Builder setFunnel(Funnel value)
       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];

    • setFunnel

      public RunFunnelReportRequest.Builder setFunnel(Funnel.Builder builderForValue)
       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];

    • mergeFunnel

      public RunFunnelReportRequest.Builder mergeFunnel(Funnel value)
       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];

    • clearFunnel

      public RunFunnelReportRequest.Builder clearFunnel()
       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];

    • getFunnelBuilder

      public Funnel.Builder getFunnelBuilder()
       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];

    • 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];
      Specified by:
      getFunnelOrBuilder in interface RunFunnelReportRequestOrBuilder

    • 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];
      Specified by:
      hasFunnelBreakdown in interface RunFunnelReportRequestOrBuilder
      Returns:
      Whether the funnelBreakdown field is set.

    • 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];
      Specified by:
      getFunnelBreakdown in interface RunFunnelReportRequestOrBuilder
      Returns:
      The funnelBreakdown.

    • setFunnelBreakdown

      public RunFunnelReportRequest.Builder setFunnelBreakdown(FunnelBreakdown value)
       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];

    • setFunnelBreakdown

      public RunFunnelReportRequest.Builder setFunnelBreakdown(FunnelBreakdown.Builder builderForValue)
       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];

    • mergeFunnelBreakdown

      public RunFunnelReportRequest.Builder mergeFunnelBreakdown(FunnelBreakdown value)
       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];

    • clearFunnelBreakdown

      public RunFunnelReportRequest.Builder clearFunnelBreakdown()
       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];

    • getFunnelBreakdownBuilder

      public FunnelBreakdown.Builder getFunnelBreakdownBuilder()
       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];

    • 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];
      Specified by:
      getFunnelBreakdownOrBuilder in interface RunFunnelReportRequestOrBuilder

    • 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];
      Specified by:
      hasFunnelNextAction in interface RunFunnelReportRequestOrBuilder
      Returns:
      Whether the funnelNextAction field is set.

    • 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];
      Specified by:
      getFunnelNextAction in interface RunFunnelReportRequestOrBuilder
      Returns:
      The funnelNextAction.

    • setFunnelNextAction

      public RunFunnelReportRequest.Builder setFunnelNextAction(FunnelNextAction value)
       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];

    • setFunnelNextAction

      public RunFunnelReportRequest.Builder setFunnelNextAction(FunnelNextAction.Builder builderForValue)
       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];

    • mergeFunnelNextAction

      public RunFunnelReportRequest.Builder mergeFunnelNextAction(FunnelNextAction value)
       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];

    • clearFunnelNextAction

      public RunFunnelReportRequest.Builder clearFunnelNextAction()
       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];

    • getFunnelNextActionBuilder

      public FunnelNextAction.Builder getFunnelNextActionBuilder()
       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];

    • 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];
      Specified by:
      getFunnelNextActionOrBuilder in interface RunFunnelReportRequestOrBuilder

    • 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];
      Specified by:
      getFunnelVisualizationTypeValue in interface RunFunnelReportRequestOrBuilder
      Returns:
      The enum numeric value on the wire for funnelVisualizationType.

    • setFunnelVisualizationTypeValue

      public RunFunnelReportRequest.Builder setFunnelVisualizationTypeValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for funnelVisualizationType to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getFunnelVisualizationType in interface RunFunnelReportRequestOrBuilder
      Returns:
      The funnelVisualizationType.

    • setFunnelVisualizationType

      public RunFunnelReportRequest.Builder setFunnelVisualizationType(RunFunnelReportRequest.FunnelVisualizationType value)
       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];
      Parameters:
      value - The funnelVisualizationType to set.
      Returns:
      This builder for chaining.

    • clearFunnelVisualizationType

      public RunFunnelReportRequest.Builder clearFunnelVisualizationType()
       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:
      This builder for chaining.

    • 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];
      Specified by:
      getSegmentsList in interface RunFunnelReportRequestOrBuilder

    • 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];
      Specified by:
      getSegmentsCount in interface RunFunnelReportRequestOrBuilder

    • getSegments

      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];
      Specified by:
      getSegments in interface RunFunnelReportRequestOrBuilder

    • setSegments

      public RunFunnelReportRequest.Builder setSegments(int index, Segment value)
       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];

    • setSegments

      public RunFunnelReportRequest.Builder setSegments(int index, Segment.Builder builderForValue)
       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];

    • addSegments

      public RunFunnelReportRequest.Builder addSegments(Segment value)
       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];

    • addSegments

      public RunFunnelReportRequest.Builder addSegments(int index, Segment value)
       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];

    • addSegments

      public RunFunnelReportRequest.Builder addSegments(Segment.Builder builderForValue)
       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];

    • addSegments

      public RunFunnelReportRequest.Builder addSegments(int index, Segment.Builder builderForValue)
       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];

    • addAllSegments

      public RunFunnelReportRequest.Builder addAllSegments(Iterable<? extends Segment> values)
       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];

    • clearSegments

      public RunFunnelReportRequest.Builder clearSegments()
       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];

    • removeSegments

      public RunFunnelReportRequest.Builder removeSegments(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];

    • getSegmentsBuilder

      public Segment.Builder getSegmentsBuilder(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];

    • getSegmentsOrBuilder

      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];
      Specified by:
      getSegmentsOrBuilder in interface RunFunnelReportRequestOrBuilder

    • 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];
      Specified by:
      getSegmentsOrBuilderList in interface RunFunnelReportRequestOrBuilder

    • addSegmentsBuilder

      public Segment.Builder addSegmentsBuilder()
       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];

    • addSegmentsBuilder

      public Segment.Builder addSegmentsBuilder(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];

    • getSegmentsBuilderList

      public List<Segment.Builder> getSegmentsBuilderList()
       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];

    • 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];
      Specified by:
      getLimit in interface RunFunnelReportRequestOrBuilder
      Returns:
      The limit.

    • setLimit

      public RunFunnelReportRequest.Builder setLimit(long value)
       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];
      Parameters:
      value - The limit to set.
      Returns:
      This builder for chaining.

    • clearLimit

      public RunFunnelReportRequest.Builder clearLimit()
       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:
      This builder for chaining.

    • 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](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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDimensionFilter in interface RunFunnelReportRequestOrBuilder
      Returns:
      Whether the dimensionFilter field is set.

    • 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](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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDimensionFilter in interface RunFunnelReportRequestOrBuilder
      Returns:
      The dimensionFilter.

    • setDimensionFilter

      public RunFunnelReportRequest.Builder setDimensionFilter(FilterExpression value)
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • setDimensionFilter

      public RunFunnelReportRequest.Builder setDimensionFilter(FilterExpression.Builder builderForValue)
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • mergeDimensionFilter

      public RunFunnelReportRequest.Builder mergeDimensionFilter(FilterExpression value)
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • clearDimensionFilter

      public RunFunnelReportRequest.Builder clearDimensionFilter()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • getDimensionFilterBuilder

      public FilterExpression.Builder getDimensionFilterBuilder()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • 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](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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDimensionFilterOrBuilder in interface RunFunnelReportRequestOrBuilder

    • getReturnPropertyQuota

      public boolean getReturnPropertyQuota()
       Optional. Toggles whether to return the current state of this Analytics
 Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
      bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReturnPropertyQuota in interface RunFunnelReportRequestOrBuilder
      Returns:
      The returnPropertyQuota.

    • setReturnPropertyQuota

      public RunFunnelReportRequest.Builder setReturnPropertyQuota(boolean value)
       Optional. Toggles whether to return the current state of this Analytics
 Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
      bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The returnPropertyQuota to set.
      Returns:
      This builder for chaining.

    • clearReturnPropertyQuota

      public RunFunnelReportRequest.Builder clearReturnPropertyQuota()
       Optional. Toggles whether to return the current state of this Analytics
 Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
      bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.