Teak Features

Login

Teak’s functionality depends on knowing when a user plays and on what device they play.

At every game launch, send the player’s ID to Teak using login:withConfiguration:

Example

// ...
let playerConfiguration = TeakUserConfiguration()
Teak.login(YOUR_PLAYER_ID, with:playerConfiguration)

Make sure that your player ID is a unique ID for the player in your game.

What Player ID should you use?

Your game probably has a user ID to store progress, coin balances, and other useful data. Use that ID with Teak too.

It should uniquely identify the current player.
Ideally the same ID that is used in your game’s backend.
Send it as early as possible in the game’s lifecycle.

Having a consistent ID between your game makes customer support easier, and makes life easier for your analytics team.

Player Configuration

Additional data, such as a player’s email address and Facebook ID, can be passed to Teak by setting the appropriate fields on the TeakUserConfiguration object passed to login:withConfiguration:

If you need to update any of this additional data during a game session, call Teak.login() with an appropriately configured TeakUserConfiguration object. Teak.login() will never clear or remove information about a player, and fields that are not set on the TeakUserConfiguration object will be ignored.

Providing Additional Data Example

// ....
let playerConfiguration = TeakUserConfiguration()
playerConfiguration.email = "YOUR_PLAYER_EMAIL"
playerConfiguration.facebookId = "YOUR_PLAYER_FACEBOOK_ID"
Teak.login("YOUR_PLAYER_ID", with:playerConfiguration)

Rewards

Whenever your game should grant a reward to a player Teak will let you know by posting a notification to the default notification center with the name Notification.Name(TeakOnReward)

Teak does not provide any in-game UI to inform a player if they received a reward or not. You should add a an observor for the Notification.Name(TeakOnReward) notification which detects if the reward was granted or denied, and informs the player what happened.

This callback will be concurrent with the Teak Reward Endpoint server to server call.

Example Reward Listener

NotificationCenter.default.addObserver(forName: Notification.Name(TeakOnReward), object: nil, queue: nil, using:{notification in
    let rewardStatus = notification.userInfo!["status"] as! String
    switch rewardStatus {
    case "grant_reward":
        let reward = notification.userInfo!["reward"]! as! Dictionary<String, NSNumber>
        print("Reward Granted! \(reward)")
    case "already_clicked":
        print("You already claimed this reward!")
    case "expired":
        print("The reward has expired")
    case "too_many_clicks":
        print("Too many other players already claimed this reward")
    case "exceed_max_clicks_for_day":
        print("You've already claimed too many rewards today")
    case "not_for_you":
        print("This reward is restricted to a different player")
    case "invalid_post":
        print("The reward id was not recognized"
    default:
        print("Unknown status")
    }
})

Request Notification Permissions

To use push notifications you are required to ask the player if you can send them notifications. Do that with the [registerForNotificaitons:] call.

Permissions Example

// ...
Teak.requestNotificationPermissions({accepted, error in
    print("User accepted notifications: \(accepted)");
})

You can still make this call even if the player cannot be prompted for permissions again. In that case the callback will be called with the current notification state.

Player Properties

Player Properties are strings or numbers associated with each player of your game in Teak. Player Properties have several uses, including:

Targeting players for a send by using the player properties Audience rule
Personalizing push notification content using custom tags
Personalizing email content using custom tags
Personalizing deep links from Links, push notifications, and emails to take players to a meaningful location in your game

You do not need to register the property in the Teak Dashboard prior to sending them from your game, however you will need to register them in the Teak Dashboard before using them in targeting. Only Player Properties set to permit client updates can be updated through the SDK. Player Properties set to permit server updates may only be updated through the Server API.

Number Property

To set a number property, use: setNumberProperty:value:

Example

Teak.setNumberProperty("bankroll", value: newCoinBalance)

Number Player Properties can store values between -999999999999999999999999999.999999999 and 999999999999999999999999999.999999999.

String Property

To set a string property, use: setStringProperty:value:

Example

Teak.setStringProperty("last_slot", value: "amazing_slot_name");

String Player Properties can store up to 16,384 unicode characters (including emoji).

Deep Links

Deep Links are a way to link to specific screens in your game that will open when the game is launched from a notification or Universal Link.

These are useful for promoting new content or linking directly to sale content in the game.

For the marketing team to use Deep Links, they will have to add the URL to their notifications in the dashboard. So, keep a master list of active deep links that can be shared with your team, so everyone knows what is available for use.

Deep Linking with Teak is based on routes, which act like URLs. Route patterns may include named parameters, allowing you to pass in additional data.

Add routes using: registerDeepLinkRoute:name:description:block:

You need to register your deep link routes before you call Teak.login().

Example

Teak.registerDeepLinkRoute("/store/:sku", name: "Store", description: "Open the store to the given SKU", block: {params in
    print("Taking the player to \(params["sku"]!)")
})

How Routes Work

Routes work like URLs where parts of the path can be a variable. In the example above, the route is /store/:sku. Variables in the path are designated with :. So, in the route /store/:sku there is a variable named sku.

This means that if the deep link used to launch the app was /store/io.teak.test.dollar was used to open the app, it would call the function and assign the value io.teak.test.dollar to the key sku in the dictionary that is passed in.

This dictionary will also contain any URL query parameters. For example:

/store/io.teak.test.dollar?campaign=email

In this link, the value io.teak.test.dollar would be assigned to the key sku, and the value email would be assigned to the key campaign.

When Are Deep Links Executed

Deep links are passed to an application as part of the launch. The Teak SDK holds onto the deep link information and waits until your app has finished launching, and initializing. Deep links will be processed when your game calls Teak.login().

Using Deep Links

A Deep Link route may be added to any notification or email in the Advanced section when setting up a Message or Link. We recommend documenting what routes are implemented and how to use them, with examples, for your marketing team to add to notifications, emails, and links.

Session Attribution

Each time your game launches Teak will post a notification with all of the attribution data it has for the launch, if available, to the default notification center with the name Notification.Name(TeakPostLaunchSummary)

This callback will be called after your game calls [login:with:], and is primarily intended to assist in reporting session attribution to other analytics systems.

Example PostLaunchSummary Listener

NotificationCenter.default.addObserver(forName: Notification.Name(TeakPostLaunchSummary), object: nil, queue: nil, using:{notification in
    let channelName = notification.userInfo!["teakChannelName"] as! Optional<String>
    if(channelName == nil) {
        print("Launch not attributed to a Teak source")
        return
    }
    print("Launch attributed to \(channelName!)")
    print("Launch came from a click on \(notification.userInfo!["teakCreativeName"] as! String)")
    print("Launch was \(notification.userInfo!["teakRewardId"] as! NSObject == NSNull() ? "not" : "") rewarded")
})