org.piwik.sdk.extra

Class CustomDimension

java.lang.Object

org.piwik.sdk.extra.CustomDimension

public class CustomDimension
extends java.lang.Object

Allows you to track Custom Dimensions. In order to use this functionality install and configure https://plugins.piwik.org/CustomDimensions plugin.

Constructor Summary

Constructors

Constructor and Description
CustomDimension()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDimension(TrackMe trackMe, int dimensionId)
static boolean	setDimension(TrackMe trackMe, int dimensionId, java.lang.String dimensionValue) This method sets a tracking API parameter dimension%dimensionId%=%dimensionValue%.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDimension

public CustomDimension()

Method Detail

setDimension

public static boolean setDimension(@NonNull
                                   TrackMe trackMe,
                                   int dimensionId,
                                   @Nullable
                                   java.lang.String dimensionValue)

This method sets a tracking API parameter dimension%dimensionId%=%dimensionValue%. Eg dimension1=foo or dimension2=bar. So the tracking API parameter starts with dimension followed by the set dimensionId.

Requires Custom Dimensions plugin (server-side)

Parameters:

trackMe - into which the data should be inserted

dimensionId - accepts values greater than 0

dimensionValue - is limited to 255 characters, you can pass null to delete a value

Returns:

true if the value was valid

getDimension

@Nullable
public static java.lang.String getDimension(TrackMe trackMe,
                                                       int dimensionId)