Class UserDimensions.Builder (0.15.0)

public static final class UserDimensions.Builder extends GeneratedMessageV3.Builder<UserDimensions.Builder> implements UserDimensionsOrBuilder

Message containing information about the user associated with the event.

Protobuf type google.events.firebase.analytics.v1.UserDimensions

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UserDimensions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UserDimensions.Builder
Overrides

build()

public UserDimensions build()
Returns
Type Description
UserDimensions

buildPartial()

public UserDimensions buildPartial()
Returns
Type Description
UserDimensions

clear()

public UserDimensions.Builder clear()
Returns
Type Description
UserDimensions.Builder
Overrides

clearAppInfo()

public UserDimensions.Builder clearAppInfo()

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Returns
Type Description
UserDimensions.Builder

clearBundleInfo()

public UserDimensions.Builder clearBundleInfo()

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Returns
Type Description
UserDimensions.Builder

clearDeviceInfo()

public UserDimensions.Builder clearDeviceInfo()

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Returns
Type Description
UserDimensions.Builder

clearField(Descriptors.FieldDescriptor field)

public UserDimensions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UserDimensions.Builder
Overrides

clearFirstOpenTimestampMicros()

public UserDimensions.Builder clearFirstOpenTimestampMicros()

The time (in microseconds) at which the user first opened the app.

int64 first_open_timestamp_micros = 2;

Returns
Type Description
UserDimensions.Builder

This builder for chaining.

clearGeoInfo()

public UserDimensions.Builder clearGeoInfo()

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Returns
Type Description
UserDimensions.Builder

clearLtvInfo()

public UserDimensions.Builder clearLtvInfo()

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Returns
Type Description
UserDimensions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public UserDimensions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UserDimensions.Builder
Overrides

clearTrafficSource()

public UserDimensions.Builder clearTrafficSource()

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Returns
Type Description
UserDimensions.Builder

clearUserId()

public UserDimensions.Builder clearUserId()

The user ID set via the setUserId API.

string user_id = 1;

Returns
Type Description
UserDimensions.Builder

This builder for chaining.

clearUserProperties()

public UserDimensions.Builder clearUserProperties()
Returns
Type Description
UserDimensions.Builder

clone()

public UserDimensions.Builder clone()
Returns
Type Description
UserDimensions.Builder
Overrides

containsUserProperties(String key)

public boolean containsUserProperties(String key)

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAppInfo()

public AppInfo getAppInfo()

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Returns
Type Description
AppInfo

The appInfo.

getAppInfoBuilder()

public AppInfo.Builder getAppInfoBuilder()

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Returns
Type Description
AppInfo.Builder

getAppInfoOrBuilder()

public AppInfoOrBuilder getAppInfoOrBuilder()

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Returns
Type Description
AppInfoOrBuilder

getBundleInfo()

public ExportBundleInfo getBundleInfo()

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Returns
Type Description
ExportBundleInfo

The bundleInfo.

getBundleInfoBuilder()

public ExportBundleInfo.Builder getBundleInfoBuilder()

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Returns
Type Description
ExportBundleInfo.Builder

getBundleInfoOrBuilder()

public ExportBundleInfoOrBuilder getBundleInfoOrBuilder()

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Returns
Type Description
ExportBundleInfoOrBuilder

getDefaultInstanceForType()

public UserDimensions getDefaultInstanceForType()
Returns
Type Description
UserDimensions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDeviceInfo()

public DeviceInfo getDeviceInfo()

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Returns
Type Description
DeviceInfo

The deviceInfo.

getDeviceInfoBuilder()

public DeviceInfo.Builder getDeviceInfoBuilder()

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Returns
Type Description
DeviceInfo.Builder

getDeviceInfoOrBuilder()

public DeviceInfoOrBuilder getDeviceInfoOrBuilder()

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Returns
Type Description
DeviceInfoOrBuilder

getFirstOpenTimestampMicros()

public long getFirstOpenTimestampMicros()

The time (in microseconds) at which the user first opened the app.

int64 first_open_timestamp_micros = 2;

Returns
Type Description
long

The firstOpenTimestampMicros.

getGeoInfo()

public GeoInfo getGeoInfo()

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Returns
Type Description
GeoInfo

The geoInfo.

getGeoInfoBuilder()

public GeoInfo.Builder getGeoInfoBuilder()

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Returns
Type Description
GeoInfo.Builder

getGeoInfoOrBuilder()

public GeoInfoOrBuilder getGeoInfoOrBuilder()

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Returns
Type Description
GeoInfoOrBuilder

getLtvInfo()

public LtvInfo getLtvInfo()

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Returns
Type Description
LtvInfo

The ltvInfo.

getLtvInfoBuilder()

public LtvInfo.Builder getLtvInfoBuilder()

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Returns
Type Description
LtvInfo.Builder

getLtvInfoOrBuilder()

public LtvInfoOrBuilder getLtvInfoOrBuilder()

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Returns
Type Description
LtvInfoOrBuilder

