Package com.google.analytics.data.v1alpha

Interface FunnelStepOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FunnelStep, FunnelStep.Builder
@Generated public interface FunnelStepOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    FunnelFilterExpression
    getFilterExpression()
    The condition that your users must meet to be included in this step of the funnel journey.
    FunnelFilterExpressionOrBuilder
    getFilterExpressionOrBuilder()
    The condition that your users must meet to be included in this step of the funnel journey.
    boolean
    getIsDirectlyFollowedBy()
    If true, this step must directly follow the previous step.
    String
    getName()
    The distinctive name for this step.
    com.google.protobuf.ByteString
    getNameBytes()
    The distinctive name for this step.
    com.google.protobuf.Duration
    getWithinDurationFromPriorStep()
    If specified, this step must complete within this duration of the completion of the prior step.
    com.google.protobuf.DurationOrBuilder
    getWithinDurationFromPriorStepOrBuilder()
    If specified, this step must complete within this duration of the completion of the prior step.
    boolean
    hasFilterExpression()
    The condition that your users must meet to be included in this step of the funnel journey.
    boolean
    hasWithinDurationFromPriorStep()
    If specified, this step must complete within this duration of the completion of the prior step.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
 defines string value returned by the `funnelStepName` dimension. For
 example, specifying `name = Purchase` in the request's third funnel step
 will produce `3. Purchase` in the funnel report response.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
 defines string value returned by the `funnelStepName` dimension. For
 example, specifying `name = Purchase` in the request's third funnel step
 will produce `3. Purchase` in the funnel report response.
      string name = 1;
      Returns:
      The bytes for name.

    • getIsDirectlyFollowedBy

      boolean getIsDirectlyFollowedBy()
       If true, this step must directly follow the previous step. If false,
 there can be events between the previous step and this step. If
 unspecified, `isDirectlyFollowedBy` is treated as false.
      bool is_directly_followed_by = 2;
      Returns:
      The isDirectlyFollowedBy.

    • hasWithinDurationFromPriorStep

      boolean hasWithinDurationFromPriorStep()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;
      Returns:
      Whether the withinDurationFromPriorStep field is set.

    • getWithinDurationFromPriorStep

      com.google.protobuf.Duration getWithinDurationFromPriorStep()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;
      Returns:
      The withinDurationFromPriorStep.

    • getWithinDurationFromPriorStepOrBuilder

      com.google.protobuf.DurationOrBuilder getWithinDurationFromPriorStepOrBuilder()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;

    • hasFilterExpression

      boolean hasFilterExpression()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;
      Returns:
      Whether the filterExpression field is set.

    • getFilterExpression

      FunnelFilterExpression getFilterExpression()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;
      Returns:
      The filterExpression.

    • getFilterExpressionOrBuilder

      FunnelFilterExpressionOrBuilder getFilterExpressionOrBuilder()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;