sdk-telegram-mini-app

JS SDK for Telegram Mini App

Table of contents

• sdk-telegram-mini-app
  • Getting started
    • SDK initialization
    • For events registration
    • For send custom parameters about the user
    • For send one event with simplify syntax
    • Check status
  • List of available affise_event_name
  • List of available keys for affise_parameters
  • Example for ReactJS
  • Example for Angular
  • Events tracking
  • Custom events tracking
  • Predefined event parameters
    • PredefinedString
    • PredefinedLong
    • PredefinedFloat
    • PredefinedObject
    • PredefinedListObject
    • PredefinedListString

Getting started

Сonnect the script:

<script src="https://sdk.affisemmp.com/tg-mini-app.js"></script>

SDK initialization

AffiseMMP.init({
  affise_app_token: AFFISE_APP_TOKEN, // application token in affise mmp platform
})

AffiseMMP.init should be called after window.onload

For events registration

affise_event_name should be one from the list below

affise_parameters keys should be one from the list below

AffiseMMP.registerEvents([
    {
        "affise_event_name": "Order",
        "affise_parameters": {
            "affise_p_order_id": "23123",
            "affise_p_price": "2.19",
            "affise_p_quantity": 1
        }
    }
])

For send custom parameters about the user

"affise_p_param_01": window.Telegram?.WebApp?.initDataUnsafe?.user?.username || 'Unknown username',
"affise_p_param_02": window.Telegram?.WebApp?.initDataUnsafe?.user?.first_name || 'Unknown first_name',
"affise_p_param_03": window.Telegram?.WebApp?.initDataUnsafe?.user?.last_name || 'Unknown last_name',
"affise_p_param_04": window.Telegram?.WebApp?.initDataUnsafe?.user?.language_code || 'Unknown language_code',

For send one event with simplify syntax

AffiseMMP.sendEvent("Order", {
  "affise_p_order_id": "23123",
  "affise_p_price": "2.19",
  "affise_p_quantity": 1
})

Check status

Method AffiseMMP.checkStatus return Promise
To use this method you must have sent at least one event

AffiseMMP.checkStatus()
  .then((response) => response.json())

List of available affise_event_name

List

- AchieveLevel
- AddPaymentInfo
- AddToCart
- AddToWishlist
- AdRevenue
- ClickAdv
- CompleteRegistration
- CompleteStream
- CompleteTrial
- CompleteTutorial
- Contact
- ContentItemsView
- CustomizeProduct
- DeepLinked
- Donate
- FindLocation
- InitiateCheckout
- InitiatePurchase
- InitiateStream
- Invite
- LastAttributedTouch
- Lead
- ListView
- Login
- OpenedFromPushNotification
- Order
- OrderItemAdded
- OrderItemRemove
- OrderCancel
- OrderReturnRequest
- OrderReturnRequestCancel
- Purchase
- Rate
- ReEngage
- Reserve
- Sales
- Schedule
- Search
- Share
- SpendCredits
- StartRegistration
- StartTrial
- StartTutorial
- SubmitApplication
- Subscribe
- TravelBooking
- UnlockAchievement
- Unsubscribe
- Update
- ViewAdv
- ViewCart
- ViewContent
- ViewItem
- ViewItems
- InitialSubscription
- InitialTrial
- InitialOffer
- ConvertedTrial
- ConvertedOffer
- TrialInRetry
- OfferInRetry
- SubscriptionInRetry
- RenewedSubscription
- FailedSubscriptionFromRetry
- FailedOfferFromRetry
- FailedTrialFromRetry
- FailedSubscription
- FailedOfferise
- FailedTrial
- ReactivatedSubscription
- RenewedSubscriptionFromRetry
- ConvertedOfferFromRetry
- ConvertedTrialFromRetry
- Unsubscription

List of available keys for affise_parameters

