PiwikRequest (Piwik Java Tracker 1.2 API)

java.lang.Object
- org.piwik.java.tracking.PiwikRequest

```
public class PiwikRequest
extends Object
```
A class that implements the Piwik Tracking HTTP API. These requests can be sent using PiwikTracker.

Author:

brettcsorba

Field Summary

Fields
Modifier and Type Field and Description

static int AUTH_TOKEN_LENGTH

static int ID_LENGTH

Fields
Modifier and Type	Field and Description
`static int`	`AUTH_TOKEN_LENGTH`
`static int`	`ID_LENGTH`

Constructor Summary

Constructors
Constructor and Description
`PiwikRequest(Integer siteId, URL actionUrl)` Create a new request from the id of the site being tracked and the full url for the current action.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCustomTrackingParameter(String key, Object value)` Add a custom tracking parameter to the specified key.
`void`	`addEcommerceItem(EcommerceItem item)` Add an `EcommerceItem` to this order.
`void`	`clearCustomTrackingParameter()` Removes all custom tracking parameters
`void`	`clearEcommerceItems()` Clears all `EcommerceItem` from this order.
`void`	`enableEcommerce()` Sets idgoal=0 in the request to track an ecommerce interaction: cart update or an ecommerce order.
`String`	`getActionName()` Get the title of the action being tracked
`Long`	`getActionTime()` Get the amount of time it took the server to generate this action, in milliseconds.
`URL`	`getActionUrl()` Get the full URL for the current action.
`String`	`getActionUrlAsString()` Get the full URL for the current action.
`String`	`getApiVersion()` Get the api version
`String`	`getAuthToken()` Get the authorization key.
`String`	`getCampaignKeyword()` Get the campaign keyword
`String`	`getCampaignName()` Get the campaign name
`Charset`	`getCharacterSet()` Get the charset of the page being tracked
`String`	`getContentInteraction()` Get the name of the interaction with the content
`String`	`getContentName()` Get the name of the content
`String`	`getContentPiece()` Get the content piece.
`URL`	`getContentTarget()` Get the content target
`String`	`getContentTargetAsString()` Get the content target
`Integer`	`getCurrentHour()` Get the current hour.
`Integer`	`getCurrentMinute()` Get the current minute.
`Integer`	`getCurrentSecond()` Get the current second
`List`	`getCustomTrackingParameter(String key)` Gets the list of objects currently stored at the specified custom tracking parameter.
`String`	`getDeviceResolution()` Get the resolution of the device
`URL`	`getDownloadUrl()` Get the url of a file the user had downloaded
`String`	`getDownloadUrlAsString()` Get the url of a file the user had downloaded
`Double`	`getEcommerceDiscount()` Get the discount offered.
`String`	`getEcommerceId()` Get the id of this order.
`EcommerceItem`	`getEcommerceItem(int index)` Get the `EcommerceItem` at the specified index
`Long`	`getEcommerceLastOrderTimestamp()` Get the timestamp of the customer's last ecommerce order
`Double`	`getEcommerceRevenue()` Get the grand total of the ecommerce order.
`Double`	`getEcommerceShippingCost()` Get the shipping cost of the ecommerce order.
`Double`	`getEcommerceSubtotal()` Get the subtotal of the ecommerce order; excludes shipping.
`Double`	`getEcommerceTax()` Get the tax amount of the ecommerce order.
`String`	`getEventAction()` Get the event action.
`String`	`getEventCategory()` Get the event category.
`String`	`getEventName()` Get the event name.
`Number`	`getEventValue()` Get the event value.
`Integer`	`getGoalId()` Get the goal id
`Double`	`getGoalRevenue()` Get the goal revenue.
`String`	`getHeaderAcceptLanguage()` Get the Accept-Language HTTP header
`String`	`getHeaderUserAgent()` Get the User-Agent HTTP header
`Boolean`	`getNewVisit()` Get if this request will force a new visit.
`URL`	`getOutlinkUrl()` Get the outlink url
`String`	`getOutlinkUrlAsString()` Get the outlink url
`CustomVariable`	`getPageCustomVariable(int index)` Get the page custom variable at the specified index.
`String`	`getPageCustomVariable(String key)` Deprecated. Use the `getPageCustomVariable(int)` method instead.
`Boolean`	`getPluginDirector()` Check if the visitor has the Director plugin.
`Boolean`	`getPluginFlash()` Check if the visitor has the Flash plugin.
`Boolean`	`getPluginGears()` Check if the visitor has the Gears plugin.
`Boolean`	`getPluginJava()` Check if the visitor has the Java plugin.
`Boolean`	`getPluginPDF()` Check if the visitor has the PDF plugin.
`Boolean`	`getPluginQuicktime()` Check if the visitor has the Quicktime plugin.
`Boolean`	`getPluginRealPlayer()` Check if the visitor has the RealPlayer plugin.
`Boolean`	`getPluginSilverlight()` Check if the visitor has the Silverlight plugin.
`Boolean`	`getPluginWindowsMedia()` Check if the visitor has the Windows Media plugin.
`String`	`getQueryString()` Get the query string represented by this object.
`static String`	`getRandomHexString(int length)` Get a random hexadecimal string of a specified length.
`String`	`getRandomValue()` Get the random value for this request
`URL`	`getReferrerUrl()` Get the referrer url
`String`	`getReferrerUrlAsString()` Get the referrer url
`PiwikDate`	`getRequestDatetime()` Get the datetime of the request
`Boolean`	`getRequired()` Get if this request will be tracked.
`Boolean`	`getResponseAsImage()` Get if the response will be an image.
`String`	`getSearchCategory()` Get the search category
`String`	`getSearchQuery()` Get the search query.
`Long`	`getSearchResultsCount()` Get the search results count.
`Integer`	`getSiteId()` Get the id of the website we're tracking.
`Boolean`	`getTrackBotRequests()` Set if bot requests should be tracked
`String`	`getUrlEncodedQueryString()` Get the url encoded query string represented by this object.
`String`	`getUserCustomVariable(String key)` Deprecated. Use the `getVisitCustomVariable(int)` method instead.
`String`	`getUserId()` Get the user id for this request.
`CustomVariable`	`getVisitCustomVariable(int index)` Get the visit custom variable at the specified index.
`String`	`getVisitorCity()` Get the visitor's city.
`PiwikLocale`	`getVisitorCountry()` Get the visitor's country.
`String`	`getVisitorCustomId()` Get the visitor's custom id.
`Long`	`getVisitorFirstVisitTimestamp()` Get the timestamp of the visitor's first visit.
`String`	`getVisitorId()` Get the visitor's id.
`String`	`getVisitorIp()` Get the visitor's ip.
`Double`	`getVisitorLatitude()` Get the visitor's latitude.
`Double`	`getVisitorLongitude()` Get the visitor's longitude.
`Long`	`getVisitorPreviousVisitTimestamp()` Get the timestamp of the visitor's previous visit.
`String`	`getVisitorRegion()` Get the visitor's region.
`Integer`	`getVisitorVisitCount()` Get the count of visits for this visitor.
`void`	`setActionName(String actionName)` Set the title of the action being tracked.
`void`	`setActionTime(Long actionTime)` Set the amount of time it took the server to generate this action, in milliseconds.
`void`	`setActionUrl(URL actionUrl)` Set the full URL for the current action.
`void`	`setActionUrlWithString(String actionUrl)` Set the full URL for the current action.
`void`	`setApiVersion(String apiVersion)` Set the api version to use (currently always set to 1)
`void`	`setAuthToken(String authToken)` Set the 32 character authorization key used to authenticate the API request.
`void`	`setCampaignKeyword(String campaignKeyword)` Set the Campaign Keyword (see Tracking Campaigns).
`void`	`setCampaignName(String campaignName)` Set the Campaign Name (see Tracking Campaigns).
`void`	`setCharacterSet(Charset characterSet)` The charset of the page being tracked.
`void`	`setContentInteraction(String contentInteraction)` Set the name of the interaction with the content.
`void`	`setContentName(String contentName)` Set the name of the content.
`void`	`setContentPiece(String contentPiece)` Set the actual content piece.
`void`	`setContentTarget(URL contentTarget)` Set the target of the content.
`void`	`setContentTargetWithString(String contentTarget)` Set the target of the content.
`void`	`setCurrentHour(Integer currentHour)` Set the current hour (local time).
`void`	`setCurrentMinute(Integer currentMinute)` Set the current minute (local time).
`void`	`setCurrentSecond(Integer currentSecond)` Set the current second (local time).
`void`	`setCustomTrackingParameter(String key, Object value)` Set a custom tracking parameter whose toString() value will be sent to the Piwik server.
`void`	`setDeviceResolution(String deviceResolution)` Set the resolution of the device the visitor is using, eg 1280x1024.
`void`	`setDownloadUrl(URL downloadUrl)` Set the url of a file the user has downloaded.
`void`	`setDownloadUrlWithString(String downloadUrl)` Set the url of a file the user has downloaded.
`void`	`setEcommerceDiscount(Double discount)` Set the discount offered.
`void`	`setEcommerceId(String id)` Set the unique string identifier for the ecommerce order (required when tracking an ecommerce order).
`void`	`setEcommerceLastOrderTimestamp(Long timestamp)` Set the UNUX timestamp of this customer's last ecommerce order.
`void`	`setEcommerceRevenue(Double revenue)` Set the grand total of the ecommerce order (required when tracking an ecommerce order).
`void`	`setEcommerceShippingCost(Double shippingCost)` Set the shipping cost of the ecommerce order.
`void`	`setEcommerceSubtotal(Double subtotal)` Set the subtotal of the ecommerce order; excludes shipping.
`void`	`setEcommerceTax(Double tax)` Set the tax amount of the ecommerce order.
`void`	`setEventAction(String eventAction)` Set the event action.
`void`	`setEventCategory(String eventCategory)` Set the event category.
`void`	`setEventName(String eventName)` Set the event name.
`void`	`setEventValue(Number eventValue)` Set the event value.
`void`	`setGoalId(Integer goalId)` Set the goal id.
`void`	`setGoalRevenue(Double goalRevenue)` Set a monetary value that was generated as revenue by this goal conversion.
`void`	`setHeaderAcceptLanguage(String acceptLangage)` Set an override value for the Accept-Language HTTP header field.
`void`	`setHeaderUserAgent(String userAgent)` Set an override value for the User-Agent HTTP header field.
`void`	`setNewVisit(Boolean newVisit)` If set to true, will force a new visit to be created for this action.
`void`	`setOutlinkUrl(URL outlinkUrl)` Set an external URL the user has opened.
`void`	`setOutlinkUrlWithString(String outlinkUrl)` Set an external URL the user has opened.
`void`	`setPageCustomVariable(CustomVariable customVariable, int index)` Set a page custom variable at the specified index.
`void`	`setPageCustomVariable(String key, String value)` Deprecated. Use the `setPageCustomVariable(CustomVariable, int)` method instead.
`void`	`setPluginDirector(Boolean director)` Set if the visitor has the Director plugin.
`void`	`setPluginFlash(Boolean flash)` Set if the visitor has the Flash plugin.
`void`	`setPluginGears(Boolean gears)` Set if the visitor has the Gears plugin.
`void`	`setPluginJava(Boolean java)` Set if the visitor has the Java plugin.
`void`	`setPluginPDF(Boolean pdf)` Set if the visitor has the PDF plugin.
`void`	`setPluginQuicktime(Boolean quicktime)` Set if the visitor has the Quicktime plugin.
`void`	`setPluginRealPlayer(Boolean realPlayer)` Set if the visitor has the RealPlayer plugin.
`void`	`setPluginSilverlight(Boolean silverlight)` Set if the visitor has the Silverlight plugin.
`void`	`setPluginWindowsMedia(Boolean windowsMedia)` Set if the visitor has the Windows Media plugin.
`void`	`setRandomValue(String randomValue)` Set a random value that is generated before each request.
`void`	`setReferrerUrl(URL referrerUrl)` Set the full HTTP Referrer URL.
`void`	`setReferrerUrlWithString(String referrerUrl)` Set the full HTTP Referrer URL.
`void`	`setRequestDatetime(PiwikDate datetime)` Set the datetime of the request (normally the current time is used).
`void`	`setRequired(Boolean required)` Set if this request will be tracked by the Piwik server.
`void`	`setResponseAsImage(Boolean responseAsImage)` Set if the response will be an image.
`void`	`setSearchCategory(String searchCategory)` Specify a search category with this parameter.
`void`	`setSearchQuery(String searchQuery)` Set the search query.
`void`	`setSearchResultsCount(Long searchResultsCount)` We recommend to set the search count to the number of search results displayed on the results page.
`void`	`setSiteId(Integer siteId)` Set the ID of the website we're tracking a visit/action for.
`void`	`setTrackBotRequests(Boolean trackBotRequests)` By default Piwik does not track bots.
`void`	`setUserCustomVariable(String key, String value)` Deprecated. Use the `setVisitCustomVariable(CustomVariable, int)` method instead.
`void`	`setUserId(String userId)` Set the user id for this request.
`void`	`setVisitCustomVariable(CustomVariable customVariable, int index)` Set a user custom variable at the specified key.
`void`	`setVisitorCity(String city)` Set an override value for the city.
`void`	`setVisitorCountry(PiwikLocale country)` Set an override value for the country.
`void`	`setVisitorCustomId(String visitorCustomId)` Set a custom visitor ID for this request.
`void`	`setVisitorFirstVisitTimestamp(Long timestamp)` Set the UNIX timestamp of this visitor's first visit.
`void`	`setVisitorId(String visitorId)` Set the unique visitor ID, must be a 16 characters hexadecimal string.
`void`	`setVisitorIp(String visitorIp)` Set the override value for the visitor IP (both IPv4 and IPv6 notations supported).
`void`	`setVisitorLatitude(Double latitude)` Set an override value for the visitor's latitude, eg 22.456.
`void`	`setVisitorLongitude(Double longitude)` Set an override value for the visitor's longitude, eg 22.456.
`void`	`setVisitorPreviousVisitTimestamp(Long timestamp)` Set the UNIX timestamp of this visitor's previous visit.
`void`	`setVisitorRegion(String region)` Set an override value for the region.
`void`	`setVisitorVisitCount(Integer visitorVisitCount)` Set the current count of visits for this visitor.
`void`	`verifyAuthTokenSet()` Verifies that AuthToken has been set for this request.
`void`	`verifyEcommerceEnabled()` Verifies that Ecommerce has been enabled for the request.
`void`	`verifyEcommerceState()` Verifies that Ecommerce has been enabled and that Ecommerce Id and Ecommerce Revenue have been set for the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ID_LENGTH
```
public static final int ID_LENGTH
```
    See Also:
    
    Constant Field Values
  - AUTH_TOKEN_LENGTH
```
public static final int AUTH_TOKEN_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PiwikRequest
```
public PiwikRequest(Integer siteId,
                    URL actionUrl)
```
    Create a new request from the id of the site being tracked and the full url for the current action. This constructor also sets:
