public interface AudienceListOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAudience()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDimensions(int index)
public abstract 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 |
index | int |
| Returns | |
|---|---|
| Type | Description |
AudienceDimension | |
getDimensionsCount()
public abstract 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 abstract 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 | |
|---|---|
| Type | Description |
List<AudienceDimension> | |
getDimensionsOrBuilder(int index)
public abstract 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 |
index | int |
| Returns | |
|---|---|
| Type | Description |
AudienceDimensionOrBuilder | |
getDimensionsOrBuilderList()
public abstract 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()
public abstract 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 | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract 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. |
getState()
public abstract 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 | |
|---|---|
| Type | Description |
AudienceList.State | The state. |
getStateValue()
public abstract 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 abstract 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 abstract 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. |