- iOS
- Android
-
Unity
- Overview
- Getting Started
- Content Units
- Push Notifications
- Advanced
-
Method Reference
- deregisterForPushNotifications
- getContentBadgeNumber
- getOptOutStatus
- getPluginVersion
- init
- preloadContentRequest
- registerForPushNotifications
- reportCustomEvent
- requestAppOpen
- sendContentRequest
- sendContentRequestWithContentUnitID
- setLogLevel
- setOptOutStatus
- setShouldOpenContentRequestsFromPushNotifications
- setShouldOpenUrlsFromPushNotifications
- trackInAppPurchase [iOS]
- trackInAppPurchase [Android]
- trackInAppPurchase [Android VGP]
-
Event Reference
- badgeCountRequestFailedEvent
- badgeCountRequestSucceededEvent
- contentDidDisplayEvent
- contentDismissedEvent
- contentPreloadFailedEvent
- contentPreloadSucceededEvent
- contentRequestFailedEvent
- contentRequestLoadedEvent
- contentWillDisplayEvent
- makePurchaseEvent
- openRequestFailedEvent
- openRequestSucceededEvent
- pushNotificationWithContentReceivedEvent
- pushNotificationWithUrlReceivedEvent
- reportCustomEventFailedEvent
- reportCustomEventSucceededEvent
- trackInAppPurchaseSucceededEvent
- trackInAppPurchaseFailedEvent
- unlockedRewardEvent
- Legacy PlayHaven Migration
- Troubleshooting
- Integration Checklist
- Enterprise iOS
- Enterprise Android
- Enterprise Unity
- Enterprise PHP
- Enterprise JavaScript
- Enterprise Facebook
- Data Collection API
- Processed Data API
- Downloading Raw Data Files
- Marketing Reporting API
- Upsight SDKs
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
| Parameter | Type | Description |
|---|---|---|
$apiKey | string | Your application's Upsight API key. |
Optional Parameters
| Parameter | Type | Description |
|---|---|---|
$optionalParams | string | An associative array containing paramName => value. |
$optionalParams['useTestServer'] | bool | Determines 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'] | bool | Determines if data is sent to the Upsight servers using HTTPS. |
$optionalParams['validateParams'] | bool | Determines 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. |