```
 
 Required = true
 Visior Id = random 16 character hex string
 Random Value = random 20 character hex string
 API version = 1
 Response as Image = false
 
 
```
    Overwrite these values yourself as desired.
    Parameters:
    
    siteId - the id of the website we're tracking a visit/action for
    
    actionUrl - the full URL for the current action
- Method Detail
  - getActionName
```
public String getActionName()
```
    Get the title of the action being tracked
    
    Returns:
    
    the title of the action being tracked
  - setActionName
```
public void setActionName(String actionName)
```
    Set the title of the action being tracked. It is possible to use slashes / to set one or several categories for this action. For example, Help / Feedback will create the Action Feedback in the category Help.
    
    Parameters:
    
    actionName - the title of the action to set. A null value will remove this parameter
  - getActionTime
```
public Long getActionTime()
```
    Get the amount of time it took the server to generate this action, in milliseconds.
    
    Returns:
    
    the amount of time
  - setActionTime
```
public void setActionTime(Long actionTime)
```
    Set the amount of time it took the server to generate this action, in milliseconds. This value is used to process the Page speed report Avg. generation time column in the Page URL and Page Title reports, as well as a site wide running average of the speed of your server.
    
    Parameters:
    
    actionTime - the amount of time to set. A null value will remove this parameter
  - getActionUrl
