The following document describes how to set up a campaign for Frameplay — SAN. Kochava enhances your install and event data with the Frameplay — SAN ad impression or click metadata directly from Frameplay — SAN to allow for extremely accurate and complete data.
Data Needed Before Beginning Process:
- Frameplay Measurement ID
- Frameplay Event Name
Create a Tracker for a Frameplay — SAN Install Campaign
- Log in to Kochava.
- Select the desired Account and App.
- Select Engagement > Campaign Manager.
- Click + Add (Tracker) or Select Segment Tools (⋮) > Add Tracker.
- Enter the Tracker Name.
- Select Tracker Type > Acquisition. (default setting)
- Select Media Partner > Frameplay.
- Select Agency Partner. (optional)
- Enter the Destination URL.
- Enter a Deep Link. (optional)
- Enter any Custom Parameter(s). (optional)
- Click Save. (If no further trackers need to be created)
- Click Save & Add Another Tracker. (If additional trackers need to be created)
- Click Save & Create Postback (to navigate directly to the Partner Configuration page).
Install Postback Configuration
- Select Apps & Assets > Partner Configuration.
- Click + Add a Configuration.
- Select Media Partner > Frameplay.
- Click Go.
- Select Install > 🖉 (Edit).
- Enter the Frameplay Measurement ID.
- Select the Event Name > first_open.
- Click Save.
Reengagement Configuration
The information within this section provides the steps necessary to establish a reengagment campaign. If a reengagment campaign does not need to be created, the information in this section may be disregarded.
Create a Reengagement Segment:
- Locate the desired Campaign.
- Select Campaign Tools (⋮) > Add a Segment.
- Enter a Segment Name.
- Enter a Segment Description. (optional)
- Click Submit.
Create a Reengagement Tracker:
- Click + Add (Tracker) or Select Segment Tools (⋮) > Add Tracker.
- Enter a Tracker Name.
- Select Tracker Type > Reengagement.
- Select Media Partner > Frameplay.
- Select an Agency Partner. (optional)
- Select ALL the Frameplay Events (including _Install).
- Click Save (If no further trackers need to be created).
- Click Save & Add Another Tracker (If additional events need to be created).
- Click Save & Create Postback (to navigate directly to the Partner Configuration page).
Post-Install Event Postback Configuration:
- Select Apps & Assets > Partner Configuration.
- Expand Frameplay Postbacks.
- Locate the desired event and Click + for a new configuration or 🖉 (Edit) for an existing configuration.
- Enter the Product ID.
- Select the Event Name.
- Click Save.
Standard Post-Install Event List:
Key | Description |
---|---|
contact | Initiating communication or interaction with the app developer or support team. |
donate | Contributing funds or making a financial donation within the app. |
active_app | Denotes when a user actively engages with the app, such as opening it or performing any significant action within it. |
add_payment_info | User adding or updating their payment information within the app, often associated with making purchases. |
add_to_cart | Item has been added to cart. |
add_to_wishlist | Item has been added to wishlist. |
complete_registration | When a user completes a registration. |
content_view | The user has viewed the ad content. |
initiated_checkout | User has started checkout of items in cart. |
purchase | Item has been purchased. |
rate | User providing a rating or feedback for the app on app stores or within the app itself. |
search | User initiates a search query or performs a search action within the app’s interface. |
share_with_friend | Link shared with contact. |
sign_up | When a user completes an app sign up. |
spent_credits | User utilizing or spending virtual credits, points, or currency within the app. |
start_trial | When a user successfully signs up for a given trial product. |
submit_application | User submitting an application or form within the app, such as for membership, registration, or enrollment |
subscribe | When a user pays for a subscription within a 3 day lookback of exposure (impression) to a media campaign. |
Click and Impression Attribution Macros:
Click-through attribution, also known as click tracking, is the term used when a click leads to a user action within a certain attribution window. View-through attribution, also known as impression tracking, is the term used when an impression leads to a user action within a certain attribution window. The impression window is supported for 3 day lookback (impression inventory only) to meet your business needs.
URL Parameters | Description | Type |
---|---|---|
creative id | ID of the creative. | string |
campaign id | ID of the campaign. | string |
timestamp | Unix timestamp in seconds. | integer |
device id | ID of the device. | string |
ip | IP of click or impression (IPv4 and IPv6 supported). | string |
gamebundle id | ID of the game bundle. | string |
game id | ID of the game. | string |
Example Attribution Response
Match:
{
"success": true,
"attributionMode": "BMA",
"type": "impression",
"timestamp": "2020-12-15T01:00:54Z",
"metadata": {
"bundle_id": "coms.app.yourgame",
"game_id": "abc123",
"campaign_id": "abc123",
"creative_id": "abc123",
"creative_size": "16_9"
},
"match": {
"idfa": "FFF583CD-A667-48BC-B806-777CB2B48606",
}
}
No Match:
{
"success": false,
"attribution_mode": "BMA",
"type": null,
"metadata": null,
"match": null
}