1. Home
  2. Marketers
  3. Campaign Management
  4. Create a Frameplay — SAN Campaign
  1. Home
  2. Marketers
  3. Create a Frameplay — SAN Campaign

Create a Frameplay — SAN Campaign


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

  1. Log in to Kochava.
  2. Select the desired Account and App.
  3. Select Engagement > Campaign Manager.

Feature Note: To add this menu item to your Favorites Menu, select the “+” sign that appears when you hover over the menu. The Features Menu provides quick access to your most frequently visited areas of the Kochava UI.

  1. Click + Add (Tracker) or Select Segment Tools () > Add Tracker.
  2. Enter the Tracker Name.

NOTE: When a Tracker is created, Kochava automatically generates a name for the Tracker. We recommend that you replace the Tracker name at this point with a clear name of your choosing.

  1. Select Tracker Type > Acquisition. (default setting)
  2. Select Media Partner > Frameplay.
  3. Select Agency Partner. (optional)
  4. Enter the Destination URL.

NOTE: The Destination URL is not relevant and should simply be your website.

  1. Enter a Deep Link. (optional)
  2. Enter any Custom Parameter(s). (optional)
  3. Click Save. (If no further trackers need to be created)
  4. Click Save & Add Another Tracker. (If additional trackers need to be created)
  5. Click Save & Create Postback (to navigate directly to the Partner Configuration page).

Install Postback Configuration

  1. Select Apps & Assets > Partner Configuration.

Feature Note: To add this menu item to your Favorites Menu, select the “+” sign that appears when you hover over the menu. The Features Menu provides quick access to your most frequently visited areas of the Kochava UI.

  1. Click + Add a Configuration.
  2. Select Media Partner > Frameplay.
  3. Click Go.
  4. Select Install > 🖉 (Edit).
  5. Enter the Frameplay Measurement ID.
  6. Select the Event Name > first_open.
  7. 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.

NOTE: If a reengagement campaign does not need to be set up, but the data associated with post-install events needs to be sent to Frameplay — SAN follow the steps within the Create a Postback Section below.

NOTE: For all EXISTING apps on your account, view-through re-engagement attribution will be disabled by default. You will need to take the steps outlined in this support documentation to enable this capability. For all NEW apps you add to your account in the future, this feature will be enabled by default.

Create a Reengagement Segment:

  1. Locate the desired Campaign.
  2. Select Campaign Tools () > Add a Segment.
  3. Enter a Segment Name.
  4. Enter a Segment Description. (optional)
  5. Click Submit.

Create a Reengagement Tracker:

  1. Click + Add (Tracker) or Select Segment Tools () > Add Tracker.
  2. Enter a Tracker Name.
  3. Select Tracker Type > Reengagement.
  4. Select Media Partner > Frameplay.
  5. Select an Agency Partner. (optional)
  6. Select ALL the Frameplay Events (including _Install).

BEST PRACTICES: While multiple events can be added to the reengagement tracker it is highly recommended that only 1 event be added for each reengagmeent tracker.

NOTE: A Reengagement event can be added by clicking on the “+” and removed by clicking “X“.

  1. Click Save (If no further trackers need to be created).
  2. Click Save & Add Another Tracker (If additional events need to be created).
  3. Click Save & Create Postback (to navigate directly to the Partner Configuration page).

Post-Install Event Postback Configuration:

  1. Select Apps & Assets > Partner Configuration.

Feature Note: To add this menu item to your Favorites Menu, select the “+” sign that appears when you hover over the menu. The Features Menu provides quick access to your most frequently visited areas of the Kochava UI.

  1. Expand Frameplay Postbacks.
  2. Locate the desired event and Click + for a new configuration or 🖉 (Edit) for an existing configuration.
  3. Enter the Product ID.
  4. Select the Event Name.
  5. 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
}
Updated on November 21, 2024

Was this article helpful?