```
public URL getActionUrl()
```
    Get the full URL for the current action.
    
    Returns:
    
    the full URL
    
    Throws:
    
    TypeConstraintException - if the stored Action URL is a string
  - getActionUrlAsString
```
public String getActionUrlAsString()
```
    Get the full URL for the current action.
    
    Returns:
    
    the full URL
    
    Throws:
    
    TypeConstraintException - if the stored Action URL is a URL
  - setActionUrl
```
public void setActionUrl(URL actionUrl)
```
    Set the full URL for the current action.
    
    Parameters:
    
    actionUrl - the full URL to set. A null value will remove this parameter
  - setActionUrlWithString
```
public void setActionUrlWithString(String actionUrl)
```
    Set the full URL for the current action.
    
    Parameters:
    
    actionUrl - the full URL to set. A null value will remove this parameter
  - getApiVersion
```
public String getApiVersion()
```
    Get the api version
    
    Returns:
    
    the api version
  - setApiVersion
```
public void setApiVersion(String apiVersion)
```
    Set the api version to use (currently always set to 1)
    
    Parameters:
    
    apiVersion - the api version to set. A null value will remove this parameter
  - getAuthToken
```
public String getAuthToken()
```
    Get the authorization key.
    
    Returns:
    
    the authorization key
  - setAuthToken
```
public void setAuthToken(String authToken)
```
    Set the 32 character authorization key used to authenticate the API request.
    
    Parameters:
    
    authToken - the authorization key to set. A null value will remove this parameter
  - verifyAuthTokenSet
```
public void verifyAuthTokenSet()
```
    Verifies that AuthToken has been set for this request. Will throw an IllegalStateException if not.
  - getCampaignKeyword
```
public String getCampaignKeyword()
```
    Get the campaign keyword
    
    Returns:
    
    the campaign keyword
  - setCampaignKeyword
```
public void setCampaignKeyword(String campaignKeyword)
```
    Set the Campaign Keyword (see Tracking Campaigns). Used to populate the Referrers > Campaigns report (clicking on a campaign loads all keywords for this campaign). Note: this parameter will only be used for the first pageview of a visit.
    
    Parameters:
    
    campaignKeyword - the campaign keyword to set. A null value will remove this parameter
  - getCampaignName
```
public String getCampaignName()
```
    Get the campaign name
    
    Returns:
    
    the campaign name
  - setCampaignName
```
public void setCampaignName(String campaignName)
```
    Set the Campaign Name (see Tracking Campaigns). Used to populate the Referrers > Campaigns report. Note: this parameter will only be used for the first pageview of a visit.
    
    Parameters:
    
    campaignName - the campaign name to set. A null value will remove this parameter
  - getCharacterSet
```
public Charset getCharacterSet()
```
    Get the charset of the page being tracked
    
    Returns:
    
    the charset
  - setCharacterSet
```
public void setCharacterSet(Charset characterSet)
```
    The charset of the page being tracked. Specify the charset if the data you send to Piwik is encoded in a different character set than the default utf-8.
    
    Parameters:
    
    characterSet - the charset to set. A null value will remove this parameter
  - getContentInteraction
```
public String getContentInteraction()
```
    Get the name of the interaction with the content
    
    Returns:
    
    the name of the interaction
  - setContentInteraction
```
public void setContentInteraction(String contentInteraction)
```
    Set the name of the interaction with the content. For instance a 'click'.
    
    Parameters:
    
    contentInteraction - the name of the interaction to set. A null value will remove this parameter
  - getContentName
```
public String getContentName()
```
    Get the name of the content
    
    Returns:
    
    the name
  - setContentName
```
public void setContentName(String contentName)
```
    Set the name of the content. For instance 'Ad Foo Bar'.
    
    Parameters:
    
    contentName - the name to set. A null value will remove this parameter
  - getContentPiece
```
public String getContentPiece()
```
    Get the content piece.
    
    Returns:
    
    the content piece.
  - setContentPiece
