Class AudienceList (0.35.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 0.35.0keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_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 AudienceList getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static AudienceList . Builder newBuilder ()
newBuilder(AudienceList prototype)
public static AudienceList . Builder newBuilder ( AudienceList prototype )
public static AudienceList parseDelimitedFrom ( InputStream input )
public static AudienceList parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static AudienceList parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AudienceList parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static AudienceList parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AudienceList parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static AudienceList parseFrom ( CodedInputStream input )
public static AudienceList parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static AudienceList parseFrom ( InputStream input )
public static AudienceList parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static AudienceList parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AudienceList parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<AudienceList> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
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/{propertyId}/audiences/{audienceId}
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 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
Type Description
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];
getDefaultInstanceForType()
public AudienceList getDefaultInstanceForType ()
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
Name Description
indexint
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
Type Description
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];
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
Name Description
indexint
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
Type Description
List <? extends com.google.analytics.data.v1alpha.AudienceDimensionOrBuilder >
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
Type Description
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
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<AudienceList> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
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];
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
Type Description
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
Type Description
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
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 AudienceList . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AudienceList . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public AudienceList . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,[]]