getMutableUserProperties()

public Map<String,UserPropertyValue> getMutableUserProperties()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,UserPropertyValue>

getTrafficSource()

public TrafficSource getTrafficSource()

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Returns
Type Description
TrafficSource

The trafficSource.

getTrafficSourceBuilder()

public TrafficSource.Builder getTrafficSourceBuilder()

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Returns
Type Description
TrafficSource.Builder

getTrafficSourceOrBuilder()

public TrafficSourceOrBuilder getTrafficSourceOrBuilder()

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Returns
Type Description
TrafficSourceOrBuilder

getUserId()

public String getUserId()

The user ID set via the setUserId API.

string user_id = 1;

Returns
Type Description
String

The userId.

getUserIdBytes()

public ByteString getUserIdBytes()

The user ID set via the setUserId API.

string user_id = 1;

Returns
Type Description
ByteString

The bytes for userId.

getUserProperties()

public Map<String,UserPropertyValue> getUserProperties()
Returns
Type Description
Map<String,UserPropertyValue>

getUserPropertiesCount()

public int getUserPropertiesCount()

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Returns
Type Description
int

getUserPropertiesMap()

public Map<String,UserPropertyValue> getUserPropertiesMap()

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Returns
Type Description
Map<String,UserPropertyValue>

getUserPropertiesOrDefault(String key, UserPropertyValue defaultValue)

public UserPropertyValue getUserPropertiesOrDefault(String key, UserPropertyValue defaultValue)

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Parameters
Name Description
key String
defaultValue UserPropertyValue
Returns
Type Description
UserPropertyValue

getUserPropertiesOrThrow(String key)

public UserPropertyValue getUserPropertiesOrThrow(String key)

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Parameter
Name Description
key String
Returns
Type Description
UserPropertyValue

hasAppInfo()

public boolean hasAppInfo()

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Returns
Type Description
boolean

Whether the appInfo field is set.

hasBundleInfo()

public boolean hasBundleInfo()

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Returns
Type Description
boolean

Whether the bundleInfo field is set.

hasDeviceInfo()

public boolean hasDeviceInfo()

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Returns
Type Description
boolean

Whether the deviceInfo field is set.

hasGeoInfo()

public boolean hasGeoInfo()

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Returns
Type Description
boolean

Whether the geoInfo field is set.

hasLtvInfo()

public boolean hasLtvInfo()

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Returns
Type Description
boolean

Whether the ltvInfo field is set.

hasTrafficSource()

public boolean hasTrafficSource()

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Returns
Type Description
boolean

Whether the trafficSource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAppInfo(AppInfo value)

public UserDimensions.Builder mergeAppInfo(AppInfo value)

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Parameter
Name Description
value AppInfo
Returns
Type Description
UserDimensions.Builder

mergeBundleInfo(ExportBundleInfo value)

public UserDimensions.Builder mergeBundleInfo(ExportBundleInfo value)

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Parameter
Name Description
value ExportBundleInfo
Returns
Type Description
UserDimensions.Builder

mergeDeviceInfo(DeviceInfo value)

public UserDimensions.Builder mergeDeviceInfo(DeviceInfo value)

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Parameter
Name Description
value DeviceInfo
Returns
Type Description
UserDimensions.Builder

mergeFrom(UserDimensions other)

public UserDimensions.Builder mergeFrom(UserDimensions other)
Parameter
Name Description
other UserDimensions
Returns
Type Description
UserDimensions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UserDimensions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserDimensions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UserDimensions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UserDimensions.Builder
Overrides

mergeGeoInfo(GeoInfo value)

public UserDimensions.Builder mergeGeoInfo(GeoInfo value)

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Parameter
Name Description
value GeoInfo
Returns
Type Description
UserDimensions.Builder

mergeLtvInfo(LtvInfo value)

public UserDimensions.Builder mergeLtvInfo(LtvInfo value)

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Parameter
Name Description
value LtvInfo
Returns
Type Description
UserDimensions.Builder

mergeTrafficSource(TrafficSource value)

public UserDimensions.Builder mergeTrafficSource(TrafficSource value)

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Parameter
Name Description
value TrafficSource
Returns
Type Description
UserDimensions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UserDimensions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UserDimensions.Builder
Overrides

putAllUserProperties(Map<String,UserPropertyValue> values)

public UserDimensions.Builder putAllUserProperties(Map<String,UserPropertyValue> values)

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Parameter
Name Description
values Map<String,UserPropertyValue>
Returns
Type Description
UserDimensions.Builder

putUserProperties(String key, UserPropertyValue value)

public UserDimensions.Builder putUserProperties(String key, UserPropertyValue value)

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Parameters
Name Description
key String
value UserPropertyValue
Returns
Type Description
UserDimensions.Builder

removeUserProperties(String key)

public UserDimensions.Builder removeUserProperties(String key)

