Leanplum Connector Setup Guide
This article describes how to set up the Leanplum connector.
API Information
This connector uses the following vendor API:
- API Name: Leanplum API
- API Version: v1.0
- API Endpoint:
https://api.leanplum.com/api - Documentation: Leanplum API
Connector Actions
| Action Name | AudienceStream | EventStream |
|---|---|---|
| Send Multi Request (Batched) | ✓ | ✓ |
| Set User Attributes | ✓ | ✓ |
| Send Message | ✓ | ✓ |
| Track Event | ✓ | ✓ |
Configure Settings
Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.
After adding the connector, configure the following settings:
- App ID: The application ID. To find yours, select your app in the navigation column, and click Manage Apps. Then click Keys & Settings.
- API Version: The version of the Leanplum API to use.
- Client Key: Production key for your Leanplum App.
Actions
Enter a name for the action and select the action type from the drop-down menu.
This section describes how to set up parameters and options for each action.
Send Multi Request (Batched)
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met:
- Max number of requests: 50
- Max time since oldest request: 10 minutes
- Max size of requests: 1 MB
Parameters
| Parameter | Description |
|---|---|
| Action | API Action |
| Time | The time at which the request was issued (UNIX time). This is used to resolve the time difference between Leanplum and the API caller when computing the times of events. |
| User ID | The current user ID. You can set this to whatever your company uses for user IDs. Leave it blank to use the device ID. For more info, see selecting a user. |
| Device ID | The unique ID for the device. |
| App ID | The application ID. To find yours, select your app in the navigation column, and click Manage Apps. Then click Keys & Settings. |
| API Version | The version of the Leanplum API to use. |
| Create Disposition | The policy that determines whether users are created by the API. The default value for this method is CreateIfNeeded. Possible values are:
|
| Dev Mode | Whether the user is in Development Mode (the user associated with the request is a developer and not a user). This is important for reporting purposes. Default value: false. |
| Event | The name of the event. Use “Purchase” to identify a monetization event, with the event value being the revenue. |
| Message ID | The message ID this event is associated with. Set this to track a user’s interaction with a message. To track a message Send or a View, set the event argument to an empty string. |
| Disposition | Determines how tracked events affect sessions and user activity. If present, the disposition must have one of the following values:
|
| Force | Whether to send the message regardless of whether the user meets the targeting criteria. Default: false. |
| Created | The time at which the user was created, in seconds since midnight UTC on January 1, 1970. |
| Last Active | The time at which the user was last active, in seconds since midnight UTC on January 1, 1970. |
| Total Sessions | The total number of sessions that a user has had in their lifetime. |
| Time Spent In App | The total number of seconds spent in the app in the user’s lifetime. |
| Locale | The current locale the user is in. Example: en_US. |
| Country | The country the user is in, specified by ISO 2-letter code. Example: US for United States. Set to (detect) to detect the country based on the IP address of the user. |
| Region | The region (state) the user is in. Example: ca for California. Set to (detect) to detect the region based on the IP address of the user. |
| City | The city the user is in. Example: San Francisco. Set to (detect) to detect the city based on the IP address of the user. |
| Location | The location (latitude/longitude) of the user. Example: 37.775,-122.4183. Set to (detect) to detect the location based on the IP address of the user. |
| Location Accuracy Type | The type of location that is provided (IP, CELL, or GPS). Default: IP. |
| Timezone | The timezone abbreviation for the user. See list of timezone abbreviations. |
| Timezone Offset Seconds | The timezone offset from GMT in seconds. |
| User Attributes | A map of user attributes as key-value pairs. Each key must be a string. Attributes are saved across sessions. Only supplied attributes will be updated (for example, if you omit an existing attribute, it will be preserved). |
| User Attribute Values To Add | A map of values to add to existing user attribute sets. For example, supply {“Interests”:“Sports”} to add Sports to the existing set of Interests. |
| Value | The event value. For example, for a purchase event, this would be the purchase price. |
| Currency Code | The ISO 4217 currency code associated with value. Leanplum will automatically convert value into your preferred currency, while retaining the original price and currency code as event parameters localCurrency and localPrice. Currency conversion rates are updated every hour. |
| Time | Option to provide the UNIX timestamp for when the event occurred, which may be different from the current time. |
| Info | Any info attached to the event. |
| Parameters | A flat object of parameters as key-value pairs. Each key must be a string, and up to 50 parameters may be set. |
| Values | A JSON object of key-value pairs to override template variables used in the message. |
Set User Attributes
Parameters
| Parameter | Description |
|---|---|
| User ID | The current user ID. You can set this to whatever your company uses for user IDs. Leave it blank to use the device ID. For more info, see selecting a user. |
| Device ID | The unique ID for the device. |
| User Attributes | A map of user attributes as key-value pairs. Each key must be a string. Attributes are saved across sessions. Only supplied attributes will be updated (for example, if you omit an existing attribute, it will be preserved). |
| App ID | The application ID. To find yours, select your app in the navigation column, and click Manage Apps. Then click Keys & Settings. |
| API Version | The version of the Leanplum API to use. |
| Create Disposition | The policy that determines whether users are created by the API. The default value for this method is CreateIfNeeded. Possible values are:
|
| User Attribute Values To Add | A map of values to add to existing user attribute sets. For example, supply {“Interests”:“Sports”} to add Sports to the existing set of Interests. |
| Dev Mode | Whether the user is in Development Mode, for example, the user associated with the request is a developer and not a user. This is important for reporting purposes. Default: false. |
| Created | The time at which the user was created, in seconds since midnight UTC on January 1, 1970. |
| Last Active | The time at which the user was last active, in seconds since midnight UTC on January 1, 1970. |
| Total Sessions | The total number of sessions that a user has had in their lifetime. |
| Time Spent In App | The total number of seconds spent in the app in the user’s lifetime. |
| Locale | The current locale the user is in. Example: en_US. |
| Country | The country the user is in, specified by ISO 2-letter code. Example: US for United States. Set to (detect) to detect the country based on the IP address of the user. |
| Region | The region (state) the user is in. Example: ca for California. Set to (detect) to detect the region based on the IP address of the user. |
| City | The city the user is in. Example: San Francisco. Set to (detect) to detect the city based on the IP address of the user. |
| Location | The location (latitude/longitude) of the user. Example: 37.775,-122.4183. Set to (detect) to detect the location based on the IP address of the user. |
| Location Accuracy Type | The type of location that is provided (IP, CELL, or GPS). Default: IP. |
| Timezone | The timezone abbreviation for the user. See list of timezone abbreviations. |
| Timezone Offset Seconds | The timezone offset from GMT in seconds. |
Track Event
Parameters
| Parameter | Description |
|---|---|
| User ID | The current user ID. You can set this to whatever your company uses for user IDs. Leave it blank to use the device ID. For more info, see selecting a user. |
| Device ID | The unique ID for the device. |
| Event | The name of the event. Use “Purchase” to identify a monetization event, with the event value being the revenue. |
| App ID | The application ID. To find yours, select your app in the navigation column, and click Manage Apps. Then click Keys & Settings. |
| API Version | The version of the Leanplum API to use. |
| Create Disposition | The policy that determines whether users are created by the API. The default value for this method is CreateIfNeeded. Possible values are:
|
| Dev Mode | Whether the user is in Development Mode, for example, the user associated with the request is a developer and not a user. This is important for reporting purposes. Default: false. |
| Value | The event value. For example, for a purchase event, this would be the purchase price. |
| Currency Code | The ISO 4217 currency code associated with value. Leanplum will automatically convert value into your preferred currency, while retaining the original price and currency code as event parameters localCurrency and localPrice. Currency conversion rates are updated every hour. |
| Time | Option to provide the UNIX timestamp for when the event occurred, which may be different from the current time. |
| Info | Any info attached to the event. |
| Parameters | A flat object of parameters as key-value pairs. Each key must be a string, and up to 50 parameters may be set. |
| Message ID | The message ID this event is associated with. Set this to track a user’s interaction with a message. To track a message Send or a View, set the event argument to an empty string. |
| Disposition | Determines how tracked events affect sessions and user activity. If present, the disposition must have one of the following values:
|
Send Message
Parameters
| Parameter | Description |
|---|---|
| User ID | The current user ID. You can set this to whatever your company uses for user IDs. Leave it blank to use the device ID. For more info, see selecting a user. |
| Device ID | The unique ID for the device. |
| Message ID | The ID of the message, found in the URL when viewing a message (for example, www.leanplum.com/dashboard#/{APP_ID}/messaging/{MESSAGE_ID}). |
| App ID | The application ID. To find yours, select your app in the navigation column, and click Manage Apps. Then click Keys & Settings. |
| API Version | The version of the Leanplum API to use. |
| Create Disposition | The policy that determines whether users are created by the API. The default value for this method is CreateIfNeeded. Possible values are:
|
| Dev Mode | Whether the user is in Development Mode, for example, the user associated with the request is a developer and not a user. This is important for reporting purposes. Default: false. |
| Values | A JSON object of key-value pairs to override template variables used in the message. |
| Force | Whether to send the message regardless of whether the user meets the targeting criteria. Default: false. |
This page was last updated: November 7, 2020