[Legacy] TikTok For Business campaign configuration

At a glance: [Legacy] TikTok for Business (bytedanceglobal_int), is an AppsFlyer ad network integrated partner providing app owners with the ability to measure click-based mobile attribution with AppsFlyer.

 Note

Note: On January 30, 2023, the new TikTok for Business—Advanced SRN integration tiktokglobal_int was added, while this [Legacy] TikTok for Business integration bytedanceglobal_int will be deprecated by March 2024. This transition is handled by TikTok and they will notify you when you can delete the old integration. To avoid any data loss, make sure to keep both integrations live during the transition phase. Learn more bulletin.

Setting up [Legacy] TikTok For Business integration

 Note

If you're enabling this [Legacy] TikTok For Business integration for the first time, we suggest you switch to the new TikTok for Business—Advanced SRN integration tiktokglobal_int instead. The legacy integration will be deprecated by March 2024.

AppsFlyer integration with [Legacy] TikTok For Business supports click attribution, cost, ad revenue, and audiences.

Learn more on how to set up a campaign on TikTok. Note that the campaign name shouldn't start from or end with a white space, as it may cause discrepancies in dashboards and reports

Prerequisite: Before setting up the integration, make sure you contact the partner and open an account with them.

To activate or edit the integration:

  1. To activate: In AppsFlyer, from the side menu, select Collaborate Partner Marketplace.
    To edit: In AppsFlyer, from the side menu, select Collaborate Active Integrations
  2. Search for the partner and select it.
  3. Click Set up integration. You’re directed to the integration setup page.
  4. In the Integration tab, turn on Activate partner.
    Note: The toggle must stay on (activated) for as long as you work with the partner.
  5. Complete the configuration using the relevant tabs, as described below.

Settings tabs

Update setting tab content as required.

Integration

In this tab, you can configure your integration with [Legacy] TikTok for business.

To enable and configure the integration:

  1. Turn on Activate partner. Activate partner must be enabled for as long as you work with the partner. 
  2. [Optional] Enter your TikTok App ID available in your TikTok Ads dashboard.
      • TikTok App ID is a unique code generated in TikTok Ads Manager and is used by TikTok to confirm advertiser ownership of their apps.
      • Although not mandatory, it is recommended to enter your App ID of all your apps.
        This helps you to better control your [Legacy] TikTok For Business data and to unlock additional products.
      • To add more than one TikTok App ID:
        1. Enter your first TikTok App ID.
        2. Press Enter.
        3. Enter your next TikTok App ID.

     Note

  3. [Optional] Enable View-Through attribution. The view-through window is set using the attribution link.

     Note

    [Legacy] TikTok For Business is using enhanced data privacy measures to protect people using their services. Starting October 23, 2021, [Legacy] TikTok For Business is providing advertisers with limited view-through attribution data at the device level. For user-level sources such as raw data reports, Push API messages, Pull API reports, Export data page, and Data Locker the following fields are populated:

    • Media source (bytedanceglobal_int)
    • Channel
    • Attributed touch type (impression)
    • Attributed touch time (reported as date only - "dd/mm/yyyy")
    • Campaign is reported as "restricted"

    Note that this data isn't available in GCD.

    Aggregate data reports continue to display view-through conversions.

  4. Send postbacks to [Legacy] TikTok For Business following user installs. Select an option from:
    • Only events attributed to this partner for events coming from users attributed to [Legacy] TikTok For Business.
    • Events attributed to any partner or organic to report all installs to [Legacy] TikTok For Business. Meaning that TikTok has information about your entire user base.
  5. [Optional] To send in-app event postbacks to [Legacy] TikTok For Business:
    • Enable in-app event postbacks 
    • [Optional] Set the in-app event postback window.
    • Select the sending option for events:
      • Only events attributed to this partner for events coming only from users attributed to this partner.
      •  Events attributed to any partner or organic to have your entire user base available to be reported to the partner.
    • Click Add Event to add an SDK or server-to-server event to the list. The table that follows describes the fields you need to complete. 
      Note: The event name for a Custom event can contain up to 50 characters, including lower-case alpha-numeric characters (a-z and 0-9), underscores, and dashes. The event name must start with a letter.
  6. Click Save Integration.
Parameter Name Description
AppsFlyer event

The name of the event, as received by AppsFlyer either from the SDK integrated into your app or from server-to-server events.
Tip: Don't see the event you are looking for?

  • Make sure to activate the event on a device with a non-organic installation and recheck.
  • Type it in AppsFlyer event, then click Create custom. Read more about custom event mapping.
mapped to partner event

The unique name or ID of each event, as defined on the partner's side. Possible mapping configurations are:

  • Text field: Get the corresponding event ID from the partner.
  • Drop-down box: Select the most suitable pre-defined AppsFlyer event.
  • As is: Send the events as they are, without mapping the event name.
