Use this guide to integrate your audience segments with the PubMatic system.
Get PubMatic's API Token: provide PubMatic with the developer's First Name, Last Name, and Email Address to create an API authentication token.
To learn more…
Integration also requires a data partner ID (DPID).
To learn more…
Data owners can send…
- Cookie IDs for mobile and desktop/web.
- IDFA/Android device IDs for mobile apps; in this case, step 1 below is NOT required , but step 2-3 remain the same.
- Different ID types within the same PubMatic account; contact your PubMatic account manager for details.
Data integration requires these steps:
Register segments ONLY ONCE before data transfer…
Data providers must register new segments with source segment IDs before sending data to PubMatic. PubMatic ignores unrecognized segment IDs to avoid processing mistakenly sent data.
Two ways to register segments:
- Register segments with the Segment Registration APIs; see, Register an Audience segment, to learn more.)
- Bulk-register segments in the PubMatic system UI using the menus, Publisher Account > Audience > Audience Segments > Bulk Upload Segments:
Use Data Transfer API calls to send data to PubMatic. Build API calls using the parameters in the table below to transfer data demonstrated by samples for the following methods:
- Server-to-server (S2S) data transfer
- Browser-side real-time (HTTP 302 redirect) data transfer
- Remove a user from audiences
- Bulk audience data transfer using SFTP
|PubMatic data partner ID (DPID) assigned to the data partner at time of integration.|
|integer||✓||The PubMatic user ID passed to the data partner by PubMatic .|
DO NOT send
A integer value that determines what the identity partner's PubMatic user ID represents:
You can include
You can include
|text||Last known IP address of the user. Exclude this parameter from the request if the user's last IP address is unknown, and it is optional when you send |
|text||Two-letter code for the user's country; for example, |
Server-to-server (S2S) data transfer
The server-to-server data transfer mechanism is a highly-efficient way to pass data to PubMatic because the data transfer happens directly between servers. The following diagram illustrates the server-to-server data transfer process between a data provider and PubMatic.
The process follows these steps:
- A user lands on a web page.
- PubMatic and a data provider receive the UID.
- PubMatic syncs with the data provider by sharing the data transfer API URL.
- The data partner passes the audience segment data to the PubMatic data transfer API in batches. The data transfer API typically requires the PubMatic-specific UID and the list of audience segment IDs as input.
For users whose audience profile changed since the last data transfer…
Data partners must transfer the updated audience profile information to PubMatic in batches.
Server-to-server sample requests
In this request,
89 is the data partner's PubMatic-assigned ID, the user belongs to three audience segments (with IDs
98901 , and
4532 ), and
uidtype=0 means the user
ID represents a PubMatic cookie ID, and that you must first use the UID sync step below when passing 0 in uidtype.
This request for the same user appends segment ID
3242 to the user's existing list and removes segment ID
123 from the list, changing the user's audience segments list to:
uidtype parameter also specifies using the
UID value as a device ID.
Browser-side real-time (HTTP 302 redirect) data transfer
Data partners who do not support the server-to-server data transfer mechanism can pass the data to PubMatic using the browser-side real-time data transfer mechanism for each visitor as follows:
- A user visits the website using a browser, which upon loading, executes the PubMatic pixel.
- The PubMatic pixel invokes the data partner's pixel or URL to request the audience segment data for this visitor. To reduce the latency, this request is sent to the data partner only once in a pre-configured time interval per user; for example, once per day.
- The data partner's system then redirects to the PubMatic Data Ingestion API using the HTTP 302 redirect. This API URL will be shared by PubMatic with the data partner before the start of the integration. While redirecting to the API URL, the data partner's system should include all the IDs of the audience segments to which the visitor belongs.
The data partner also must…
Browser-side sample requests
In this request,
89 indicates the data partner's PubMatic-assigned ID,
B8CB98E6-0FF0-4C2B-A161-4F89155C28F is the PubMatic user ID (from the UID sync step above ), and the user belongs to three DMP audience segments with IDs:
4532. The last known IP of the user was,
18.104.22.168, the user is from the
uidtype=0 specifies that the user ID should be handled as a cookie ID (you must first use the UID sync step below when passing 0 in uidtype).
This request for the same user show that,
B8CB98E6-0FF0-4C2B-A161-4F89155C28F is the PubMatic user ID, the last known IP of the user was,
22.214.171.124, and the user is from the
addseg instructs that audience segment
3242 will be appended to the user's existing list of audience segments, while
remseg instructs that audience segment 123 will be removed, leaving the user's updated audience segments as:
uidtype=1 specifies that the user ID should be handled as a device ID.
Remove a user from audiences
Use one of the following methods to remove a user from all of their audiences (DMPs and publishers can use either method):
- When sharing data via a Server-to-Server (S2S) call or browser redirect mechanism, exclude the
segidparameter from the S2S call to PubMatic. See Data transfer parameter reference above.
To send a list of segments to remove using the remseg parameter:
- When sharing data via a bulk file, do not pass any segment ID in the file for the user record. Audiences in the latest record are stored for the user ID, overwriting the user's previous audiences.
Bulk audience data transfer using SFTP
You can use SFTP to transfer audience segment data to PubMatic within a tab-delimited file, where each row of the file contains the audience segment parameters separated by a tab character, with each row ending with a carriage-return as follows:
[DPID] [TAB] [PUBID] [TAB] [SEGID] [TAB] [IP] [TAB] [COUNTRY] [TAB] [UIDTYPE]
The segid parameter can be a comma-separated list of different audience segment IDs. See Data transfer parameter reference above.
You must provide either…
[IP](last known IP address) or
[COUNTRY](two-letter country code). If
[IP]is unknown, add two TABs between
[COUNTRY]with no additional blank/space characters. See Segment Registration > Sample entries below.
File name format
File names follow the pattern:
While the transfer is in progress…
Suffix the file with,
.UPLOADING, then rename it upon completion.
PubMatic supports compression formats such as,
bzip2 , and others. If you have any questions or issues uploading a compressed file, please contact your PubMatic account manager for assistance.
Before sending data for specific segment IDs in the TSV file, you should have already registered the segments with PubMatic. You can either email PubMatic any new segment names and IDs you want to register, or use the PubMatic Audience Registration API to do so.
103 5AFCD4CD-F9B6-4E53-B63D-BFB2CF44941D 4666 126.96.36.199 0
103 34E1EA68-8EDA-4254-9BD0-AB24BCC13914 4666 US 1
Bulk transfer notes…
- FTP lets a single user batch upload data for multiple partners, while HTTP allows data for only a single partner.
- HTTP lets a DMP add or remove a segment for a given user id, but FTP requires the DMP to send all the user's segment IDs, which overrides the existing segment stored with PubMatic.
- FTP allows only one new line entry for each segment for a given user.
Host and access
Provided separately by PubMatic. Contact your PubMatic account manager with questions.
Unique identifier (UID) sync
PubMatic can process data only from PubMatic User IDs…
uidtype=0, a data provider must create a user-match table between PubMatic's user IDs and their own user IDs.
Steps for user sync-up:
- The data provider must provide PubMatic with an image pixel similar to,
<img src="" width=1 height=1>.
- If data comes from a publisher, then PubMatic incorporates the image pixel from step 1 in a PubMatic pixel. The publisher must fire the PubMatic pixel across their website to maximize coverage across their users. Firing the pixel also lets the data provider create the match-table.
- If data comes from a buyer, PubMatic fires the image pixel from step 1 across PubMatic's site