• affise_p_achievement_id String
• affise_p_adrev_ad_type String
• affise_p_brand String
• affise_p_brick String
• affise_p_campaign_id String
• affise_p_catalogue_id String
• affise_p_channel_type String
• affise_p_city String
• affise_p_class String
• affise_p_click_id String
• affise_p_content String
• affise_p_content_id String
• affise_p_content_ids String
• affise_p_content_list String
• affise_p_content_name String
• affise_p_content_type String
• affise_p_conversion_id String
• affise_p_country String
• affise_p_coupon_code String
• affise_p_currency String
• affise_p_currency_rate Float64
• affise_p_customer_segment String
• affise_p_customer_type String
• affise_p_customer_user_id String
• affise_p_date_a DateTime
• affise_p_date_b DateTime
• affise_p_deep_link String
• affise_p_departing_arrival_date DateTime
• affise_p_departing_departure_date DateTime
• affise_p_description String
• affise_p_destination_a String
• affise_p_destination_b String
• affise_p_destination_list String
• affise_p_event_name String
• affise_p_event_start DateTime
• affise_p_event_end DateTime
• affise_p_hotel_score Int64
• affise_p_lat Float64
• affise_p_level Int64
• affise_p_long Float64
• affise_p_max_rating_value Int64
• affise_p_new_version String
• affise_p_num_adults Int64
• affise_p_num_children Int64
• affise_p_num_infants Int64
• affise_p_old_version String
• affise_p_order_id String
• affise_p_param_01 String
• affise_p_param_02 String
• affise_p_param_03 String
• affise_p_param_04 String
• affise_p_param_05 String
• affise_p_param_06 String
• affise_p_param_07 String
• affise_p_param_08 String
• affise_p_param_09 String
• affise_p_param_10 String
• affise_p_payment_info_available String
• affise_p_pid String
• affise_p_preferred_neighborhoods String
• affise_p_preferred_num_stops Int64
• affise_p_preferred_price_range Int64
• affise_p_preferred_star_ratings Int64
• affise_p_price Int64
• affise_p_product_id String
• affise_p_product_name String
• affise_p_purchase_currency String
• affise_p_purchase_currency_rate Float64
• affise_p_quantity Int64
• affise_p_rating_value Int64
• affise_p_receipt_id String
• affise_p_region String
• affise_p_registration_method String
• affise_p_returning_arrival_date DateTime
• affise_p_returning_departure_date DateTime
• affise_p_revenue Int64
• affise_p_review_text String
• affise_p_score Int64
• affise_p_search_string String
• affise_p_segment String
• affise_p_status String
• affise_p_subscription_id String
• affise_p_success String
• affise_p_suggested_destinations String
• affise_p_suggested_hotels String
• affise_p_travel_start DateTime
• affise_p_travel_end DateTime
• affise_p_tutorial_id String
• affise_p_user_score Int64
• affise_p_utm_campaign String
• affise_p_utm_medium String
• affise_p_utm_source String
• affise_p_validated String
• affise_p_virtual_currency_name String
• affise_p_vertical String
• affise_p_voucher_code String

Example for ReactJS

Add to index.html following code:

<script src="https://sdk.affisemmp.com/tg-mini-app.js"></script>

Example of init AffiseMMP and send event from React component:

function App() {
  AffiseMMP.init({
    affise_app_token: AFFISE_APP_TOKEN, // application token in affise mmp platform
  })

  return (
    <Page />
  )
}

function Page() {
  const handleSendEvent = () => {
    AffiseMMP.sendEvent("Order", {
      "affise_p_order_id": "23123",
      "affise_p_price": "2.19",
      "affise_p_quantity": 1
    })
  }

  return (
    <button onClick={handleSendEvent}>Click me for send event</button>
  )
}

Example for Angular

Example of init AffiseMMP and send event from Angular component:

import { Component, OnInit, Input } from '@angular/core';

@Component({
  selector: 'app-example',
  templateUrl: './example.component.html',
})
export class ExampleComponent implements OnInit {
  @Input() dependency: any;