A repeated record of user properties set with the setUserProperty API. https://firebase.google.com/docs/analytics/android/properties

map<string, .google.events.firebase.analytics.v1.UserPropertyValue> user_properties = 3;

Parameter
Name Description
key String
Returns
Type Description
UserDimensions.Builder

setAppInfo(AppInfo value)

public UserDimensions.Builder setAppInfo(AppInfo value)

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Parameter
Name Description
value AppInfo
Returns
Type Description
UserDimensions.Builder

setAppInfo(AppInfo.Builder builderForValue)

public UserDimensions.Builder setAppInfo(AppInfo.Builder builderForValue)

App information.

.google.events.firebase.analytics.v1.AppInfo app_info = 6;

Parameter
Name Description
builderForValue AppInfo.Builder
Returns
Type Description
UserDimensions.Builder

setBundleInfo(ExportBundleInfo value)

public UserDimensions.Builder setBundleInfo(ExportBundleInfo value)

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Parameter
Name Description
value ExportBundleInfo
Returns
Type Description
UserDimensions.Builder

setBundleInfo(ExportBundleInfo.Builder builderForValue)

public UserDimensions.Builder setBundleInfo(ExportBundleInfo.Builder builderForValue)

Information regarding the bundle in which these events were uploaded.

.google.events.firebase.analytics.v1.ExportBundleInfo bundle_info = 8;

Parameter
Name Description
builderForValue ExportBundleInfo.Builder
Returns
Type Description
UserDimensions.Builder

setDeviceInfo(DeviceInfo value)

public UserDimensions.Builder setDeviceInfo(DeviceInfo value)

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Parameter
Name Description
value DeviceInfo
Returns
Type Description
UserDimensions.Builder

setDeviceInfo(DeviceInfo.Builder builderForValue)

public UserDimensions.Builder setDeviceInfo(DeviceInfo.Builder builderForValue)

Device information.

.google.events.firebase.analytics.v1.DeviceInfo device_info = 4;

Parameter
Name Description
builderForValue DeviceInfo.Builder
Returns
Type Description
UserDimensions.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UserDimensions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UserDimensions.Builder
Overrides

setFirstOpenTimestampMicros(long value)

public UserDimensions.Builder setFirstOpenTimestampMicros(long value)

The time (in microseconds) at which the user first opened the app.

int64 first_open_timestamp_micros = 2;

Parameter
Name Description
value long

The firstOpenTimestampMicros to set.

Returns
Type Description
UserDimensions.Builder

This builder for chaining.

setGeoInfo(GeoInfo value)

public UserDimensions.Builder setGeoInfo(GeoInfo value)

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Parameter
Name Description
value GeoInfo
Returns
Type Description
UserDimensions.Builder

setGeoInfo(GeoInfo.Builder builderForValue)

public UserDimensions.Builder setGeoInfo(GeoInfo.Builder builderForValue)

User's geographic information.

.google.events.firebase.analytics.v1.GeoInfo geo_info = 5;

Parameter
Name Description
builderForValue GeoInfo.Builder
Returns
Type Description
UserDimensions.Builder

setLtvInfo(LtvInfo value)

public UserDimensions.Builder setLtvInfo(LtvInfo value)

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Parameter
Name Description
value LtvInfo
Returns
Type Description
UserDimensions.Builder

setLtvInfo(LtvInfo.Builder builderForValue)

public UserDimensions.Builder setLtvInfo(LtvInfo.Builder builderForValue)

Lifetime Value information about this user.

.google.events.firebase.analytics.v1.LtvInfo ltv_info = 9;

Parameter
Name Description
builderForValue LtvInfo.Builder
Returns
Type Description
UserDimensions.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UserDimensions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UserDimensions.Builder
Overrides

setTrafficSource(TrafficSource value)

public UserDimensions.Builder setTrafficSource(TrafficSource value)

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Parameter
Name Description
value TrafficSource
Returns
Type Description
UserDimensions.Builder

setTrafficSource(TrafficSource.Builder builderForValue)

public UserDimensions.Builder setTrafficSource(TrafficSource.Builder builderForValue)

Information about marketing campaign which acquired the user.

.google.events.firebase.analytics.v1.TrafficSource traffic_source = 7;

Parameter
Name Description
builderForValue TrafficSource.Builder
Returns
Type Description
UserDimensions.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UserDimensions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UserDimensions.Builder
Overrides

setUserId(String value)

public UserDimensions.Builder setUserId(String value)

The user ID set via the setUserId API.

string user_id = 1;

Parameter
Name Description
value String

The userId to set.

Returns
Type Description
UserDimensions.Builder

This builder for chaining.

setUserIdBytes(ByteString value)

public UserDimensions.Builder setUserIdBytes(ByteString value)

The user ID set via the setUserId API.

string user_id = 1;

Parameter
Name Description
value ByteString

The bytes for userId to set.

Returns
Type Description
UserDimensions.Builder

This builder for chaining.