ByteDance Ads China—campaign configuration

For:
Marketers
Last update:

At a glance: ByteDance Ads China (Ocean Engine), an AppsFlyer integrated partner, is an Internet technology company operating several machine learning-enabled content platforms.

 Note

If you want to promote your Android Apps with ByteDance Ads China, you are required to send your OAID to AppsFlyer SDK according to the instructions in the AppsFlyer SDK Integration - Android. Google Play service is blocked in China, OAID is the most popular Android Device ID for ad attribution.

In addition to click-based mobile attribution, ByteDance Ads China also offers view-through attribution, which you can record with AppsFlyer.

To configure your campaigns with ByteDance Ads China, follow the steps below.

Setting up ByteDance Ads China

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.

Tip

  • The General Settings step in the Integration tab is mandatory for all partners.

  • All the rest of the steps are either descriptive or optional.

Integration tab

The Integration Tab is divided into different sections as described below.

Activate partners

On the first visit here, you must toggle ON the Activate Partner button to enable the setup of the integration tab's parameters. The toggle MUST be ON for as long as you work with the partner.
For more details about partner activation, click here.

General Settings

Enable View-Through attribution

Toggle this to ON if you want to attribute view-through installs from ByteDance Ads China. The view-through lookback slider is available on the attribution link tab (described below).

Default postbacks

AppsFlyer can send automatic postbacks to ByteDance Ads China following user installs and re-engagements. Use this section to define the source of the users that allow sending these postbacks.

bytedance-default-postbacks.png

In-app events settings

In this section, you can map your AppsFlyer events with ByteDance Ads China via postbacks.

  1. Turn In-App Event Postbacks on.

  2. Select the Sending Option for all SDK-defined 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.

  3. Click Add Event to add an SDK Event to the list.

  4. Complete the following parameters:
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).

Attribution link tab

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 can use either a single-platform link or a OneLink.
Learn more about attribution link structure and parameters.

To generate an attribution link, follow these instructions.

Click attribution link

Once you have generated the attribution link, complete the campaign setup process on the ByteDance Ads China site.

1. Create Conversion Tracking in Ocean Engine.

Log in to Ocean Engine (https://ad.oceanengine.com/) > Library > Conversion Tracking.

OE_dashboard_1.png

Click on Tracking application and create a New Application Transformation.

OE_dashboard_2.png

Click the API method. 

OE_dashboard3.png

In the Monitoring link part, enter AppsFlyer click attribution link and/or impression attribution link. 

dashboard4.png

 

2. Finish the Attribution Test Following the Instructions on the Website.

3. Create an Ad Campaign with the Newly Created Conversion.

Go to New Ad >> Set Budget and Bid select the conversion you created for this app.

Cost tab

AppsFlyer gets cost details by API. Note that AppsFlyer doesn't support the ad-level cost data for ByteDance, except for campaigns running on the v1.0 ByteDance system.

API dimensions supported

Geo Media source Campaign Adset Ad Other
Yes - Yes Yes

 No

(Ads are only supported for v1.0 ByteDance campaigns)

 -


To enable ByteDance Ads China cost API:

  1. In the integrated partner Cost tab, enable Get Cost Data.
  2. Log in to ByteDance Ads China. 
  3. Click Save Cost.
    • You have successfully completed the procedure. API is active. AppsFlyer collects data from the partner 6 times a day, on average once every four hours.
    • The cost tab shows the status of your cost integration and the last time AppsFlyer managed to pull matching cost data.

Ad revenue tab

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 tab

In this tab, you can select the permissions to grant ByteDance Ads China, whether the partner acts as an ad network, agency, or both. Note that even if attribution is disabled for ByteDance Ads China, the permissions tab is active and you can grant control to ByteDance Ads China.

Use these toggles to give the ad network permissions to handle its own configuration for your app:

Ad network permissions

  • Allow to configure integration - permit the partner to set up the integration tab (except in-app event postbacks)
  • Allow to configure in-app event postbacks - permit the partner to setup in-app event postbacks mapping to itself on the integration tab
  • Allow access to your retention report - only to the partner's own retention data
  • Allow access to your aggregate loyal user data - only to the partner's own loyal user data
  • Allow access to your aggregate in-app events data - only to the partner's own in-app events data
  • Allow access to your aggregate revenue data - only to the revenue data attributed to the partner
  • Allow access to your Protect360 dashboard - only to the partner's own Protect360 data, and providing the feature is enabled for the advertiser

Learn more about granting ad network permissions.