  ngOnInit() {
    AffiseMMP.init({
      affise_app_token: AFFISE_APP_TOKEN, // application token in affise mmp platform
    })
  }
}

example.component.html

<button (click)="onButtonClick()">Click me for send event</button>

typescript

onButtonClick() {
    AffiseMMP.sendEvent("Order", {
      "affise_p_order_id": "23123",
      "affise_p_price": "2.19",
      "affise_p_quantity": 1
    })
}

Events tracking

Demo app DefaultEventsFactory.kt

For example, we want to track what items usually user adds to shopping cart. To send event first create it with following code

class Presenter {
  fun onUserAddsItemsToCart(userData: String) {
    AddToCartEvent(userData)
        .send() // Send event
  }
}

For java use:

class Presenter {
  void onUserAddsItemsToCart(String userData) {
    new AddToCartEvent(userData)
            .send(); // Send event
  }
}

With above example you can implement other events:

• AchieveLevel
• AddPaymentInfo
• AddToCart
• AddToWishlist
• AdRevenue
• ClickAdv
• CompleteRegistration
• CompleteStream
• CompleteTrial
• CompleteTutorial
• Contact
• ContentItemsView
• CustomizeProduct
• DeepLinked
• Donate
• FindLocation
• InitiateCheckout
• InitiatePurchase
• InitiateStream
• Invite
• LastAttributedTouch
• Lead
• ListView
• Login
• OpenedFromPushNotification
• Order
• OrderItemAdded
• OrderItemRemove
• OrderCancel
• OrderReturnRequest
• OrderReturnRequestCancel
• Purchase
• Rate
• ReEngage
• Reserve
• Sales
• Schedule
• Search
• Share
• SpendCredits
• StartRegistration
• StartTrial
• StartTutorial
• SubmitApplication
• Subscribe
• TravelBooking
• UnlockAchievement
• Unsubscribe
• Update
• ViewAdv
• ViewCart
• ViewContent
• ViewItem
• ViewItems
• InitialSubscription
• InitialTrial
• InitialOffer
• ConvertedTrial
• ConvertedOffer
• TrialInRetry
• OfferInRetry
• SubscriptionInRetry
• RenewedSubscription
• FailedSubscriptionFromRetry
• FailedOfferFromRetry
• FailedTrialFromRetry
• FailedSubscription
• FailedOfferise
• FailedTrial
• ReactivatedSubscription
• RenewedSubscriptionFromRetry
• ConvertedOfferFromRetry
• ConvertedTrialFromRetry
• Unsubscription

Custom events tracking

Use any of custom events if default doesn't fit your scenario:

• CustomId01
• CustomId02
• CustomId03
• CustomId04
• CustomId05
• CustomId06
• CustomId07
• CustomId08
• CustomId09
• CustomId10

If above event functionality still limits your usecase, you can use UserCustomEvent

UserCustomEvent("MyCustomNameEvent")
  .addPredefinedParameter(PredefinedString.DESCRIPTION, "best before 2029")
  .addPredefinedParameter(PredefinedObject.CONTENT, JSONObject().apply {
    put("collection", "Greatest Hits")
  })
  .send() // Send event

Predefined event parameters

To enrich your event with another dimension, you can use predefined parameters for most common cases. Add it to any event:

class Presenter {
  fun onUserAddsItemsToCart(userData: String) {
    AddToCartEvent(userData)
        .addPredefinedParameter(PredefinedString.DESCRIPTION, "best before 2029")
        .addPredefinedParameter(PredefinedObject.CONTENT, JSONObject().apply {
          put("collection", "Greatest Hits")
        })
        .addPredefinedParameter(PredefinedListObject.CONTENT_LIST, listOf(
          JSONObject().apply {
            put("content", "songs, videos")
          }
        ))
        .send() // Send event
  }
}

For java use:

