org.piwik.sdk.extra

Class CustomVariables

java.lang.Object

org.piwik.sdk.extra.CustomVariables

public class CustomVariables
extends java.lang.Object

A custom variable is a custom name-value pair that you can assign to your users or screen views, and then visualize the reports of how many visits, conversions, etc. for each custom variable. A custom variable is defined by a name — for example, "User status" — and a value – for example, "LoggedIn" or "Anonymous".

You can track up to 5 custom variables for each user to your app, and up to 5 custom variables for each screen view. You may configure Piwik to track more custom variables: http://piwik.org/faq/how-to/faq_17931/

Desired json output: { "1":["OS","iphone 5.0"], "2":["Piwik Mobile Version","1.6.2"], "3":["Locale","en::en"], "4":["Num Accounts","2"], "5":["Level","over9k"] }

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_LENGTH

Constructor Summary

Constructors

Constructor and Description
CustomVariables()
CustomVariables(CustomVariables variables)
CustomVariables(java.lang.String json)

Method Summary

Modifier and Type	Method and Description
TrackMe	injectVisitVariables(TrackMe trackMe) Sets the custom variables with scope VISIT to a TrackMe.
CustomVariables	put(int index, java.lang.String name, java.lang.String value) Custom variable names and values are limited to 200 characters in length each.
CustomVariables	put(java.lang.String index, org.json.JSONArray values)
CustomVariables	putAll(CustomVariables customVariables)
int	size()
java.lang.String	toString()
TrackMe	toVisitVariables()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_LENGTH

protected static final int MAX_LENGTH

See Also:

Constant Field Values

Constructor Detail

CustomVariables

public CustomVariables()

CustomVariables

public CustomVariables(@NonNull
                       CustomVariables variables)

CustomVariables

public CustomVariables(@Nullable
                       java.lang.String json)

Method Detail

putAll

public CustomVariables putAll(CustomVariables customVariables)

put

public CustomVariables put(int index,
                           java.lang.String name,
                           java.lang.String value)

Custom variable names and values are limited to 200 characters in length each.

Parameters:

index - this Integer accepts values from 1 to 5. A given custom variable name must always be stored in the same "index" per session. For example, if you choose to store the variable name = "Gender" in index = 1 and you record another custom variable in index = 1, then the "Gender" variable will be deleted and replaced with the new custom variable stored in index 1. You may configure Piwik to track more custom variables than 5. Read more: http://piwik.org/faq/how-to/faq_17931/

name - of a specific Custom Variable such as "User type".

value - of a specific Custom Variable such as "Customer".

Returns:

super.put result if index in right range and name/value pair aren't null

put

public CustomVariables put(java.lang.String index,
                           org.json.JSONArray values)

Parameters:

index - index accepts values from 1 to 5.

values - packed key/value pair

Returns:

super.put result or null if key is null or value length is not equals 2

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

size

public int size()

injectVisitVariables

public TrackMe injectVisitVariables(@NonNull
                                    TrackMe trackMe)

Sets the custom variables with scope VISIT to a TrackMe.

toVisitVariables

@NonNull
public TrackMe toVisitVariables()