com.google.analytics.data.v1alpha

Interface AudienceListOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AudienceList, AudienceList.Builder

public interface AudienceListOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAudience() Required.
com.google.protobuf.ByteString	getAudienceBytes() Required.
String	getAudienceDisplayName() Output only.
com.google.protobuf.ByteString	getAudienceDisplayNameBytes() Output only.
com.google.protobuf.Timestamp	getBeginCreatingTime() Output only.
com.google.protobuf.TimestampOrBuilder	getBeginCreatingTimeOrBuilder() Output only.
int	getCreationQuotaTokensCharged() Output only.
AudienceDimension	getDimensions(int index) Required.
int	getDimensionsCount() Required.
List<AudienceDimension>	getDimensionsList() Required.
AudienceDimensionOrBuilder	getDimensionsOrBuilder(int index) Required.
List<? extends AudienceDimensionOrBuilder>	getDimensionsOrBuilderList() Required.
String	getErrorMessage() Output only.
com.google.protobuf.ByteString	getErrorMessageBytes() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
double	getPercentageCompleted() Output only.
String	getRecurringAudienceList() Output only.
com.google.protobuf.ByteString	getRecurringAudienceListBytes() Output only.
int	getRowCount() Output only.
AudienceList.State	getState() Output only.
int	getStateValue() Output only.
boolean	hasBeginCreatingTime() Output only.
boolean	hasErrorMessage() Output only.
boolean	hasPercentageCompleted() Output only.
boolean	hasRecurringAudienceList() Output only.
boolean	hasRowCount() Output only.
boolean	hasState() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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

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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

hasState

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:

Whether the state field is set.

getStateValue

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:

The enum numeric value on the wire for state.

getState

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:

The state.

hasBeginCreatingTime

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:

Whether the beginCreatingTime field is set.

getBeginCreatingTime

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

Returns:

The beginCreatingTime.

getBeginCreatingTimeOrBuilder

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

getCreationQuotaTokensCharged

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:

The creationQuotaTokensCharged.

hasRowCount

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:

Whether the rowCount field is set.

getRowCount

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:

The rowCount.

hasErrorMessage

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:

Whether the errorMessage field is set.

getErrorMessage

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:

The errorMessage.

getErrorMessageBytes

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

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 = 11 [(.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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The percentageCompleted.

hasRecurringAudienceList

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:

Whether the recurringAudienceList field is set.

getRecurringAudienceList

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:

The recurringAudienceList.

getRecurringAudienceListBytes

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

Returns:

The bytes for recurringAudienceList.