Package com.google.analytics.data.v1alpha

Class AudienceList

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1alpha.AudienceList
All Implemented Interfaces:
AudienceListOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AudienceList extends com.google.protobuf.GeneratedMessage implements AudienceListOrBuilder
 An audience list is a list of users in an audience at the time of the list's
 creation. One audience may have multiple audience lists created for different
 days.
Protobuf type google.analytics.data.v1alpha.AudienceList
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:

    • RECURRING_AUDIENCE_LIST_FIELD_NUMBER

      public static final int RECURRING_AUDIENCE_LIST_FIELD_NUMBER
      See Also:

    • WEBHOOK_NOTIFICATION_FIELD_NUMBER

      public static final int WEBHOOK_NOTIFICATION_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 list resource name assigned during
 creation. This resource name identifies this `AudienceList`.

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

    • getNameBytes

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

 Format: `properties/{property}/audienceLists/{audience_list}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface AudienceListOrBuilder
      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 AudienceListOrBuilder
      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 AudienceListOrBuilder
      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 AudienceListOrBuilder
      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 AudienceListOrBuilder
      Returns:
      The bytes for audienceDisplayName.

    • getDimensionsList

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

    • getDimensionsOrBuilderList

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

    • getDimensionsCount

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

    • getDimensions

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

    • getDimensionsOrBuilder

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

    • hasState

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

    • getStateValue

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

    • getState

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

    • hasBeginCreatingTime

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

    • getBeginCreatingTime

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

    • getBeginCreatingTimeOrBuilder

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

    • getCreationQuotaTokensCharged

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

    • hasRowCount

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

    • getRowCount

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

    • hasErrorMessage

      public boolean hasErrorMessage()
       Output only. Error message is populated when an audience list 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 AudienceListOrBuilder
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      public String getErrorMessage()
       Output only. Error message is populated when an audience list 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 AudienceListOrBuilder
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      public com.google.protobuf.ByteString getErrorMessageBytes()
       Output only. Error message is populated when an audience list 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 AudienceListOrBuilder
      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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasPercentageCompleted in interface AudienceListOrBuilder
      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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPercentageCompleted in interface AudienceListOrBuilder
      Returns:
      The percentageCompleted.

    • hasRecurringAudienceList

      public boolean hasRecurringAudienceList()
       Output only. The recurring audience list that created this audience list.
 Recurring audience lists create audience lists daily.

 If audience lists are created directly, they will have no associated
 recurring audience list, and this field will be blank.
      optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRecurringAudienceList in interface AudienceListOrBuilder
      Returns:
      Whether the recurringAudienceList field is set.

    • getRecurringAudienceList

      public String getRecurringAudienceList()
       Output only. The recurring audience list that created this audience list.
 Recurring audience lists create audience lists daily.

 If audience lists are created directly, they will have no associated
 recurring audience list, and this field will be blank.
      optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRecurringAudienceList in interface AudienceListOrBuilder
      Returns:
      The recurringAudienceList.

    • getRecurringAudienceListBytes

      public com.google.protobuf.ByteString getRecurringAudienceListBytes()
       Output only. The recurring audience list that created this audience list.
 Recurring audience lists create audience lists daily.

 If audience lists are created directly, they will have no associated
 recurring audience list, and this field will be blank.
      optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRecurringAudienceListBytes in interface AudienceListOrBuilder
      Returns:
      The bytes for recurringAudienceList.

    • hasWebhookNotification

      public boolean hasWebhookNotification()
       Optional. Configures webhook notifications to be sent from the Google
 Analytics Data API to your webhook server. Use of webhooks is optional. If
 unused, you'll need to poll this API to determine when an audience list is
 ready to be used. Webhooks allow a notification to be sent to your servers
 & avoid the need for polling.

 Either one or two POST requests will be sent to the webhook. The first POST
 request will be sent immediately showing the newly created audience list in
 its CREATING state. The second POST request will be sent after the audience
 list completes creation (either the ACTIVE or FAILED state).

 If identical audience lists are requested in quick succession, the second &
 subsequent audience lists can be served from cache. In that case, the
 audience list create method can return an audience list is already ACTIVE.
 In this scenario, only one POST request will be sent to the webhook.
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasWebhookNotification in interface AudienceListOrBuilder
      Returns:
      Whether the webhookNotification field is set.

    • getWebhookNotification

      public WebhookNotification getWebhookNotification()
       Optional. Configures webhook notifications to be sent from the Google
 Analytics Data API to your webhook server. Use of webhooks is optional. If
 unused, you'll need to poll this API to determine when an audience list is
 ready to be used. Webhooks allow a notification to be sent to your servers
 & avoid the need for polling.

 Either one or two POST requests will be sent to the webhook. The first POST
 request will be sent immediately showing the newly created audience list in
 its CREATING state. The second POST request will be sent after the audience
 list completes creation (either the ACTIVE or FAILED state).

 If identical audience lists are requested in quick succession, the second &
 subsequent audience lists can be served from cache. In that case, the
 audience list create method can return an audience list is already ACTIVE.
 In this scenario, only one POST request will be sent to the webhook.
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebhookNotification in interface AudienceListOrBuilder
      Returns:
      The webhookNotification.

    • getWebhookNotificationOrBuilder

      public WebhookNotificationOrBuilder getWebhookNotificationOrBuilder()
       Optional. Configures webhook notifications to be sent from the Google
 Analytics Data API to your webhook server. Use of webhooks is optional. If
 unused, you'll need to poll this API to determine when an audience list is
 ready to be used. Webhooks allow a notification to be sent to your servers
 & avoid the need for polling.

 Either one or two POST requests will be sent to the webhook. The first POST
 request will be sent immediately showing the newly created audience list in
 its CREATING state. The second POST request will be sent after the audience
 list completes creation (either the ACTIVE or FAILED state).

 If identical audience lists are requested in quick succession, the second &
 subsequent audience lists can be served from cache. In that case, the
 audience list create method can return an audience list is already ACTIVE.
 In this scenario, only one POST request will be sent to the webhook.
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebhookNotificationOrBuilder in interface AudienceListOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AudienceList.Builder newBuilder()

    • newBuilder

      public static AudienceList.Builder newBuilder(AudienceList prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AudienceList getDefaultInstance()

    • parser

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

    • getParserForType

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