Amplitude
Amplitude()
Deprecated legacy API of the Amplitude JS SDK - instance manager.
Wraps around the current AmplitudeClient which provides more features Function calls directly on amplitude have been deprecated. Please call methods on the default shared instance: amplitude.getInstance() instead.
See the 3.0.0 changelog for more information about this change.
Amplitude#__VERSION__
Get the current version of Amplitude's Javascript SDK.
Return Value
- (
number
) version number
Amplitude#init
Amplitude#init
Initializes the Amplitude Javascript SDK with your apiKey and any optional configurations. This is required before any other methods can be called.
Deprecated
Please use amplitude.getInstance().init(apiKey, opt_userId, opt_config, opt_callback);
Parameters
apiKey
(string
) The API key for your app.opt_userId
(string
) (optional) An identifier for this user.opt_config
(object
) (optional) Configuration options. See options.js for list of options and default values.opt_callback
(function
) (optional) Provide a callback function to run after initialization is complete.
Amplitude#isNewSession
Amplitude#isNewSession
Returns true if a new session was created during initialization, otherwise false.
Deprecated
Please use amplitude.getInstance().isNewSession();
Return Value
- (
boolean
) Whether a new session was created during initialization.
Amplitude#getSessionId
Amplitude#getSessionId
Returns the id of the current session.
Deprecated
Please use amplitude.getInstance().getSessionId();
Return Value
- (
number
) Id of the current session.
Amplitude#setDomain
Amplitude#setDomain
Sets a customer domain for the amplitude cookie. Useful if you want to support cross-subdomain tracking.
Deprecated
Please use amplitude.getInstance().setDomain(domain);
Parameters
domain
(string
) to set.
Amplitude#setUserId
Amplitude#setUserId
Sets an identifier for the current user.
Deprecated
Please use amplitude.getInstance().setUserId(userId);
Parameters
userId
(string
) identifier to set. Can be null.
Amplitude#setGroup
Amplitude#setGroup
Add user to a group or groups. You need to specify a groupType and groupName(s). For example you can group people by their organization. In that case groupType is "orgId" and groupName would be the actual ID(s). groupName can be a string or an array of strings to indicate a user in multiple gruups. You can also call setGroup multiple times with different groupTypes to track multiple types of groups (up to 5 per app). Note: this will also set groupType: groupName as a user property. See the advanced topics article for more information.
Deprecated
Please use amplitude.getInstance().setGroup(groupType, groupName);
Parameters
groupType
(string
) the group type (ex: orgId)groupName
(string|list
) the name of the group (ex: 15), or a list of names of the groups
Amplitude#setOptOut
Amplitude#setOptOut
Sets whether to opt current user out of tracking.
Deprecated
Please use amplitude.getInstance().setOptOut(enable);
Parameters
enable
(boolean
) if true then no events will be logged or sent.
Amplitude#regenerateDeviceId
Amplitude#regenerateDeviceId
Regenerates a new random deviceId for current user. Note: this is not recommended unless you know what you
are doing. This can be used in conjunction with setUserId(null)
to anonymize users after they log out.
With a null userId and a completely new deviceId, the current user would appear as a brand new user in dashboard.
This uses src/uuid.js to regenerate the deviceId.
Deprecated
Please use amplitude.getInstance().regenerateDeviceId();
Amplitude#setDeviceId
Amplitude#setDeviceId
Sets a custom deviceId for current user. Note: this is not recommended unless you know what you are doing (like if you have your own system for managing deviceIds).
Make sure the deviceId you set is sufficiently unique (we recommend something like a UUID - see src/uuid.js for an example of how to generate) to prevent conflicts with other devices in our system.
Deprecated
Please use amplitude.getInstance().setDeviceId(deviceId);
Parameters
deviceId
(string
) custom deviceId for current user.
Amplitude#setUserProperties
Amplitude#setUserProperties
Sets user properties for the current user.
Deprecated
Please use amplitude.getInstance().setUserProperties(userProperties);
Parameters
userProperties
(object
) object with string keys and values for the user properties to set.opt_replace
(boolean
) Deprecated. In earlier versions of the JS SDK the user properties object was kept in memory and replace = true would replace the object in memory. Now the properties are no longer stored in memory, so replace is deprecated.
Amplitude#clearUserProperties
Amplitude#clearUserProperties
Clear all of the user properties for the current user. Note: clearing user properties is irreversible!
Deprecated
Please use amplitude.getInstance().clearUserProperties();
Amplitude#setVersionName
Amplitude#setVersionName
Set a versionName for your application.
Deprecated
Please use amplitude.getInstance().setVersionName(versionName);
Parameters
versionName
(string
) The version to set for your application.
Amplitude#logEvent
Amplitude#logEvent
Log an event with eventType and eventProperties
Deprecated
Please use amplitude.getInstance().logEvent(eventType, eventProperties, opt_callback);
Parameters
eventType
(string
) name of eventeventProperties
(object
) (optional) an object with string keys and values for the event properties.opt_callback
(Amplitude~eventCallback
) (optional) a callback function to run after the event is logged. Note: the server response code and response body from the event upload are passed to the callback function.
Amplitude#logEventWithGroups
Amplitude#logEventWithGroups
Log an event with eventType, eventProperties, and groups. Use this to set event-level groups.
Note: the group(s) set only apply for the specific event type being logged and does not persist on the user (unless you explicitly set it with setGroup).
See the advanced topics article for more information about groups and Count by Distinct on the Amplitude platform.
Deprecated
Please use amplitude.getInstance().logEventWithGroups(eventType, eventProperties, groups, opt_callback);
Parameters
eventType
(string
) name of eventeventProperties
(object
) (optional) an object with string keys and values for the event properties.groups
(object
) (optional) an object with string groupType: groupName values for the event being logged. groupName can be a string or an array of strings.opt_callback
(Amplitude~eventCallback
) (optional) a callback function to run after the event is logged. Note: the server response code and response body from the event upload are passed to the callback function.
Amplitude#logRevenueV2
Amplitude#logRevenueV2
Log revenue with Revenue interface. The new revenue interface allows for more revenue fields like revenueType and event properties.
See the Revenue reference page for more information on the Revenue interface and logging revenue.
Deprecated
Please use amplitude.getInstance().logRevenueV2(revenue_obj);
Parameters
revenue_obj
(Revenue
) the revenue object containing the revenue data being logged.
Amplitude#logRevenue
Amplitude#logRevenue
Log revenue event with a price, quantity, and product identifier.
Deprecated
Please use amplitude.getInstance().logRevenueV2(revenue_obj);
Parameters
price
(number
) price of revenue eventquantity
(number
) (optional) quantity of products in revenue event. If no quantity specified default to 1.product
(string
) (optional) product identifier
Amplitude#setGlobalUserProperties
Amplitude#setGlobalUserProperties
Set global user properties.
Deprecated
Please use amplitudeClient.setUserProperties