for users from

Select the sending option for the event:

  • This partner only: Send postbacks only when the event is attributed to this partner—meaning, the user who performed it came from this partner.
  • All media sources including organic: Send postbacks for events attributed to any partner and for organic events—meaning, the user who performed it came from any media source.
including

Select which event data to share with the partner in the postback:

  • No values & no revenue: Send just the event itself without any parameters (values or revenue).
  • Values & no revenue: Send all the parameters excluding the revenue value.
  • Values & revenue: Send all the event parameters, including the revenue value (if exists in the event).

[Legacy] TikTok For Business event identifiers

Event name Description
Registration User registers

Pay(Purchase)

User completes a Purchase transaction (Note: If you want to postback Purchase/Pay events to [Legacy] TikTok For Business, you must send the revenue currency code as part of the JSON sent in the eventValue parameter. Make sure that you do so for events sent by SDK and events sent by S2S.)
View_content User views content
Checkout User checks out
Add_to_cart User adds product to cart
Unlock_achievement User unlocks an achievement (for example, in a game, reaches a spend milestone)
Subscribe User subscribes
Start_trial User starts a trial
Spend_credits User spends points/credits earned (for example, Loyalty points)
Search User searches for a product
Rate User rates a product
Login User logs into the app
Loan_disbursal User is disbursed the loan amount
Loan_approval User's loan application gets approved
Loan_application User applies for Loan
Achieve_level User completes a level (for example, in a game)
Join_group User joins a group
InApp_ad_impr User views an impression
InApp_ad_click User clicks on an ad
Generate_lead User expresses interest in a product (lead generation)
Create_role User creates a role
Create_group User creates a group (for example, group on PubG, group on WhatsApp)
Complete_tutorial User completes a tutorial
Launch_app User launches the app
Add_to_wishlist User adds product to wishlist
Add_payment_info User adds payment information

Attribution link 

Generate and save attribution links and send them to the partner for attributing specific campaigns, ad sets, or single ads - both for UA and retargeting campaigns. You should use a single-platform link.
Learn more about attribution link structure and parameters.

To generate an attribution link, follow these instructions.
When generating the attribution link, select parameters from the list below and map them to the [Legacy] TikTok For Business parameters name detailed in the table.

Parameter mapping

AppsFlyer 

[Legacy] TikTok For Business

af_siteid

__CSITE__

af_channel

__PLACEMENT__

c

__CAMPAIGN_NAME__

af_c_id

__CAMPAIGN_ID__

af_adset

__AID_NAME__

af_adset_id

__AID__

af_ad

__CID_NAME__

af_ad_id

__CID__

af_ad_type

__CTYPE__

Cost

AppsFlyer gets cost details by API. See the ad network cost integration table for full details on the supported dimensions, metrics, and features. Note: Cost data requires an ROI360 subscription.

To enable the API connection for cost, clicks, and impressions with [Legacy] TikTok for Business (advanced SRN):

  1. Go to the Cost tab and turn on Get cost data.
  2. Click Log in to TikTok Ads.
  3. From the TikTok window that opens, log into your TikTok account and confirm the needed permissions.

    TikTok-ForBusiness2.png

  1. Connect at least one advertiser ID.
    • You can get your advertiser account ID from TikTok. In your TikTok business account, go to Users > Members, and under the Advertiser account, you can see the ID.
    • Make sure the advertiser ID you add is related to TikTok account you connected in step 1.
    • You can add up to 30 advertiser IDs.
    • Note: It can take up to 24 hours for any changes related to advertiser IDs to take effect.

View your cost API status and the last time AppsFlyer managed to pull matching cost data in either the cost (and ad revenue) integration status dashboard, or in the individual ad network dashboard.

Warning

Using the same advertiser ID with the same app for both the advertiser and agency accounts is likely to cause duplicate costs!

Ad revenue

This section is relevant if you are acting as a publisher, displaying ads of the partner to your users. As such, you would certainly like to measure the engagement of your users acquired from different sources, to find the most profitable sources for you.

To enable the ad revenue API:

Permissions

In this tab, you can select the permissions to grant [Legacy] TikTok for Business to perform certain actions. Note that even if attribution is disabled for [Legacy] TikTok for Business, the permissions tab is active and you can grant [Legacy] TikTok for Business permissions.
Learn more about the permissions you can grant

Traits and limitations

Trait Remark
Action cannot be completed TikTok has started blocking non-business accounts from adding links redirecting to the Apple App Store and Google Play Store. For more information see working with affiliate marketers
TikTok App ID status When generating a TikTok App ID, the status changes from Pending Verification to Verified only after an event is sent back to TikTok (attributed or unattributed), after correctly implementing the TikTok App ID.