Package com.google.analytics.data.v1beta

Class AudienceExport

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1beta.AudienceExport
All Implemented Interfaces:
AudienceExportOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AudienceExport extends com.google.protobuf.GeneratedMessage implements AudienceExportOrBuilder
 An audience export is a list of users in an audience at the time of the
 list's creation. One audience may have multiple audience exports created for
 different days.
Protobuf type google.analytics.data.v1beta.AudienceExport
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • AUDIENCE_FIELD_NUMBER

      public static final int AUDIENCE_FIELD_NUMBER
      See Also:

    • AUDIENCE_DISPLAY_NAME_FIELD_NUMBER

      public static final int AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DIMENSIONS_FIELD_NUMBER

      public static final int DIMENSIONS_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • BEGIN_CREATING_TIME_FIELD_NUMBER

      public static final int BEGIN_CREATING_TIME_FIELD_NUMBER
      See Also:

    • CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER

      public static final int CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER
      See Also:

    • ROW_COUNT_FIELD_NUMBER

      public static final int ROW_COUNT_FIELD_NUMBER
      See Also:

    • ERROR_MESSAGE_FIELD_NUMBER

      public static final int ERROR_MESSAGE_FIELD_NUMBER
      See Also:

    • PERCENTAGE_COMPLETED_FIELD_NUMBER

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

    • getName

      public String getName()
       Output only. Identifier. The audience export resource name assigned during
 creation. This resource name identifies this `AudienceExport`.

 Format: `properties/{property}/audienceExports/{audience_export}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface AudienceExportOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. The audience export resource name assigned during
 creation. This resource name identifies this `AudienceExport`.

 Format: `properties/{property}/audienceExports/{audience_export}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface AudienceExportOrBuilder
      Returns:
      The bytes for name.

    • getAudience

      public String getAudience()
       Required. The audience resource name. This resource name identifies the
 audience being listed and is shared between the Analytics Data & Admin
 APIs.

 Format: `properties/{property}/audiences/{audience}`
      string audience = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudience in interface AudienceExportOrBuilder
      Returns:
      The audience.

    • getAudienceBytes

      public com.google.protobuf.ByteString getAudienceBytes()
       Required. The audience resource name. This resource name identifies the
 audience being listed and is shared between the Analytics Data & Admin
 APIs.

 Format: `properties/{property}/audiences/{audience}`
      string audience = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceBytes in interface AudienceExportOrBuilder
      Returns:
      The bytes for audience.

    • getAudienceDisplayName

      public String getAudienceDisplayName()
       Output only. The descriptive display name for this audience. For example,
 "Purchasers".
      string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceDisplayName in interface AudienceExportOrBuilder
      Returns:
      The audienceDisplayName.

    • getAudienceDisplayNameBytes

      public com.google.protobuf.ByteString getAudienceDisplayNameBytes()
       Output only. The descriptive display name for this audience. For example,
 "Purchasers".
      string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceDisplayNameBytes in interface AudienceExportOrBuilder
      Returns:
      The bytes for audienceDisplayName.

    • getDimensionsList

      public List<AudienceDimension> getDimensionsList()
       Required. The dimensions requested and displayed in the query response.
      repeated .google.analytics.data.v1beta.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsList in interface AudienceExportOrBuilder

    • getDimensionsOrBuilderList

      public List<? extends AudienceDimensionOrBuilder> getDimensionsOrBuilderList()
       Required. The dimensions requested and displayed in the query response.
      repeated .google.analytics.data.v1beta.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsOrBuilderList in interface AudienceExportOrBuilder

    • getDimensionsCount

      public int getDimensionsCount()
       Required. The dimensions requested and displayed in the query response.
      repeated .google.analytics.data.v1beta.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsCount in interface AudienceExportOrBuilder

    • getDimensions

      public AudienceDimension getDimensions(int index)
       Required. The dimensions requested and displayed in the query response.
      repeated .google.analytics.data.v1beta.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensions in interface AudienceExportOrBuilder

    • getDimensionsOrBuilder

      public AudienceDimensionOrBuilder getDimensionsOrBuilder(int index)
       Required. The dimensions requested and displayed in the query response.
      repeated .google.analytics.data.v1beta.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsOrBuilder in interface AudienceExportOrBuilder

    • hasState

      public boolean hasState()
       Output only. The current state for this AudienceExport.
      optional .google.analytics.data.v1beta.AudienceExport.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasState in interface AudienceExportOrBuilder
      Returns:
      Whether the state field is set.

    • getStateValue

      public int getStateValue()
       Output only. The current state for this AudienceExport.
      optional .google.analytics.data.v1beta.AudienceExport.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface AudienceExportOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public AudienceExport.State getState()
       Output only. The current state for this AudienceExport.
      optional .google.analytics.data.v1beta.AudienceExport.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface AudienceExportOrBuilder
      Returns:
      The state.

    • hasBeginCreatingTime

      public boolean hasBeginCreatingTime()
       Output only. The time when CreateAudienceExport was called and the
 AudienceExport began the `CREATING` state.
      optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasBeginCreatingTime in interface AudienceExportOrBuilder
      Returns:
      Whether the beginCreatingTime field is set.

    • getBeginCreatingTime

      public com.google.protobuf.Timestamp getBeginCreatingTime()
       Output only. The time when CreateAudienceExport was called and the
 AudienceExport began the `CREATING` state.
      optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBeginCreatingTime in interface AudienceExportOrBuilder
      Returns:
      The beginCreatingTime.

    • getBeginCreatingTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getBeginCreatingTimeOrBuilder()
       Output only. The time when CreateAudienceExport was called and the
 AudienceExport began the `CREATING` state.
      optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBeginCreatingTimeOrBuilder in interface AudienceExportOrBuilder

    • getCreationQuotaTokensCharged

      public int getCreationQuotaTokensCharged()
       Output only. The total quota tokens charged during creation of the
 AudienceExport. Because this token count is based on activity from the
 `CREATING` state, this tokens charged will be fixed once an AudienceExport
 enters the `ACTIVE` or `FAILED` states.
      int32 creation_quota_tokens_charged = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreationQuotaTokensCharged in interface AudienceExportOrBuilder
      Returns:
      The creationQuotaTokensCharged.

    • hasRowCount

      public boolean hasRowCount()
       Output only. The total number of rows in the AudienceExport result.
      optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRowCount in interface AudienceExportOrBuilder
      Returns:
      Whether the rowCount field is set.

    • getRowCount

      public int getRowCount()
       Output only. The total number of rows in the AudienceExport result.
      optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRowCount in interface AudienceExportOrBuilder
      Returns:
      The rowCount.

    • hasErrorMessage

      public boolean hasErrorMessage()
       Output only. Error message is populated when an audience export fails
 during creation. A common reason for such a failure is quota exhaustion.
      optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasErrorMessage in interface AudienceExportOrBuilder
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      public String getErrorMessage()
       Output only. Error message is populated when an audience export fails
 during creation. A common reason for such a failure is quota exhaustion.
      optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getErrorMessage in interface AudienceExportOrBuilder
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      public com.google.protobuf.ByteString getErrorMessageBytes()
       Output only. Error message is populated when an audience export fails
 during creation. A common reason for such a failure is quota exhaustion.
      optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getErrorMessageBytes in interface AudienceExportOrBuilder
      Returns:
      The bytes for errorMessage.

    • hasPercentageCompleted

      public boolean hasPercentageCompleted()
       Output only. The percentage completed for this audience export ranging
 between 0 to 100.
      optional double percentage_completed = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasPercentageCompleted in interface AudienceExportOrBuilder
      Returns:
      Whether the percentageCompleted field is set.

    • getPercentageCompleted

      public double getPercentageCompleted()
       Output only. The percentage completed for this audience export ranging
 between 0 to 100.
      optional double percentage_completed = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPercentageCompleted in interface AudienceExportOrBuilder
      Returns:
      The percentageCompleted.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AudienceExport.Builder newBuilder()

    • newBuilder

      public static AudienceExport.Builder newBuilder(AudienceExport prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AudienceExport getDefaultInstance()

    • parser

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

    • getParserForType

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