Class UserDimensions (0.14.1)

public final class UserDimensions extends GeneratedMessageV3 implements UserDimensionsOrBuilder

Message containing information about the user associated with the event.

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

Static Fields

APP_INFO_FIELD_NUMBER

public static final int APP_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

BUNDLE_INFO_FIELD_NUMBER

public static final int BUNDLE_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

DEVICE_INFO_FIELD_NUMBER

public static final int DEVICE_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

FIRST_OPEN_TIMESTAMP_MICROS_FIELD_NUMBER

public static final int FIRST_OPEN_TIMESTAMP_MICROS_FIELD_NUMBER
Field Value
TypeDescription
int

GEO_INFO_FIELD_NUMBER

public static final int GEO_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

LTV_INFO_FIELD_NUMBER

public static final int LTV_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

TRAFFIC_SOURCE_FIELD_NUMBER

public static final int TRAFFIC_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

USER_PROPERTIES_FIELD_NUMBER

public static final int USER_PROPERTIES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UserDimensions getDefaultInstance()
Returns
TypeDescription
UserDimensions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UserDimensions.Builder newBuilder()
Returns
TypeDescription
UserDimensions.Builder

newBuilder(UserDimensions prototype)

public static UserDimensions.Builder newBuilder(UserDimensions prototype)
Parameter
NameDescription
prototypeUserDimensions
Returns
TypeDescription
UserDimensions.Builder

parseDelimitedFrom(InputStream input)

public static UserDimensions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UserDimensions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserDimensions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserDimensions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UserDimensions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UserDimensions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserDimensions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UserDimensions> parser()
Returns
TypeDescription
Parser<UserDimensions>

Methods

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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAppInfo()

public AppInfo getAppInfo()

App information.

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

Returns
TypeDescription
AppInfo

The appInfo.

getAppInfoOrBuilder()

public AppInfoOrBuilder getAppInfoOrBuilder()

App information.

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

Returns
TypeDescription
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
TypeDescription
ExportBundleInfo

The bundleInfo.

getBundleInfoOrBuilder()

public ExportBundleInfoOrBuilder getBundleInfoOrBuilder()

Information regarding the bundle in which these events were uploaded.

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

Returns
TypeDescription
ExportBundleInfoOrBuilder

getDefaultInstanceForType()

public UserDimensions getDefaultInstanceForType()
Returns
TypeDescription
UserDimensions

getDeviceInfo()

public DeviceInfo getDeviceInfo()

Device information.

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

Returns
TypeDescription
DeviceInfo

The deviceInfo.

getDeviceInfoOrBuilder()

public DeviceInfoOrBuilder getDeviceInfoOrBuilder()

Device information.

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

Returns
TypeDescription
DeviceInfoOrBuilder

getFirstOpenTimestampMicros()

public long getFirstOpenTimestampMicros()

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

int64 first_open_timestamp_micros = 2;

Returns
TypeDescription
long

The firstOpenTimestampMicros.

getGeoInfo()

public GeoInfo getGeoInfo()

User's geographic information.

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

Returns
TypeDescription
GeoInfo

The geoInfo.

getGeoInfoOrBuilder()

public GeoInfoOrBuilder getGeoInfoOrBuilder()

User's geographic information.

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

Returns
TypeDescription
GeoInfoOrBuilder

getLtvInfo()

public LtvInfo getLtvInfo()

Lifetime Value information about this user.

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

Returns
TypeDescription
LtvInfo

The ltvInfo.

getLtvInfoOrBuilder()

public LtvInfoOrBuilder getLtvInfoOrBuilder()

Lifetime Value information about this user.

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

Returns
TypeDescription
LtvInfoOrBuilder

getParserForType()

public Parser<UserDimensions> getParserForType()
Returns
TypeDescription
Parser<UserDimensions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTrafficSource()

public TrafficSource getTrafficSource()

Information about marketing campaign which acquired the user.

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

Returns
TypeDescription
TrafficSource

The trafficSource.

getTrafficSourceOrBuilder()

public TrafficSourceOrBuilder getTrafficSourceOrBuilder()

Information about marketing campaign which acquired the user.

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

Returns
TypeDescription
TrafficSourceOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUserId()

public String getUserId()

The user ID set via the setUserId API.

string user_id = 1;

Returns
TypeDescription
String

The userId.

getUserIdBytes()

public ByteString getUserIdBytes()

The user ID set via the setUserId API.

string user_id = 1;

Returns
TypeDescription
ByteString

The bytes for userId.

getUserProperties()

public Map<String,UserPropertyValue> getUserProperties()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueUserPropertyValue
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
UserPropertyValue

hasAppInfo()

public boolean hasAppInfo()

App information.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the bundleInfo field is set.

hasDeviceInfo()

public boolean hasDeviceInfo()

Device information.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the trafficSource field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UserDimensions.Builder newBuilderForType()
Returns
TypeDescription
UserDimensions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserDimensions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UserDimensions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UserDimensions.Builder toBuilder()
Returns
TypeDescription
UserDimensions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException