Class AudienceList (0.32.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
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

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_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 AudienceList getDefaultInstance()
Returns
TypeDescription
AudienceList

getDescriptor()

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

newBuilder()

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

newBuilder(AudienceList prototype)

public static AudienceList.Builder newBuilder(AudienceList prototype)
Parameter
NameDescription
prototypeAudienceList
Returns
TypeDescription
AudienceList.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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/{propertyId}/audiences/{audienceId}

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/{propertyId}/audiences/{audienceId}

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 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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public AudienceList getDefaultInstanceForType()
Returns
TypeDescription
AudienceList

getDimensions(int index)

public AudienceDimension getDimensions(int index)

Required. The dimensions requested and displayed in the report response.

repeated .google.analytics.data.v1alpha.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 report response.

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getDimensionsList()

public List<AudienceDimension> getDimensionsList()

Required. The dimensions requested and displayed in the report response.

repeated .google.analytics.data.v1alpha.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 report response.

repeated .google.analytics.data.v1alpha.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 report response.

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

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

getName()

public String getName()

Output only. The audience list resource name assigned during creation. This resource name identifies this AudienceList.

Format: properties/{propertyId}/audienceLists/{audienceListId}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The audience list resource name assigned during creation. This resource name identifies this AudienceList.

Format: properties/{propertyId}/audienceLists/{audienceListId}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for state.

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
TypeDescription
boolean

Whether the beginCreatingTime 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
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 AudienceList.Builder newBuilderForType()
Returns
TypeDescription
AudienceList.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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