In-App User Optimization

Buyers can optimise their BidStream by putting users into groups, as explained in the SmartSwitch User Optimization section. This enables BidSwitch to send more traffic from users marked as valuable to Buyers. To sync app users with the most appropriate user group, use one of the following methods.

Real-time User-Group Syncing
The Buyer makes a call to the BidSwitch Mobile-Users Sync endpoint and using the appropriate URL parameters assigns a user to their group. This is the preferred method as it updates user group records immediately.
User-Group TSV Upload
Using this method, the Buyer uploads a daily TSV file with user group information.

Real-time User-Group Syncing

To sync a particular app user with a user group, the Buyer should make a call to the BidSwitch Mobile-Users Sync endpoint. You can do this from within the app, or using a server-to-server call.

  • If making the call from within the app, use the following endpoint http(s)://x.bidswitch.net/sync_ifa and provide the required parameters.
  • If using a server-to-server call, the endpoint domain is region specific:
    • US West: us-west.bidswitch.net
    • US East: us-east.bidswitch.net
    • EU: eu.bidswitch.net
    • APAC: apac-jp.bidswitch.net
App-User Sync URL Parameters
Value Type Description
dsp_id string The ID assigned to the Buyer by BidSwitch, for example, 123.
ifa string The native identifier for advertisers. An ID assigned by the device or browser for use as an advertising identifier, for example Apple’s IDFA or Android’s Advertising ID.
user_group integer

Sets the user group with which to sync this user. The valid values for user groups are 0 - 5.

  • 0: Unwanted users.
  • 1: Regular users. No explicit interest in receiving ad requests.
  • 2 - 5: Valuable users: The Buyer wants to receive as many ad requests as possible from these users.
# Example Syntax
http(s)://x.bidswitch.net/sync_ifa?dsp_id=${dsp_id}&ifa=${ifa}&user_group=${user_group}

# Example HTTP
http://x.bidswitch.net/sync_ifa?dsp_id=1&ifa=ABC&user_group=2

#Example HTTPS
https://x.bidswitch.net/sync_ifa?dsp_id=1&ifa=ABC&user_group=2

# Example Server to Server
https://apac-jp.bidswitch.net/sync_ifa?dsp_id=1&ifa=ABC&user_group=2

User-Group TSV Upload

Buyers can also upload a daily TSV (tab separated values) file. To do this, use the following steps:

  1. Generate a pair of public/private SSH keys.
  2. Email BidSwitch support (support@bidswitch.com) requesting an SFTP account and attach your public key to the ticket.
  3. BidSwitch will provide connection details when setup is complete.
  4. When everything has been setup, you will need to generate a .tsv file.
  5. Send the .tsv file with the following fields:
    • IFA: The native identifier for advertisers.
    • Region: [US or EU or AS], select only 1.
    • User group: Select only 1 numerical value. This value should be in the range 0 - 5. See the table in the Real-time User-Group Syncing section for the significance of the numbers.
  6. The file needs to have the .tsv extension or it cannot be processed by the system.
  7. Place the TSV file(s) in the upload folder.
  8. Once processed the file will be removed from the upload folder and placed in the processed folder

The TSV file format should look similar to:

UUID<tab>region<tab>user_group

Note

Each TSV file cannot contain more than a 1000 rows. If necessary, please create multiple files of 1000 records/lines.