SFTP Data Transfer for Audience Segments
Use the following information to transfer audience segment data to PubMatic over SFTP.
Data transfer parameters
Parameter | Type | Required | Description |
---|---|---|---|
dpid | integer | ✓ | PubMatic data partner ID (DPID) assigned to the data partner at time of integration. |
userid | integer | ✓ | The PubMatic user ID passed to the data partner by PubMatic . |
segid | integer array | Use DO NOT send Omitting the segid parameter removes the entire list of the user's audience segments. See Remove a user from audiences. | |
uidtype | integer | ✓ | A integer value that determines what the identity partner's PubMatic user ID represents:
Note that uidtype is now required for all new integrations. Contact your PubMatic account manager to learn more about UID Type assignment and other identity partners supported by PubMatic. |
addseg | integer array | Use
You can include | |
remseg | integer | Use
You can include | |
ip | 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 country in the request. | |
country | text | Two-letter code for the user's country; for example, US , IN , CA . Exclude this parameter from the request if the user's country is unknown, and it is optional when you send the last known ip in the request. |
SFTP bulk audience data transfer
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: The segid parameter can be a comma-separated list of different audience segment IDs. See Data transfer parameter reference above. You must provide either… File names follow the pattern: If your organization has workload managed by a team, you can also include a While the transfer is in progress… Suffix the file with, PubMatic supports compression formats such as, 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. Bulk transfer notes… Provided separately by PubMatic. Contact your PubMatic account manager with questions. PubMatic can process data only from PubMatic User IDs… Steps for user sync-up:[DPID] [TAB] [PUBID] [TAB] [SEGID] [TAB] [IP] [TAB] [COUNTRY] [TAB] [UIDTYPE]
[CR][IP]
(last known IP address) or [COUNTRY]
(two-letter country code). If [IP]
is unknown, add two TABs between [SEGID]
and [COUNTRY]
with no additional blank/space characters. See Segment Registration > Sample entries below.File name format
<DPID>_<TIMESTAMP>_<MD5SUM>.tsv.gz
<TIMESTAMP>
format should be Unix; for example, 1596695461984
. <MD5SUM>
is an MD5 32-character hexadecimal checksum that is computed on the file content before compression.<WORKERID>
as part of the file name to help track and manage the team member's workload:<DPID>_<TIMESTAMP>_<MD5SUM>_<WORKERID>.tsv.gz
*
.UPLOADING
, then rename it upon completion. gzip
, bzip2
, and others. If you have any questions or issues uploading a compressed file, please contact your PubMatic account manager for assistance.Segment registration
Sample entries
103 5AFCD4CD-F9B6-4E53-B63D-BFB2CF44941D 4666 74.125.236.123 0
103 34E1EA68-8EDA-4254-9BD0-AB24BCC13914 4666 US 1
Host and access
Unique identifier (UID) sync
uidtype=0
, a data provider must create a user-match table between PubMatic's user IDs and their own user IDs.<img src=" http://partner.com/xxxx?id=UID " width=1 height=1>
.
Table of Contents