Request

This endpoint is case-sensitive. The request URL and parameters must strictly follow the specified case.

The following notes apply specifically to TikTok:

TikTok has strict parameter requirements. Please populate every parameter this document requires (send it whenever the value is available).

If a device is eventually entered into bidding, you must also call the /rta/report endpoint to report the bidding result.

If your requests are latency-sensitive, we recommend selecting a different domain for each region to achieve the best response time.

For devices returned as false, we recommend caching the result to reduce request traffic.

URL

Region-specific Domains

Location Domain Description
US region 3s-smart-rtb-vg.mobvista.com Use this domain if you run offers for the US / BR region AND your servers are located in the US
EU region 3s-smart-rtb-eu.mobvista.com Use this domain if you run offers for Europe AND your servers are located in Europe
Default 3s-smart-rtb.mobvista.com Use this default domain for all other regions. It is served from a data center in Singapore.

Protocol

  • HTTPS

Method

  • GET

Request Parameters

Parameter Type Required Default Example Description
package_name string Y none Package name of the app running the RTA project. Obtain it from your channel manager, e.g. com.zhiliaoapp.musically for TikTok US.
campid int N none Promoted offer ID. Do NOT send this field if both package_name and geo are provided; those two take precedence. Obtain from channel manager.
token string Y none Obtain from your channel manager.
is_rt string N none Whether this is a retargeting offer. 1 = retargeting, 0 = user acquisition. Defaults to 0 if omitted.
device_id string Y none IDFA / GAID of the device.
user_agent string Y none User-Agent.
client_ip string Y none Client IP address.
geo string Y none US Target region.
state string Y none State where the client device is located.
city string Y none City where the client device is located.
media_source string Y none AF partner ID (TikTok only).
site_id string Y none 1234322 Sub-channel ID (TikTok only).
bundle_id string Y none com.tf.thinkdroid.viewer Publisher-side package name (TikTok only).
campaign_name string Y none Tiktok-BR-android Campaign name (TikTok only).
campaign_id string Y none 1234 Campaign ID (TikTok only).
ad_name string Y none tt_br_android Ad name (TikTok only).
ad_id string Y none 4567 Ad ID (TikTok only).
os_version string Y none 13.0.0 Device OS version (TikTok only).
model string Y none RMX3830 Device model (TikTok only).
brand string Y none xiaomi Device brand (TikTok only).
language string Y none en Device language (TikTok only).
resolution string Y none 1920×1080 Device screen resolution (TikTok only).
carrier string Y none n/a Device carrier (TikTok only).
network_access string Y none wifi/5g Device network type (TikTok only).
timezone string Y none n/a Device timezone (TikTok only).
network_registration_time string Y none n/a The first time the device joined the network (TikTok only).
ad_type string Y none app icon Ad type (TikTok only).
ad_placement string Y none n/a Ad placement (TikTok only).
ad_width string Y none 1920 Ad slot width (TikTok only).
ad_height string Y none 1080 Ad slot height (TikTok only).

Response Notes

  • The endpoint always returns a JSON-formatted string.
  • Regardless of success or failure, the response contains the code, message, and data fields. code = 0 indicates success. data is the response payload; when data.target is true, RTA is allowed for the device, otherwise it is not. When code is non-zero, see the exception documentation.

results matching ""

    No results matching ""