public final class AudienceExport extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
AudienceExport.Builder
An audience export is a list of users in an audience at the time of the
list's creation.
|
static class |
AudienceExport.State
The AudienceExport currently exists in this state.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
AUDIENCE_DISPLAY_NAME_FIELD_NUMBER |
static int |
AUDIENCE_FIELD_NUMBER |
static int |
BEGIN_CREATING_TIME_FIELD_NUMBER |
static int |
CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER |
static int |
DIMENSIONS_FIELD_NUMBER |
static int |
ERROR_MESSAGE_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PERCENTAGE_COMPLETED_FIELD_NUMBER |
static int |
ROW_COUNT_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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.
|
static AudienceExport |
getDefaultInstance() |
AudienceExport |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<AudienceExport> |
getParserForType() |
double |
getPercentageCompleted()
Output only.
|
int |
getRowCount()
Output only.
|
int |
getSerializedSize() |
AudienceExport.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
boolean |
hasBeginCreatingTime()
Output only.
|
boolean |
hasErrorMessage()
Output only.
|
int |
hashCode() |
boolean |
hasPercentageCompleted()
Output only.
|
boolean |
hasRowCount()
Output only.
|
boolean |
hasState()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static AudienceExport.Builder |
newBuilder() |
static AudienceExport.Builder |
newBuilder(AudienceExport prototype) |
AudienceExport.Builder |
newBuilderForType() |
protected AudienceExport.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static AudienceExport |
parseDelimitedFrom(InputStream input) |
static AudienceExport |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AudienceExport |
parseFrom(byte[] data) |
static AudienceExport |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AudienceExport |
parseFrom(ByteBuffer data) |
static AudienceExport |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AudienceExport |
parseFrom(com.google.protobuf.ByteString data) |
static AudienceExport |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AudienceExport |
parseFrom(com.google.protobuf.CodedInputStream input) |
static AudienceExport |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AudienceExport |
parseFrom(InputStream input) |
static AudienceExport |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<AudienceExport> |
parser() |
AudienceExport.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int AUDIENCE_FIELD_NUMBER
public static final int AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int BEGIN_CREATING_TIME_FIELD_NUMBER
public static final int CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER
public static final int ROW_COUNT_FIELD_NUMBER
public static final int ERROR_MESSAGE_FIELD_NUMBER
public static final int PERCENTAGE_COMPLETED_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];
getName in interface AudienceExportOrBuilderpublic com.google.protobuf.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];
getNameBytes in interface AudienceExportOrBuilderpublic 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];getAudience in interface AudienceExportOrBuilderpublic 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];getAudienceBytes in interface AudienceExportOrBuilderpublic 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];getAudienceDisplayName in interface AudienceExportOrBuilderpublic 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];getAudienceDisplayNameBytes in interface AudienceExportOrBuilderpublic 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];
getDimensionsList in interface AudienceExportOrBuilderpublic 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];
getDimensionsOrBuilderList in interface AudienceExportOrBuilderpublic 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];
getDimensionsCount in interface AudienceExportOrBuilderpublic 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];
getDimensions in interface AudienceExportOrBuilderpublic 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];
getDimensionsOrBuilder in interface AudienceExportOrBuilderpublic 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];
hasState in interface AudienceExportOrBuilderpublic 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];
getStateValue in interface AudienceExportOrBuilderpublic 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];
getState in interface AudienceExportOrBuilderpublic 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];
hasBeginCreatingTime in interface AudienceExportOrBuilderpublic com.google.protobuf.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];
getBeginCreatingTime in interface AudienceExportOrBuilderpublic com.google.protobuf.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];
getBeginCreatingTimeOrBuilder in interface AudienceExportOrBuilderpublic 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];
getCreationQuotaTokensCharged in interface AudienceExportOrBuilderpublic boolean hasRowCount()
Output only. The total number of rows in the AudienceExport result.
optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];hasRowCount in interface AudienceExportOrBuilderpublic int getRowCount()
Output only. The total number of rows in the AudienceExport result.
optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];getRowCount in interface AudienceExportOrBuilderpublic 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];hasErrorMessage in interface AudienceExportOrBuilderpublic 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];getErrorMessage in interface AudienceExportOrBuilderpublic com.google.protobuf.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];getErrorMessageBytes in interface AudienceExportOrBuilderpublic 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];
hasPercentageCompleted in interface AudienceExportOrBuilderpublic 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];
getPercentageCompleted in interface AudienceExportOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static AudienceExport parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AudienceExport parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AudienceExport parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AudienceExport parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AudienceExport parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AudienceExport parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AudienceExport parseFrom(InputStream input) throws IOException
IOExceptionpublic static AudienceExport parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AudienceExport parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static AudienceExport parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AudienceExport parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static AudienceExport parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic AudienceExport.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static AudienceExport.Builder newBuilder()
public static AudienceExport.Builder newBuilder(AudienceExport prototype)
public AudienceExport.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected AudienceExport.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static AudienceExport getDefaultInstance()
public static com.google.protobuf.Parser<AudienceExport> parser()
public com.google.protobuf.Parser<AudienceExport> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public AudienceExport getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.