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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 |
|
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 |
|
Static Methods
getDefaultInstance()
public static AudienceExport getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AudienceExport.Builder newBuilder()
newBuilder(AudienceExport prototype)
public static AudienceExport.Builder newBuilder(AudienceExport prototype)
public static AudienceExport parseDelimitedFrom(InputStream input)
public static AudienceExport parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AudienceExport parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AudienceExport parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AudienceExport parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AudienceExport parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AudienceExport parseFrom(CodedInputStream input)
public static AudienceExport parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AudienceExport parseFrom(InputStream input)
public static AudienceExport parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AudienceExport parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AudienceExport parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AudienceExport> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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 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 |
| Type |
Description |
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];
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 |
| Type |
Description |
int |
The creationQuotaTokensCharged.
|
getDefaultInstanceForType()
public AudienceExport getDefaultInstanceForType()
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
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];
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for errorMessage.
|
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<AudienceExport> getParserForType()
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 |
| Type |
Description |
double |
The percentageCompleted.
|
getRowCount()
Output only. The total number of rows in the AudienceExport 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 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];
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 |
| Type |
Description |
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 |
| Type |
Description |
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 |
| 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 = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
boolean |
Whether the state field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AudienceExport.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AudienceExport.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AudienceExport.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
