- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
public static final class AudienceList.Builder extends GeneratedMessageV3.Builder<AudienceList.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AudienceList.BuilderImplements
AudienceListOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllDimensions(Iterable<? extends AudienceDimension> values)
public AudienceList.Builder addAllDimensions(Iterable<? extends AudienceDimension> values)
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 |
values | Iterable<? extends com.google.analytics.data.v1alpha.AudienceDimension> |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
addDimensions(AudienceDimension value)
public AudienceList.Builder addDimensions(AudienceDimension value)
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 |
value | AudienceDimension |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
addDimensions(AudienceDimension.Builder builderForValue)
public AudienceList.Builder addDimensions(AudienceDimension.Builder builderForValue)
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 |
builderForValue | AudienceDimension.Builder |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
addDimensions(int index, AudienceDimension value)
public AudienceList.Builder addDimensions(int index, AudienceDimension value)
Required. The dimensions requested and displayed in the report response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
value | AudienceDimension |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
addDimensions(int index, AudienceDimension.Builder builderForValue)
public AudienceList.Builder addDimensions(int index, AudienceDimension.Builder builderForValue)
Required. The dimensions requested and displayed in the report response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | AudienceDimension.Builder |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
addDimensionsBuilder()
public AudienceDimension.Builder addDimensionsBuilder()
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 |
AudienceDimension.Builder |
addDimensionsBuilder(int index)
public AudienceDimension.Builder addDimensionsBuilder(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.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AudienceList.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
build()
public AudienceList build()
Returns | |
---|---|
Type | Description |
AudienceList |
buildPartial()
public AudienceList buildPartial()
Returns | |
---|---|
Type | Description |
AudienceList |
clear()
public AudienceList.Builder clear()
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
clearAudience()
public AudienceList.Builder clearAudience()
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 |
AudienceList.Builder | This builder for chaining. |
clearAudienceDisplayName()
public AudienceList.Builder clearAudienceDisplayName()
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 |
AudienceList.Builder | This builder for chaining. |
clearBeginCreatingTime()
public AudienceList.Builder clearBeginCreatingTime()
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 |
AudienceList.Builder |
clearDimensions()
public AudienceList.Builder clearDimensions()
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 |
AudienceList.Builder |
clearField(Descriptors.FieldDescriptor field)
public AudienceList.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
clearName()
public AudienceList.Builder clearName()
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 |
AudienceList.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AudienceList.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
clearState()
public AudienceList.Builder clearState()
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.Builder | This builder for chaining. |
clone()
public AudienceList.Builder clone()
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
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. |
getBeginCreatingTimeBuilder()
public Timestamp.Builder getBeginCreatingTimeBuilder()
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 |
Builder |
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 | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public AudienceList getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AudienceList |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 |
index | int |
Returns | |
---|---|
Type | Description |
AudienceDimension |
getDimensionsBuilder(int index)
public AudienceDimension.Builder getDimensionsBuilder(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.Builder |
getDimensionsBuilderList()
public List<AudienceDimension.Builder> getDimensionsBuilderList()
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<Builder> |
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];
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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. |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeBeginCreatingTime(Timestamp value)
public AudienceList.Builder mergeBeginCreatingTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
mergeFrom(AudienceList other)
public AudienceList.Builder mergeFrom(AudienceList other)
Parameter | |
---|---|
Name | Description |
other | AudienceList |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AudienceList.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public AudienceList.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AudienceList.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
removeDimensions(int index)
public AudienceList.Builder removeDimensions(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 |
AudienceList.Builder |
setAudience(String value)
public AudienceList.Builder setAudience(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The audience to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setAudienceBytes(ByteString value)
public AudienceList.Builder setAudienceBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for audience to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setAudienceDisplayName(String value)
public AudienceList.Builder setAudienceDisplayName(String value)
Output only. The descriptive display name for this audience. For example, "Purchasers".
string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The audienceDisplayName to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setAudienceDisplayNameBytes(ByteString value)
public AudienceList.Builder setAudienceDisplayNameBytes(ByteString value)
Output only. The descriptive display name for this audience. For example, "Purchasers".
string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for audienceDisplayName to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setBeginCreatingTime(Timestamp value)
public AudienceList.Builder setBeginCreatingTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
setBeginCreatingTime(Timestamp.Builder builderForValue)
public AudienceList.Builder setBeginCreatingTime(Timestamp.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
setDimensions(int index, AudienceDimension value)
public AudienceList.Builder setDimensions(int index, AudienceDimension value)
Required. The dimensions requested and displayed in the report response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
value | AudienceDimension |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
setDimensions(int index, AudienceDimension.Builder builderForValue)
public AudienceList.Builder setDimensions(int index, AudienceDimension.Builder builderForValue)
Required. The dimensions requested and displayed in the report response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | AudienceDimension.Builder |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public AudienceList.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
setName(String value)
public AudienceList.Builder setName(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public AudienceList.Builder setNameBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AudienceList.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |
setState(AudienceList.State value)
public AudienceList.Builder setState(AudienceList.State value)
Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | AudienceList.State The state to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setStateValue(int value)
public AudienceList.Builder setStateValue(int value)
Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
AudienceList.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AudienceList.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AudienceList.Builder |