```
public void setContentPiece(String contentPiece)
```
    Set the actual content piece. For instance the path to an image, video, audio, any text.
    
    Parameters:
    
    contentPiece - the content piece to set. A null value will remove this parameter
  - getContentTarget
```
public URL getContentTarget()
```
    Get the content target
    
    Returns:
    
    the target
    
    Throws:
    
    TypeConstraintException - if the stored Content Target is a string
  - getContentTargetAsString
```
public String getContentTargetAsString()
```
    Get the content target
    
    Returns:
    
    the target
    
    Throws:
    
    TypeConstraintException - if the stored Content Target is a URL
  - setContentTarget
```
public void setContentTarget(URL contentTarget)
```
    Set the target of the content. For instance the URL of a landing page.
    
    Parameters:
    
    contentTarget - the target to set. A null value will remove this parameter
  - setContentTargetWithString
```
public void setContentTargetWithString(String contentTarget)
```
    Set the target of the content. For instance the URL of a landing page.
    
    Parameters:
    
    contentTarget - the target to set. A null value will remove this parameter
  - getCurrentHour
```
public Integer getCurrentHour()
```
    Get the current hour.
    
    Returns:
    
    the current hour
  - setCurrentHour
```
public void setCurrentHour(Integer currentHour)
```
    Set the current hour (local time).
    
    Parameters:
    
    currentHour - the hour to set. A null value will remove this parameter
  - getCurrentMinute
```
public Integer getCurrentMinute()
```
    Get the current minute.
    
    Returns:
    
    the current minute
  - setCurrentMinute
```
public void setCurrentMinute(Integer currentMinute)
```
    Set the current minute (local time).
    
    Parameters:
    
    currentMinute - the minute to set. A null value will remove this parameter
  - getCurrentSecond
```
public Integer getCurrentSecond()
```
    Get the current second
    
    Returns:
    
    the current second
  - setCurrentSecond
```
public void setCurrentSecond(Integer currentSecond)
```
    Set the current second (local time).
    
    Parameters:
    
    currentSecond - the second to set. A null value will remove this parameter
  - getCustomTrackingParameter
```
public List getCustomTrackingParameter(String key)
```
    Gets the list of objects currently stored at the specified custom tracking parameter. An empty list will be returned if there are no objects set at that key.
    
    Parameters:
    
    key - the key of the parameter whose list of objects to get. Cannot be null
    
    Returns:
    
    the list of objects currently stored at the specified key
  - setCustomTrackingParameter
```
public void setCustomTrackingParameter(String key,
                                       Object value)
```
    Set a custom tracking parameter whose toString() value will be sent to the Piwik server. These parameters are stored separately from named Piwik parameters, meaning it is not possible to overwrite or clear named Piwik parameters with this method. A custom parameter that has the same name as a named Piwik parameter will be sent in addition to that named parameter.
    
    Parameters:
    
    key - the parameter's key. Cannot be null
    
    value - the parameter's value. Removes the parameter if null
  - addCustomTrackingParameter
```
public void addCustomTrackingParameter(String key,
                                       Object value)
```
    Add a custom tracking parameter to the specified key. This allows users to have multiple parameters with the same name and different values, commonly used during situations where list parameters are needed
    
    Parameters:
    
    key - the parameter's key. Cannot be null
    
    value - the parameter's value. Cannot be null
  - clearCustomTrackingParameter
```
public void clearCustomTrackingParameter()
```
    Removes all custom tracking parameters
  - getDeviceResolution
```
public String getDeviceResolution()
```
    Get the resolution of the device
    
    Returns:
    
    the resolution
  - setDeviceResolution
```
public void setDeviceResolution(String deviceResolution)
```
    Set the resolution of the device the visitor is using, eg 1280x1024.
    
    Parameters:
    
    deviceResolution - the resolution to set. A null value will remove this parameter
  - getDownloadUrl
```
public URL getDownloadUrl()
```
    Get the url of a file the user had downloaded
    
    Returns:
    
    the url
    
    Throws:
    
    TypeConstraintException - if the stored Download URL is a String
  - getDownloadUrlAsString
```
public String getDownloadUrlAsString()
```
    Get the url of a file the user had downloaded
    
    Returns:
    
    the url
    
    Throws:
    
    TypeConstraintException - if the stored Download URL is a URL
  - setDownloadUrl
```
public void setDownloadUrl(URL downloadUrl)
```
    Set the url of a file the user has downloaded. Used for tracking downloads. We recommend to also set the url parameter to this same value.
    
    Parameters:
    
    downloadUrl - the url to set. A null value will remove this parameter
  - setDownloadUrlWithString
```
public void setDownloadUrlWithString(String downloadUrl)
```
    Set the url of a file the user has downloaded. Used for tracking downloads. We recommend to also set the url parameter to this same value.
    
    Parameters:
    
    downloadUrl - the url to set. A null value will remove this parameter
  - enableEcommerce
```
public void enableEcommerce()
```
    Sets idgoal=0 in the request to track an ecommerce interaction: cart update or an ecommerce order.
  - verifyEcommerceEnabled
```
public void verifyEcommerceEnabled()
```
    Verifies that Ecommerce has been enabled for the request. Will throw an IllegalStateException if not.
  - verifyEcommerceState
```
public void verifyEcommerceState()
```
    Verifies that Ecommerce has been enabled and that Ecommerce Id and Ecommerce Revenue have been set for the request. Will throw an IllegalStateException if not.
  - getEcommerceDiscount
```
public Double getEcommerceDiscount()
```
    Get the discount offered.
    
    Returns:
    
    the discount
  - setEcommerceDiscount
```
public void setEcommerceDiscount(Double discount)
```
    Set the discount offered. Ecommerce must be enabled, and EcommerceId and EcommerceRevenue must first be set.
    
    Parameters:
    
    discount - the discount to set. A null value will remove this parameter
  - getEcommerceId
```
public String getEcommerceId()
```
    Get the id of this order.
    
    Returns:
    
    the id
  - setEcommerceId
```
public void setEcommerceId(String id)
```
    Set the unique string identifier for the ecommerce order (required when tracking an ecommerce order). Ecommerce must be enabled.
    
    Parameters:
    
    id - the id to set. A null value will remove this parameter
  - getEcommerceItem
```
public EcommerceItem getEcommerceItem(int index)
```
    Get the EcommerceItem at the specified index
    
    Parameters:
    
    index - the index of the EcommerceItem to return
    
    Returns:
    
    the EcommerceItem at the specified index
  - addEcommerceItem
```
public void addEcommerceItem(EcommerceItem item)
```
    Add an EcommerceItem to this order. Ecommerce must be enabled, and EcommerceId and EcommerceRevenue must first be set.
    
    Parameters:
    
    item - the EcommerceItem to add. Cannot be null
  - clearEcommerceItems
