Package com.google.analytics.data.v1beta

Interface AudienceExportOrBuilder

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

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getAudience

      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];
      Returns:
      The audience.

    • getAudienceBytes

      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];
      Returns:
      The bytes for audience.

    • getAudienceDisplayName

      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];
      Returns:
      The audienceDisplayName.

    • getAudienceDisplayNameBytes

      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];
      Returns:
      The bytes for audienceDisplayName.

    • getDimensionsList

      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];

    • getDimensions

      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];

    • getDimensionsCount

      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];

    • getDimensionsOrBuilderList

      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];

    • getDimensionsOrBuilder

      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];

    • hasState

      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];
      Returns:
      Whether the state field is set.

    • getStateValue

      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];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      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];
      Returns:
      The state.

    • hasBeginCreatingTime

      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];
      Returns:
      Whether the beginCreatingTime field is set.

    • getBeginCreatingTime

      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];
      Returns:
      The beginCreatingTime.

    • getBeginCreatingTimeOrBuilder

      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];

    • getCreationQuotaTokensCharged

      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];
      Returns:
      The creationQuotaTokensCharged.

    • hasRowCount

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

    • getRowCount

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

    • hasErrorMessage

      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];
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      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];
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      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];
      Returns:
      The bytes for errorMessage.

    • hasPercentageCompleted

      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];
      Returns:
      Whether the percentageCompleted field is set.

    • getPercentageCompleted

      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];
      Returns:
      The percentageCompleted.