class Presenter {
  void onUserAddsItemsToCart(String userData) {
    JSONObject json = new JSONObject()
            .put("collection", "Greatest Hits");
    
    JSONObject jsonContent = new JSONObject()
            .put("content", "songs, videos");
    
    List<JSONObject> jsonList = Collections.singletonList(jsonContent);
    
    new AddToCartEvent(userData, System.currentTimeMillis())
            .addPredefinedParameter(PredefinedString.DESCRIPTION, "best before 2029")
            .addPredefinedParameter(PredefinedFloat.PRICE, 2.19f)
            .addPredefinedParameter(PredefinedObject.CONTENT, json)
            .addPredefinedParameter(PredefinedListObject.CONTENT_LIST, jsonList)
            .send(); // Send event
  }
}

In examples above PredefinedString.DESCRIPTION and PredefinedFloat.PRICE is used, but many others is available:

PredefinedParameter	Type
PredefinedString	String
PredefinedLong	Long
PredefinedFloat	Float
PredefinedObject	JSONObject
PredefinedListObject	List<JSONObject>
PredefinedListString	List<String>

PredefinedString

• ACHIEVEMENT_ID
• ADREV_AD_TYPE
• BRAND
• BRICK
• CAMPAIGN_ID
• CATALOGUE_ID
• CHANNEL_TYPE
• CITY
• CLASS
• CLICK_ID
• CONTENT_ID
• CONTENT_NAME
• CONTENT_TYPE
• CONVERSION_ID
• COUNTRY
• COUPON_CODE
• CURRENCY
• CUSTOMER_SEGMENT
• CUSTOMER_TYPE
• CUSTOMER_USER_ID
• DEEP_LINK
• DESCRIPTION
• DESTINATION_A
• DESTINATION_B
• DESTINATION_LIST
• EVENT_NAME
• NEW_VERSION
• NETWORK
• OLD_VERSION
• ORDER_ID
• PARAM_01
• PARAM_02
• PARAM_03
• PARAM_04
• PARAM_05
• PARAM_06
• PARAM_07
• PARAM_08
• PARAM_09
• PARAM_10
• PAYMENT_INFO_AVAILABLE
• PID
• PLACEMENT
• PREFERRED_NEIGHBORHOODS
• PRODUCT_ID
• PRODUCT_NAME
• PURCHASE_CURRENCY
• RECEIPT_ID
• REGION
• REGISTRATION_METHOD
• REVIEW_TEXT
• SEARCH_STRING
• SEGMENT
• SOURCE
• STATUS
• SUBSCRIPTION_ID
• SUCCESS
• SUGGESTED_DESTINATIONS
• SUGGESTED_HOTELS
• TUTORIAL_ID
• UNIT
• UTM_CAMPAIGN
• UTM_MEDIUM
• UTM_SOURCE
• VALIDATED
• VERTICAL
• VIRTUAL_CURRENCY_NAME
• VOUCHER_CODE

PredefinedLong

• AMOUNT
• DATE_A
• DATE_B
• DEPARTING_ARRIVAL_DATE
• DEPARTING_DEPARTURE_DATE
• HOTEL_SCORE
• LEVEL
• MAX_RATING_VALUE
• NUM_ADULTS
• NUM_CHILDREN
• NUM_INFANTS
• PREFERRED_NUM_STOPS
• PREFERRED_STAR_RATINGS
• QUANTITY
• RATING_VALUE
• RETURNING_ARRIVAL_DATE
• RETURNING_DEPARTURE_DATE
• SCORE
• TRAVEL_START
• TRAVEL_END
• USER_SCORE
• EVENT_START
• EVENT_END

PredefinedFloat

• PREFERRED_PRICE_RANGE
• PRICE
• REVENUE
• LAT
• LONG

PredefinedObject

• CONTENT

PredefinedListObject

• CONTENT_LIST

PredefinedListString

• CONTENT_IDS