```
public void clearEcommerceItems()
```
    Clears all EcommerceItem from this order.
  - getEcommerceLastOrderTimestamp
```
public Long getEcommerceLastOrderTimestamp()
```
    Get the timestamp of the customer's last ecommerce order
    
    Returns:
    
    the timestamp
  - setEcommerceLastOrderTimestamp
```
public void setEcommerceLastOrderTimestamp(Long timestamp)
```
    Set the UNUX timestamp of this customer's last ecommerce order. This value is used to process the "Days since last order" report. Ecommerce must be enabled, and EcommerceId and EcommerceRevenue must first be set.
    
    Parameters:
    
    timestamp - the timestamp to set. A null value will remove this parameter
  - getEcommerceRevenue
```
public Double getEcommerceRevenue()
```
    Get the grand total of the ecommerce order.
    
    Returns:
    
    the grand total
  - setEcommerceRevenue
```
public void setEcommerceRevenue(Double revenue)
```
    Set the grand total of the ecommerce order (required when tracking an ecommerce order). Ecommerce must be enabled.
    
    Parameters:
    
    revenue - the grand total to set. A null value will remove this parameter
  - getEcommerceShippingCost
```
public Double getEcommerceShippingCost()
```
    Get the shipping cost of the ecommerce order.
    
    Returns:
    
    the shipping cost
  - setEcommerceShippingCost
```
public void setEcommerceShippingCost(Double shippingCost)
```
    Set the shipping cost of the ecommerce order. Ecommerce must be enabled, and EcommerceId and EcommerceRevenue must first be set.
    
    Parameters:
    
    shippingCost - the shipping cost to set. A null value will remove this parameter
  - getEcommerceSubtotal
```
public Double getEcommerceSubtotal()
```
    Get the subtotal of the ecommerce order; excludes shipping.
    
    Returns:
    
    the subtotal
  - setEcommerceSubtotal
```
public void setEcommerceSubtotal(Double subtotal)
```
    Set the subtotal of the ecommerce order; excludes shipping. Ecommerce must be enabled and EcommerceId and EcommerceRevenue must first be set.
    
    Parameters:
    
    subtotal - the subtotal to set. A null value will remove this parameter
  - getEcommerceTax
```
public Double getEcommerceTax()
```
    Get the tax amount of the ecommerce order.
    
    Returns:
    
    the tax amount
  - setEcommerceTax
```
public void setEcommerceTax(Double tax)
```
    Set the tax amount of the ecommerce order. Ecommerce must be enabled, and EcommerceId and EcommerceRevenue must first be set.
    
    Parameters:
    
    tax - the tax amount to set. A null value will remove this parameter
  - getEventAction
```
public String getEventAction()
```
    Get the event action.
    
    Returns:
    
    the event action
  - setEventAction
```
public void setEventAction(String eventAction)
```
    Set the event action. Must not be empty. (eg. Play, Pause, Duration, Add Playlist, Downloaded, Clicked...).
    
    Parameters:
    
    eventAction - the event action to set. A null value will remove this parameter
  - getEventCategory
```
public String getEventCategory()
```
    Get the event category.
    
    Returns:
    
    the event category
  - setEventCategory
```
public void setEventCategory(String eventCategory)
```
    Set the event category. Must not be empty. (eg. Videos, Music, Games...).
    
    Parameters:
    
    eventCategory - the event category to set. A null value will remove this parameter
  - getEventName
```
public String getEventName()
```
    Get the event name.
    
    Returns:
    
    the event name
  - setEventName
```
public void setEventName(String eventName)
```
    Set the event name. (eg. a Movie name, or Song name, or File name...).
    
    Parameters:
    
    eventName - the event name to set. A null value will remove this parameter
  - getEventValue
```
public Number getEventValue()
```
    Get the event value.
    
    Returns:
    
    the event value
  - setEventValue
```
public void setEventValue(Number eventValue)
```
    Set the event value. Must be a float or integer value (numeric), not a string.
    
    Parameters:
    
    eventValue - the event value to set. A null value will remove this parameter
  - getGoalId
```
public Integer getGoalId()
```
    Get the goal id
    
    Returns:
    
    the goal id
  - setGoalId
```
public void setGoalId(Integer goalId)
```
    Set the goal id. If specified, the tracking request will trigger a conversion for the goal of the website being tracked with this id.
    
    Parameters:
    
    goalId - the goal id to set. A null value will remove this parameter
  - getGoalRevenue
```
public Double getGoalRevenue()
```
    Get the goal revenue.
    
    Returns:
    
    the goal revenue
  - setGoalRevenue
```
public void setGoalRevenue(Double goalRevenue)
```
    Set a monetary value that was generated as revenue by this goal conversion. Only used if idgoal is specified in the request.
    
    Parameters:
    
    goalRevenue - the goal revenue to set. A null value will remove this parameter
  - getHeaderAcceptLanguage
```
public String getHeaderAcceptLanguage()
```
    Get the Accept-Language HTTP header
    
    Returns:
    
    the Accept-Language HTTP header
  - setHeaderAcceptLanguage
```
public void setHeaderAcceptLanguage(String acceptLangage)
```
    Set an override value for the Accept-Language HTTP header field. This value is used to detect the visitor's country if GeoIP is not enabled.
    
    Parameters:
    
    acceptLangage - the Accept-Language HTTP header to set. A null value will remove this parameter
  - getHeaderUserAgent
```
public String getHeaderUserAgent()
```
    Get the User-Agent HTTP header
    
    Returns:
    
    the User-Agent HTTP header
  - setHeaderUserAgent
```
public void setHeaderUserAgent(String userAgent)
```
    Set an override value for the User-Agent HTTP header field. The user agent is used to detect the operating system and browser used.
    
    Parameters:
    
    userAgent - the User-Agent HTTP header tos et
  - getNewVisit
```
public Boolean getNewVisit()
```
    Get if this request will force a new visit.
    
    Returns:
    
    true if this request will force a new visit
  - setNewVisit
```
public void setNewVisit(Boolean newVisit)
```
    If set to true, will force a new visit to be created for this action.
    
    Parameters:
    
    newVisit - if this request will force a new visit
  - getOutlinkUrl
```
public URL getOutlinkUrl()
```
    Get the outlink url
    
    Returns:
    
    the outlink url
    
    Throws:
    
    TypeConstraintException - if the stored Outlink URL is a String
  - getOutlinkUrlAsString
```
public String getOutlinkUrlAsString()
```
    Get the outlink url
    
    Returns:
    
    the outlink url
    
    Throws:
    
    TypeConstraintException - if the stored Outlink URL is a URL
  - setOutlinkUrl
```
public void setOutlinkUrl(URL outlinkUrl)
```
    Set an external URL the user has opened. Used for tracking outlink clicks. We recommend to also set the url parameter to this same value.
    
    Parameters:
    
    outlinkUrl - the outlink url to set. A null value will remove this parameter
  - setOutlinkUrlWithString
```
public void setOutlinkUrlWithString(String outlinkUrl)
```
    Set an external URL the user has opened. Used for tracking outlink clicks. We recommend to also set the url parameter to this same value.
    
    Parameters:
    
    outlinkUrl - the outlink url to set. A null value will remove this parameter
  - getPageCustomVariable
```
@Deprecated
public String getPageCustomVariable(String key)
```
    Deprecated. Use the getPageCustomVariable(int) method instead.
    
    Get the page custom variable at the specified key.
    
    Parameters:
    
    key - the key of the variable to get
    
    Returns:
    
    the variable at the specified key, null if key is not present
  - getPageCustomVariable
```
public CustomVariable getPageCustomVariable(int index)
```
    Get the page custom variable at the specified index.
    
    Parameters:
    
    index - the index of the variable to get. Must be greater than 0
    
    Returns:
    
    the variable at the specified key, null if nothing at this index
  - setPageCustomVariable
```
@Deprecated
public void setPageCustomVariable(String key,
                                              String value)
```
    Deprecated. Use the setPageCustomVariable(CustomVariable, int) method instead.
    
    Set a page custom variable with the specified key and value at the first available index. All page custom variables with this key will be overwritten or deleted
    
    Parameters:
    
    key - the key of the variable to set
    
    value - the value of the variable to set at the specified key. A null value will remove this custom variable
  - setPageCustomVariable
```
public void setPageCustomVariable(CustomVariable customVariable,
                                  int index)
```
    Set a page custom variable at the specified index.
    
    Parameters:
    
    customVariable - the CustomVariable to set. A null value will remove the CustomVariable at the specified index
    
    index - the index of he CustomVariable to set
  - getPluginDirector
```
public Boolean getPluginDirector()
```
    Check if the visitor has the Director plugin.
    
    Returns:
    
    true if visitor has the Director plugin
  - setPluginDirector
```
public void setPluginDirector(Boolean director)
```
    Set if the visitor has the Director plugin.
    
    Parameters:
    
    director - true if the visitor has the Director plugin
  - getPluginFlash
```
public Boolean getPluginFlash()
```
    Check if the visitor has the Flash plugin.
    
    Returns:
    
    true if the visitor has the Flash plugin
  - setPluginFlash
```
public void setPluginFlash(Boolean flash)
```
    Set if the visitor has the Flash plugin.
    
    Parameters:
    
    flash - true if the visitor has the Flash plugin
  - getPluginGears
```
public Boolean getPluginGears()
```
    Check if the visitor has the Gears plugin.
    
    Returns:
    
    true if the visitor has the Gears plugin
  - setPluginGears
```
public void setPluginGears(Boolean gears)
```
    Set if the visitor has the Gears plugin.
    
    Parameters:
    
    gears - true if the visitor has the Gears plugin
  - getPluginJava
```
public Boolean getPluginJava()
```
    Check if the visitor has the Java plugin.
    
    Returns:
    
    true if the visitor has the Java plugin
  - setPluginJava
```
public void setPluginJava(Boolean java)
```
    Set if the visitor has the Java plugin.
    
    Parameters:
    
    java - true if the visitor has the Java plugin
  - getPluginPDF
```
public Boolean getPluginPDF()
```
    Check if the visitor has the PDF plugin.
    
    Returns:
    
    true if the visitor has the PDF plugin
  - setPluginPDF
```
public void setPluginPDF(Boolean pdf)
```
    Set if the visitor has the PDF plugin.
    
    Parameters:
    
    pdf - true if the visitor has the PDF plugin
  - getPluginQuicktime
```
public Boolean getPluginQuicktime()
```
    Check if the visitor has the Quicktime plugin.
    
    Returns:
    
    true if the visitor has the Quicktime plugin
  - setPluginQuicktime
```
public void setPluginQuicktime(Boolean quicktime)
```
    Set if the visitor has the Quicktime plugin.
    
    Parameters:
    
    quicktime - true if the visitor has the Quicktime plugin
  - getPluginRealPlayer
```
public Boolean getPluginRealPlayer()
```
    Check if the visitor has the RealPlayer plugin.
    
    Returns:
    
    true if the visitor has the RealPlayer plugin
  - setPluginRealPlayer
```
public void setPluginRealPlayer(Boolean realPlayer)
```
    Set if the visitor has the RealPlayer plugin.
    
    Parameters:
    
    realPlayer - true if the visitor has the RealPlayer plugin
  - getPluginSilverlight
```
public Boolean getPluginSilverlight()
```
    Check if the visitor has the Silverlight plugin.
    
    Returns:
    
    true if the visitor has the Silverlight plugin
  - setPluginSilverlight
```
public void setPluginSilverlight(Boolean silverlight)
```
    Set if the visitor has the Silverlight plugin.
    
    Parameters:
    
    silverlight - true if the visitor has the Silverlight plugin
  - getPluginWindowsMedia
```
public Boolean getPluginWindowsMedia()
```
    Check if the visitor has the Windows Media plugin.
    
    Returns:
    
    true if the visitor has the Windows Media plugin
  - setPluginWindowsMedia
```
public void setPluginWindowsMedia(Boolean windowsMedia)
```
    Set if the visitor has the Windows Media plugin.
    
    Parameters:
    
    windowsMedia - true if the visitor has the Windows Media plugin
  - getRandomValue
```
public String getRandomValue()
```
    Get the random value for this request
    
    Returns:
    
    the random value
  - setRandomValue
```
public void setRandomValue(String randomValue)
```
    Set a random value that is generated before each request. Using it helps avoid the tracking request being cached by the browser or a proxy.
    
    Parameters:
    
    randomValue - the random value to set. A null value will remove this parameter
  - getReferrerUrl
```
public URL getReferrerUrl()
```
    Get the referrer url
    
    Returns:
    
    the referrer url
    
    Throws:
    
    TypeConstraintException - if the stored Referrer URL is a String
  - getReferrerUrlAsString
```
public String getReferrerUrlAsString()
```
    Get the referrer url
    
    Returns:
    
    the referrer url
    
    Throws:
    
    TypeConstraintException - if the stored Referrer URL is a URL
  - setReferrerUrl
```
public void setReferrerUrl(URL referrerUrl)
```
    Set the full HTTP Referrer URL. This value is used to determine how someone got to your website (ie, through a website, search engine or campaign).
    
    Parameters:
    
    referrerUrl - the referrer url to set. A null value will remove this parameter
  - setReferrerUrlWithString
```
public void setReferrerUrlWithString(String referrerUrl)
```
    Set the full HTTP Referrer URL. This value is used to determine how someone got to your website (ie, through a website, search engine or campaign).
    
    Parameters:
    
    referrerUrl - the referrer url to set. A null value will remove this parameter
  - getRequestDatetime
```
public PiwikDate getRequestDatetime()
```
    Get the datetime of the request
    
    Returns:
    
    the datetime of the request
  - setRequestDatetime
```
public void setRequestDatetime(PiwikDate datetime)
```
    Set the datetime of the request (normally the current time is used). This can be used to record visits and page views in the past. The datetime must be sent in UTC timezone. Note: if you record data in the past, you will need to force Piwik to re-process reports for the past dates. If you set the Request Datetime to a datetime older than four hours then Auth Token must be set. If you set Request Datetime with a datetime in the last four hours then you don't need to pass Auth Token.
    
    Parameters:
    
    datetime - the datetime of the request to set. A null value will remove this parameter
  - getRequired
```
public Boolean getRequired()
```
    Get if this request will be tracked.
    
    Returns:
    
    true if request will be tracked
  - setRequired
```
public void setRequired(Boolean required)
```
    Set if this request will be tracked by the Piwik server.
    
    Parameters:
    
    required - true if request will be tracked
  - getResponseAsImage
```
public Boolean getResponseAsImage()
```
    Get if the response will be an image.
    
    Returns:
    
    true if the response will be an an image
  - setResponseAsImage
```
public void setResponseAsImage(Boolean responseAsImage)
```
    Set if the response will be an image. If set to false, Piwik will respond with a HTTP 204 response code instead of a GIF image. This improves performance and can fix errors if images are not allowed to be obtained directly (eg Chrome Apps). Available since Piwik 2.10.0.
    
    Parameters:
    
    responseAsImage - true if the response will be an image
  - getSearchCategory
```
public String getSearchCategory()
```
    Get the search category
    
    Returns:
    
    the search category
  - setSearchCategory
```
public void setSearchCategory(String searchCategory)
```
    Specify a search category with this parameter. SearchQuery must first be set.
    
    Parameters:
    
    searchCategory - the search category to set. A null value will remove this parameter
  - getSearchQuery
```
public String getSearchQuery()
```
    Get the search query.
    
    Returns:
    
    the search query
  - setSearchQuery
```
public void setSearchQuery(String searchQuery)
```
    Set the search query. When specified, the request will not be tracked as a normal pageview but will instead be tracked as a Site Search request.
    
    Parameters:
    
    searchQuery - the search query to set. A null value will remove this parameter
  - getSearchResultsCount
```
public Long getSearchResultsCount()
```
    Get the search results count.
    
    Returns:
    
    the search results count
  - setSearchResultsCount
```
public void setSearchResultsCount(Long searchResultsCount)
```
    We recommend to set the search count to the number of search results displayed on the results page. When keywords are tracked with Search Results Count=0 they will appear in the "No Result Search Keyword" report. SearchQuery must first be set.
    
    Parameters:
    
    searchResultsCount - the search results count to set. A null value will remove this parameter
  - getSiteId
```
public Integer getSiteId()
```
    Get the id of the website we're tracking.
    
    Returns:
    
    the id of the website
  - setSiteId
```
public void setSiteId(Integer siteId)
```
    Set the ID of the website we're tracking a visit/action for.
    
    Parameters:
    
    siteId - the id of the website to set. A null value will remove this parameter
  - getTrackBotRequests
```
public Boolean getTrackBotRequests()
```
    Set if bot requests should be tracked
    
    Returns:
    
    true if bot requests should be tracked
  - setTrackBotRequests
```
public void setTrackBotRequests(Boolean trackBotRequests)
```
    By default Piwik does not track bots. If you use the Tracking Java API, you may be interested in tracking bot requests. To enable Bot Tracking in Piwik, set Track Bot Requests to true.
    
    Parameters:
    
    trackBotRequests - true if bot requests should be tracked
  - getUserCustomVariable
```
@Deprecated
public String getUserCustomVariable(String key)
```
    Deprecated. Use the getVisitCustomVariable(int) method instead.
    
    Get the visit custom variable at the specified key.
    
    Parameters:
    
    key - the key of the variable to get
    
    Returns:
    
    the variable at the specified key, null if key is not present
  - getVisitCustomVariable
```
public CustomVariable getVisitCustomVariable(int index)
```
    Get the visit custom variable at the specified index.
    
    Parameters:
    
    index - the index of the variable to get
    
    Returns:
    
    the variable at the specified index, null if nothing at this index
  - setUserCustomVariable
```
@Deprecated
public void setUserCustomVariable(String key,
                                              String value)
```
    Deprecated. Use the setVisitCustomVariable(CustomVariable, int) method instead.
    
    Set a visit custom variable with the specified key and value at the first available index. All visit custom variables with this key will be overwritten or deleted
    
    Parameters:
    
    key - the key of the variable to set
    
    value - the value of the variable to set at the specified key. A null value will remove this parameter
  - setVisitCustomVariable
```
public void setVisitCustomVariable(CustomVariable customVariable,
                                   int index)
```
    Set a user custom variable at the specified key.
    
    Parameters:
    
    customVariable - the CustomVariable to set. A null value will remove the custom variable at the specified index
    
    index - the index to set the customVariable at.
  - getUserId
```
public String getUserId()
```
    Get the user id for this request.
    
    Returns:
    
    the user id
  - setUserId
```
public void setUserId(String userId)
```
    Set the user id for this request. User id is any non empty unique string identifying the user (such as an email address or a username). To access this value, users must be logged-in in your system so you can fetch this user id from your system, and pass it to Piwik. The user id appears in the visitor log, the Visitor profile, and you can Segment reports for one or several user ids. When specified, the user id will be "enforced". This means that if there is no recent visit with this user id, a new one will be created. If a visit is found in the last 30 minutes with your specified user id, then the new action will be recorded to this existing visit.
    
    Parameters:
    
    userId - the user id to set. A null value will remove this parameter
  - getVisitorCity
```
public String getVisitorCity()
```
    Get the visitor's city.
    
    Returns:
    
    the visitor's city
  - setVisitorCity
```
public void setVisitorCity(String city)
```
    Set an override value for the city. The name of the city the visitor is located in, eg, Tokyo. AuthToken must first be set.
    
    Parameters:
    
    city - the visitor's city to set. A null value will remove this parameter
  - getVisitorCountry
```
public PiwikLocale getVisitorCountry()
```
    Get the visitor's country.
    
    Returns:
    
    the visitor's country
  - setVisitorCountry
```
public void setVisitorCountry(PiwikLocale country)
```
    Set an override value for the country. AuthToken must first be set.
    
    Parameters:
    
    country - the visitor's country to set. A null value will remove this parameter
  - getVisitorCustomId
```
public String getVisitorCustomId()
```
    Get the visitor's custom id.
    
    Returns:
    
    the visitor's custom id
  - setVisitorCustomId
```
public void setVisitorCustomId(String visitorCustomId)
```
    Set a custom visitor ID for this request. You must set this value to exactly a 16 character hexadecimal string (containing only characters 01234567890abcdefABCDEF). We recommended to set the UserId rather than the VisitorCustomId.
    
    Parameters:
    
    visitorCustomId - the visitor's custom id to set. A null value will remove this parameter
  - getVisitorFirstVisitTimestamp
```
public Long getVisitorFirstVisitTimestamp()
```
    Get the timestamp of the visitor's first visit.
    
    Returns:
    
    the timestamp of the visitor's first visit
  - setVisitorFirstVisitTimestamp
```
public void setVisitorFirstVisitTimestamp(Long timestamp)
```
    Set the UNIX timestamp of this visitor's first visit. This could be set to the date where the user first started using your software/app, or when he/she created an account. This parameter is used to populate the Goals > Days to Conversion report.
    
    Parameters:
    
    timestamp - the timestamp of the visitor's first visit to set. A null value will remove this parameter
  - getVisitorId
```
public String getVisitorId()
```
    Get the visitor's id.
    
    Returns:
    
    the visitor's id
  - setVisitorId
```
public void setVisitorId(String visitorId)
```
    Set the unique visitor ID, must be a 16 characters hexadecimal string. Every unique visitor must be assigned a different ID and this ID must not change after it is assigned. If this value is not set Piwik will still track visits, but the unique visitors metric might be less accurate.
    
    Parameters:
    
    visitorId - the visitor id to set. A null value will remove this parameter
  - getVisitorIp
```
public String getVisitorIp()
```
    Get the visitor's ip.
    
    Returns:
    
    the visitor's ip
  - setVisitorIp
```
public void setVisitorIp(String visitorIp)
```
    Set the override value for the visitor IP (both IPv4 and IPv6 notations supported). AuthToken must first be set.
    
    Parameters:
    
    visitorIp - the visitor's ip to set. A null value will remove this parameter
  - getVisitorLatitude
```
public Double getVisitorLatitude()
```
    Get the visitor's latitude.
    
    Returns:
    
    the visitor's latitude
  - setVisitorLatitude
```
public void setVisitorLatitude(Double latitude)
```
    Set an override value for the visitor's latitude, eg 22.456. AuthToken must first be set.
    
    Parameters:
    
    latitude - the visitor's latitude to set. A null value will remove this parameter
  - getVisitorLongitude
```
public Double getVisitorLongitude()
```
    Get the visitor's longitude.
    
    Returns:
    
    the visitor's longitude
  - setVisitorLongitude
```
public void setVisitorLongitude(Double longitude)
```
    Set an override value for the visitor's longitude, eg 22.456. AuthToken must first be set.
    
    Parameters:
    
    longitude - the visitor's longitude to set. A null value will remove this parameter
  - getVisitorPreviousVisitTimestamp
```
public Long getVisitorPreviousVisitTimestamp()
```
    Get the timestamp of the visitor's previous visit.
    
    Returns:
    
    the timestamp of the visitor's previous visit
  - setVisitorPreviousVisitTimestamp
```
public void setVisitorPreviousVisitTimestamp(Long timestamp)
```
    Set the UNIX timestamp of this visitor's previous visit. This parameter is used to populate the report Visitors > Engagement > Visits by days since last visit.
    
    Parameters:
    
    timestamp - the timestamp of the visitor's previous visit to set. A null value will remove this parameter
  - getVisitorRegion
```
public String getVisitorRegion()
```
    Get the visitor's region.
    
    Returns:
    
    the visitor's region
  - setVisitorRegion
```
public void setVisitorRegion(String region)
```
    Set an override value for the region. Should be set to the two letter region code as defined by MaxMind's GeoIP databases. See here for a list of them for every country (the region codes are located in the second column, to the left of the region name and to the right of the country code).
    
    Parameters:
    
    region - the visitor's region to set. A null value will remove this parameter
  - getVisitorVisitCount
```
public Integer getVisitorVisitCount()
```
    Get the count of visits for this visitor.
    
    Returns:
    
    the count of visits for this visitor
  - setVisitorVisitCount
```
public void setVisitorVisitCount(Integer visitorVisitCount)
```
    Set the current count of visits for this visitor. To set this value correctly, it would be required to store the value for each visitor in your application (using sessions or persisting in a database). Then you would manually increment the counts by one on each new visit or "session", depending on how you choose to define a visit. This value is used to populate the report Visitors > Engagement > Visits by visit number.
    
    Parameters:
    
    visitorVisitCount - the count of visits for this visitor to set. A null value will remove this parameter
  - getQueryString
```
public String getQueryString()
```
    Get the query string represented by this object.
    
    Returns:
    
    the query string represented by this object
  - getUrlEncodedQueryString
```
public String getUrlEncodedQueryString()
```
    Get the url encoded query string represented by this object.
    
    Returns:
    
    the url encoded query string represented by this object
  - getRandomHexString
```
public static String getRandomHexString(int length)
```
    Get a random hexadecimal string of a specified length.
    
    Parameters:
    
    length - length of the string to produce
    
    Returns:
    
    a random string consisting only of hexadecimal characters

Class PiwikRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_LENGTH

AUTH_TOKEN_LENGTH

Constructor Detail

PiwikRequest

Method Detail

getActionName

setActionName

getActionTime

setActionTime

getActionUrl

getActionUrlAsString

setActionUrl

setActionUrlWithString

getApiVersion

setApiVersion

getAuthToken

setAuthToken

verifyAuthTokenSet

getCampaignKeyword

setCampaignKeyword

getCampaignName

setCampaignName

getCharacterSet

setCharacterSet

getContentInteraction

setContentInteraction

getContentName

setContentName

getContentPiece

setContentPiece

getContentTarget

getContentTargetAsString

setContentTarget

setContentTargetWithString

getCurrentHour

setCurrentHour

getCurrentMinute

setCurrentMinute

getCurrentSecond

setCurrentSecond

getCustomTrackingParameter

setCustomTrackingParameter

addCustomTrackingParameter

clearCustomTrackingParameter

getDeviceResolution

setDeviceResolution

getDownloadUrl

getDownloadUrlAsString

setDownloadUrl

setDownloadUrlWithString

enableEcommerce

verifyEcommerceEnabled

verifyEcommerceState

getEcommerceDiscount

setEcommerceDiscount

getEcommerceId

setEcommerceId

getEcommerceItem

addEcommerceItem

clearEcommerceItems

getEcommerceLastOrderTimestamp

setEcommerceLastOrderTimestamp

getEcommerceRevenue

setEcommerceRevenue

getEcommerceShippingCost

setEcommerceShippingCost

getEcommerceSubtotal

setEcommerceSubtotal

getEcommerceTax

setEcommerceTax

getEventAction

setEventAction

getEventCategory

setEventCategory