Class AudienceList (0.55.0)

public final class AudienceList extends GeneratedMessageV3 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

Static Fields

AUDIENCE_DISPLAY_NAME_FIELD_NUMBER

public static final int AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER
Field Value
Type Description
int

BEGIN_CREATING_TIME_FIELD_NUMBER

public static final int BEGIN_CREATING_TIME_FIELD_NUMBER
Field Value
Type Description
int

CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER

public static final int CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER
Field Value
Type Description
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PERCENTAGE_COMPLETED_FIELD_NUMBER

public static final int PERCENTAGE_COMPLETED_FIELD_NUMBER
Field Value
Type Description
int

RECURRING_AUDIENCE_LIST_FIELD_NUMBER

public static final int RECURRING_AUDIENCE_LIST_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

WEBHOOK_NOTIFICATION_FIELD_NUMBER

public static final int WEBHOOK_NOTIFICATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AudienceList getDefaultInstance()
Returns
Type Description
AudienceList

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AudienceList.Builder newBuilder()
Returns
Type Description
AudienceList.Builder

newBuilder(AudienceList prototype)

public static AudienceList.Builder newBuilder(AudienceList prototype)
Parameter
Name Description
prototype AudienceList
Returns
Type Description
AudienceList.Builder

parseDelimitedFrom(InputStream input)

public static AudienceList parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudienceList
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceList parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceList
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AudienceList parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AudienceList
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AudienceList parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceList
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AudienceList parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AudienceList
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AudienceList parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceList
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AudienceList parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AudienceList
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceList parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceList
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AudienceList parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudienceList
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceList parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceList
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AudienceList parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AudienceList
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AudienceList parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceList
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AudienceList> parser()
Returns
Type Description
Parser<AudienceList>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
String

The audience.

getAudienceBytes()

public 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
Type Description
ByteString

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

Returns
Type Description
String

The audienceDisplayName.

getAudienceDisplayNameBytes()

public 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
Type Description
ByteString

The bytes for audienceDisplayName.

getBeginCreatingTime()

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

Returns
Type Description
Timestamp

The beginCreatingTime.

getBeginCreatingTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

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

Returns
Type Description
int

The creationQuotaTokensCharged.

getDefaultInstanceForType()

public AudienceList getDefaultInstanceForType()
Returns
Type Description
AudienceList

getDimensions(int index)

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

Parameter
Name Description
index int
Returns
Type Description
AudienceDimension

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

Returns
Type Description
int

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

Returns
Type Description
List<AudienceDimension>

getDimensionsOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
AudienceDimensionOrBuilder

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

Returns
Type Description
List<? extends com.google.analytics.data.v1alpha.AudienceDimensionOrBuilder>

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

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

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

Returns
Type Description
ByteString

The bytes for errorMessage.

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

Returns
Type Description
String

The name.

getNameBytes()

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<AudienceList> getParserForType()
Returns
Type Description
Parser<AudienceList>
Overrides

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

Returns
Type Description
double

The percentageCompleted.

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

Returns
Type Description
String

The recurringAudienceList.

getRecurringAudienceListBytes()

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

Returns
Type Description
ByteString

The bytes for recurringAudienceList.

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

Returns
Type Description
int

The rowCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Returns
Type Description
AudienceList.State

The state.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

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

Returns
Type Description
WebhookNotification

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

Returns
Type Description
WebhookNotificationOrBuilder

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

Returns
Type Description
boolean

Whether the beginCreatingTime field is set.

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

Returns
Type Description
boolean

Whether the errorMessage field is set.

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

Returns
Type Description
boolean

Whether the percentageCompleted field is set.

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

Returns
Type Description
boolean

Whether the recurringAudienceList field is set.

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

Returns
Type Description
boolean

Whether the rowCount field is set.

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

Returns
Type Description
boolean

Whether the state field is set.

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

Returns
Type Description
boolean

Whether the webhookNotification field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AudienceList.Builder newBuilderForType()
Returns
Type Description
AudienceList.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AudienceList.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AudienceList.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AudienceList.Builder toBuilder()
Returns
Type Description
AudienceList.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException