Class UserDimensions (0.16.0)

Version latest

• 0.16.0 (latest)
• 0.15.0
• 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UserDimensions

Implements

UserDimensionsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

APP_INFO_FIELD_NUMBER

public static final int APP_INFO_FIELD_NUMBER

Field Value
Type	Description
int

BUNDLE_INFO_FIELD_NUMBER

public static final int BUNDLE_INFO_FIELD_NUMBER

Field Value
Type	Description
int

DEVICE_INFO_FIELD_NUMBER

public static final int DEVICE_INFO_FIELD_NUMBER

Field Value
Type	Description
int

FIRST_OPEN_TIMESTAMP_MICROS_FIELD_NUMBER

public static final int FIRST_OPEN_TIMESTAMP_MICROS_FIELD_NUMBER

Field Value
Type	Description
int

GEO_INFO_FIELD_NUMBER

public static final int GEO_INFO_FIELD_NUMBER

Field Value
Type	Description
int

LTV_INFO_FIELD_NUMBER

public static final int LTV_INFO_FIELD_NUMBER

Field Value
Type	Description
int

TRAFFIC_SOURCE_FIELD_NUMBER

public static final int TRAFFIC_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER

Field Value
Type	Description
int

USER_PROPERTIES_FIELD_NUMBER

public static final int USER_PROPERTIES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static UserDimensions getDefaultInstance()

Returns
Type	Description
UserDimensions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static UserDimensions.Builder newBuilder()

Returns
Type	Description
UserDimensions.Builder

newBuilder(UserDimensions prototype)

public static UserDimensions.Builder newBuilder(UserDimensions prototype)

Parameter
Name	Description
prototype	UserDimensions

Returns
Type	Description
UserDimensions.Builder

parseDelimitedFrom(InputStream input)

public static UserDimensions parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static UserDimensions parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserDimensions parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserDimensions parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static UserDimensions parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static UserDimensions parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserDimensions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserDimensions

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<UserDimensions> parser()

Returns
Type	Description
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
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAppInfo()

public AppInfo getAppInfo()

App information.

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

Returns
Type	Description
AppInfo	The appInfo.

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.

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

getDeviceInfo()

public DeviceInfo getDeviceInfo()

Device information.

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

Returns
Type	Description
DeviceInfo	The deviceInfo.

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.

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.

getLtvInfoOrBuilder()

public LtvInfoOrBuilder getLtvInfoOrBuilder()

Lifetime Value information about this user.

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

Returns
Type	Description
LtvInfoOrBuilder

getParserForType()

public Parser<UserDimensions> getParserForType()

Returns
Type	Description
Parser<UserDimensions>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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()

Use #getUserPropertiesMap() instead.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public UserDimensions.Builder newBuilderForType()

Returns
Type	Description
UserDimensions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserDimensions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
UserDimensions.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public UserDimensions.Builder toBuilder()

Returns
Type	Description
UserDimensions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException