com.google.analytics.data.v1alpha

Interface AudienceListOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AudienceList, AudienceList.Builder

public interface AudienceListOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
AudienceDimension	getDimensions(int index) Required.
int	getDimensionsCount() Required.
List<AudienceDimension>	getDimensionsList() Required.
AudienceDimensionOrBuilder	getDimensionsOrBuilder(int index) Required.
List<? extends AudienceDimensionOrBuilder>	getDimensionsOrBuilderList() Required.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
AudienceList.State	getState() Output only.
int	getStateValue() Output only.
boolean	hasBeginCreatingTime() Output only.
boolean	hasState() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getAudience

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:

The audience.

getAudienceBytes

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

string audience = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for audience.

getAudienceDisplayName

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:

The audienceDisplayName.

getAudienceDisplayNameBytes

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

Returns:

The bytes for audienceDisplayName.

getDimensionsList

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

getDimensions

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

getDimensionsCount

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

getDimensionsOrBuilderList

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

getDimensionsOrBuilder

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

hasState

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:

Whether the state field is set.

getStateValue

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:

The enum numeric value on the wire for state.

getState

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:

The state.

hasBeginCreatingTime

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:

Whether the beginCreatingTime field is set.

getBeginCreatingTime

com.google.protobuf.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:

The beginCreatingTime.

getBeginCreatingTimeOrBuilder

com.google.protobuf.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];