Class AudienceExport (0.47.0)

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

Static Fields

AUDIENCE_DISPLAY_NAME_FIELD_NUMBER

public static final int AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER
Field Value
TypeDescription
int

BEGIN_CREATING_TIME_FIELD_NUMBER

public static final int BEGIN_CREATING_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER

public static final int CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PERCENTAGE_COMPLETED_FIELD_NUMBER

public static final int PERCENTAGE_COMPLETED_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AudienceExport getDefaultInstance()
Returns
TypeDescription
AudienceExport

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AudienceExport.Builder newBuilder()
Returns
TypeDescription
AudienceExport.Builder

newBuilder(AudienceExport prototype)

public static AudienceExport.Builder newBuilder(AudienceExport prototype)
Parameter
NameDescription
prototypeAudienceExport
Returns
TypeDescription
AudienceExport.Builder

parseDelimitedFrom(InputStream input)

public static AudienceExport parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceExport parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AudienceExport parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AudienceExport parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AudienceExport parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AudienceExport parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AudienceExport parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceExport parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AudienceExport parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceExport parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AudienceExport parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AudienceExport parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudienceExport
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AudienceExport> parser()
Returns
TypeDescription
Parser<AudienceExport>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for audienceDisplayName.

getBeginCreatingTime()

public 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
TypeDescription
Timestamp

The beginCreatingTime.

getBeginCreatingTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

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

Returns
TypeDescription
int

The creationQuotaTokensCharged.

getDefaultInstanceForType()

public AudienceExport getDefaultInstanceForType()
Returns
TypeDescription
AudienceExport

getDimensions(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AudienceDimension

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

Returns
TypeDescription
int

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

Returns
TypeDescription
List<AudienceDimension>

getDimensionsOrBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AudienceDimensionOrBuilder

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

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.AudienceDimensionOrBuilder>

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

Returns
TypeDescription
String

The errorMessage.

getErrorMessageBytes()

public 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
TypeDescription
ByteString

The bytes for errorMessage.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<AudienceExport> getParserForType()
Returns
TypeDescription
Parser<AudienceExport>
Overrides

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

Returns
TypeDescription
double

The percentageCompleted.

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

Returns
TypeDescription
int

The rowCount.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

Returns
TypeDescription
AudienceExport.State

The state.

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

Returns
TypeDescription
int

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

Returns
TypeDescription
boolean

Whether the beginCreatingTime field is set.

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

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

Returns
TypeDescription
boolean

Whether the percentageCompleted field is set.

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

Returns
TypeDescription
boolean

Whether the rowCount field is set.

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

Returns
TypeDescription
boolean

Whether the state field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AudienceExport.Builder newBuilderForType()
Returns
TypeDescription
AudienceExport.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AudienceExport.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AudienceExport.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AudienceExport.Builder toBuilder()
Returns
TypeDescription
AudienceExport.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException