Package com.google.analytics.data.v1beta

Class CohortSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1beta.CohortSpec
All Implemented Interfaces:
CohortSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CohortSpec extends com.google.protobuf.GeneratedMessage implements CohortSpecOrBuilder
 The specification of cohorts for a cohort report.

 Cohort reports create a time series of user retention for the cohort. For
 example, you could select the cohort of users that were acquired in the first
 week of September and follow that cohort for the next six weeks. Selecting
 the users acquired in the first week of September cohort is specified in the
 `cohort` object. Following that cohort for the next six weeks is specified in
 the `cohortsRange` object.

 For examples, see [Cohort Report
 Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples).

 The report response could show a weekly time series where say your app has
 retained 60% of this cohort after three weeks and 25% of this cohort after
 six weeks. These two percentages can be calculated by the metric
 `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.
Protobuf type google.analytics.data.v1beta.CohortSpec
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CohortSpec.Builder
    The specification of cohorts for a cohort report.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COHORT_REPORT_SETTINGS_FIELD_NUMBER
     
    static final int
    COHORTS_FIELD_NUMBER
     
    static final int
    COHORTS_RANGE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    CohortReportSettings
    getCohortReportSettings()
    Optional settings for a cohort report.
    CohortReportSettingsOrBuilder
    getCohortReportSettingsOrBuilder()
    Optional settings for a cohort report.
    Cohort
    getCohorts(int index)
    Defines the selection criteria to group users into cohorts.
    int
    getCohortsCount()
    Defines the selection criteria to group users into cohorts.
    List<Cohort>
    getCohortsList()
    Defines the selection criteria to group users into cohorts.
    CohortOrBuilder
    getCohortsOrBuilder(int index)
    Defines the selection criteria to group users into cohorts.
    List<? extends CohortOrBuilder>
    getCohortsOrBuilderList()
    Defines the selection criteria to group users into cohorts.
    CohortsRange
    getCohortsRange()
    Cohort reports follow cohorts over an extended reporting date range.
    CohortsRangeOrBuilder
    getCohortsRangeOrBuilder()
    Cohort reports follow cohorts over an extended reporting date range.
    static CohortSpec
    getDefaultInstance()
     
    CohortSpec
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<CohortSpec>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasCohortReportSettings()
    Optional settings for a cohort report.
    boolean
    hasCohortsRange()
    Cohort reports follow cohorts over an extended reporting date range.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CohortSpec.Builder
    newBuilder()
     
    static CohortSpec.Builder
    newBuilder(CohortSpec prototype)
     
    CohortSpec.Builder
    newBuilderForType()
     
    protected CohortSpec.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CohortSpec
    parseDelimitedFrom(InputStream input)
     
    static CohortSpec
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CohortSpec
    parseFrom(byte[] data)
     
    static CohortSpec
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CohortSpec
    parseFrom(com.google.protobuf.ByteString data)
     
    static CohortSpec
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CohortSpec
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CohortSpec
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CohortSpec
    parseFrom(InputStream input)
     
    static CohortSpec
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CohortSpec
    parseFrom(ByteBuffer data)
     
    static CohortSpec
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CohortSpec>
    parser()
     
    CohortSpec.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • COHORTS_FIELD_NUMBER

      public static final int COHORTS_FIELD_NUMBER
      See Also:

    • COHORTS_RANGE_FIELD_NUMBER

      public static final int COHORTS_RANGE_FIELD_NUMBER
      See Also:

    • COHORT_REPORT_SETTINGS_FIELD_NUMBER

      public static final int COHORT_REPORT_SETTINGS_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

    • getCohortsList

      public List<Cohort> getCohortsList()
       Defines the selection criteria to group users into cohorts.

 Most cohort reports define only a single cohort. If multiple cohorts are
 specified, each cohort can be recognized in the report by their name.
      repeated .google.analytics.data.v1beta.Cohort cohorts = 1;
      Specified by:
      getCohortsList in interface CohortSpecOrBuilder

    • getCohortsOrBuilderList

      public List<? extends CohortOrBuilder> getCohortsOrBuilderList()
       Defines the selection criteria to group users into cohorts.

 Most cohort reports define only a single cohort. If multiple cohorts are
 specified, each cohort can be recognized in the report by their name.
      repeated .google.analytics.data.v1beta.Cohort cohorts = 1;
      Specified by:
      getCohortsOrBuilderList in interface CohortSpecOrBuilder

    • getCohortsCount

      public int getCohortsCount()
       Defines the selection criteria to group users into cohorts.

 Most cohort reports define only a single cohort. If multiple cohorts are
 specified, each cohort can be recognized in the report by their name.
      repeated .google.analytics.data.v1beta.Cohort cohorts = 1;
      Specified by:
      getCohortsCount in interface CohortSpecOrBuilder

    • getCohorts

      public Cohort getCohorts(int index)
       Defines the selection criteria to group users into cohorts.

 Most cohort reports define only a single cohort. If multiple cohorts are
 specified, each cohort can be recognized in the report by their name.
      repeated .google.analytics.data.v1beta.Cohort cohorts = 1;
      Specified by:
      getCohorts in interface CohortSpecOrBuilder

    • getCohortsOrBuilder

      public CohortOrBuilder getCohortsOrBuilder(int index)
       Defines the selection criteria to group users into cohorts.

 Most cohort reports define only a single cohort. If multiple cohorts are
 specified, each cohort can be recognized in the report by their name.
      repeated .google.analytics.data.v1beta.Cohort cohorts = 1;
      Specified by:
      getCohortsOrBuilder in interface CohortSpecOrBuilder

    • hasCohortsRange

      public boolean hasCohortsRange()
       Cohort reports follow cohorts over an extended reporting date range. This
 range specifies an offset duration to follow the cohorts over.
      .google.analytics.data.v1beta.CohortsRange cohorts_range = 2;
      Specified by:
      hasCohortsRange in interface CohortSpecOrBuilder
      Returns:
      Whether the cohortsRange field is set.

    • getCohortsRange

      public CohortsRange getCohortsRange()
       Cohort reports follow cohorts over an extended reporting date range. This
 range specifies an offset duration to follow the cohorts over.
      .google.analytics.data.v1beta.CohortsRange cohorts_range = 2;
      Specified by:
      getCohortsRange in interface CohortSpecOrBuilder
      Returns:
      The cohortsRange.

    • getCohortsRangeOrBuilder

      public CohortsRangeOrBuilder getCohortsRangeOrBuilder()
       Cohort reports follow cohorts over an extended reporting date range. This
 range specifies an offset duration to follow the cohorts over.
      .google.analytics.data.v1beta.CohortsRange cohorts_range = 2;
      Specified by:
      getCohortsRangeOrBuilder in interface CohortSpecOrBuilder

    • hasCohortReportSettings

      public boolean hasCohortReportSettings()
       Optional settings for a cohort report.
      .google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;
      Specified by:
      hasCohortReportSettings in interface CohortSpecOrBuilder
      Returns:
      Whether the cohortReportSettings field is set.

    • getCohortReportSettings

      public CohortReportSettings getCohortReportSettings()
       Optional settings for a cohort report.
      .google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;
      Specified by:
      getCohortReportSettings in interface CohortSpecOrBuilder
      Returns:
      The cohortReportSettings.

    • getCohortReportSettingsOrBuilder

      public CohortReportSettingsOrBuilder getCohortReportSettingsOrBuilder()
       Optional settings for a cohort report.
      .google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;
      Specified by:
      getCohortReportSettingsOrBuilder in interface CohortSpecOrBuilder

    • 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 CohortSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CohortSpec.Builder newBuilder()

    • newBuilder

      public static CohortSpec.Builder newBuilder(CohortSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CohortSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CohortSpec> 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 CohortSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder