Upsight logo Back to top

Helper Methods

Constructor


__construct Constructor class method.

Important This function returns the generated tracking tag as a string.

URL

This method does not wrap any Upsight Data Collection API call.

Required Parameters

ParameterTypeDescription
$apiKeystringYour application's Upsight API key.

Optional Parameters

ParameterTypeDescription
$optionalParamsstringAn associative array containing paramName => value.
$optionalParams['useTestServer']boolDetermines if data is sent to the Upsight Test or Production servers. For QA, use the Test server, and set this value as TRUE. To send data to Production, set this value as FALSE.
$optionalParams['useHttps']boolDetermines if data is sent to the Upsight servers using HTTPS.
$optionalParams['validateParams']boolDetermines if parameters passed into the tracking methods will be validated by Upsight servers. If set to TRUE, the tracking methods will return the appropriate error code into the $validationErrorMsg parameter in each method. If set to FALSE, no validation will be set and no error codes will be sent to the $validationErrorMsg parameter.

Unique Tracking Tag


genUniqueTrackingTag() Function to automatically generate a unique tracking tag. Unique tracking tags are used to correlate advertisement and partner link clicks with any user installs that occur through these channels.

Important! This function returns the generated tracking tag as a string.

URL

This method does not wrap any Upsight Data Collection API call.

Required Parameters

No required parameters.

Optional Parameters

No optional parameters.

Short Unique Tracking Tag


genShortUniqueTrackingTag() Function to automatically generate a short unique tracking tag. Unique tracking tags are used to correlate advertisement and partner link clicks with any user installs that occur through these channels.

Important! This function returns the generated tracking tag as a string.

URL

This method does not wrap any Upsight Data Collection API call.

Required Parameters

No required parameters.

Optional Parameters

No optional parameters.