Package com.google.analytics.data.v1alpha

Class RunFunnelReportRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1alpha.RunFunnelReportRequest
All Implemented Interfaces:
RunFunnelReportRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RunFunnelReportRequest extends com.google.protobuf.GeneratedMessage implements RunFunnelReportRequestOrBuilder
 The request for a funnel report.
Protobuf type google.analytics.data.v1alpha.RunFunnelReportRequest
See Also:

  • Field Details

    • PROPERTY_FIELD_NUMBER

      public static final int PROPERTY_FIELD_NUMBER
      See Also:

    • DATE_RANGES_FIELD_NUMBER

      public static final int DATE_RANGES_FIELD_NUMBER
      See Also:

    • FUNNEL_FIELD_NUMBER

      public static final int FUNNEL_FIELD_NUMBER
      See Also:

    • FUNNEL_BREAKDOWN_FIELD_NUMBER

      public static final int FUNNEL_BREAKDOWN_FIELD_NUMBER
      See Also:

    • FUNNEL_NEXT_ACTION_FIELD_NUMBER

      public static final int FUNNEL_NEXT_ACTION_FIELD_NUMBER
      See Also:

    • FUNNEL_VISUALIZATION_TYPE_FIELD_NUMBER

      public static final int FUNNEL_VISUALIZATION_TYPE_FIELD_NUMBER
      See Also:

    • SEGMENTS_FIELD_NUMBER

      public static final int SEGMENTS_FIELD_NUMBER
      See Also:

    • LIMIT_FIELD_NUMBER

      public static final int LIMIT_FIELD_NUMBER
      See Also:

    • DIMENSION_FILTER_FIELD_NUMBER

      public static final int DIMENSION_FILTER_FIELD_NUMBER
      See Also:

    • RETURN_PROPERTY_QUOTA_FIELD_NUMBER

      public static final int RETURN_PROPERTY_QUOTA_FIELD_NUMBER
      See Also:

  • 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

    • 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.

    • 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

    • 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

    • 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

    • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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

    • 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

    • 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

    • 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

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RunFunnelReportRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunFunnelReportRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunFunnelReportRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunFunnelReportRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static RunFunnelReportRequest.Builder newBuilder()

    • newBuilder

      public static RunFunnelReportRequest.Builder newBuilder(RunFunnelReportRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected RunFunnelReportRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RunFunnelReportRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RunFunnelReportRequest> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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