Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use the following information to transfer audience segment data to PubMatic over SFTP.

Comment

dsimerly - 1/10/2021 - The following excerpt is shared with the document, Audience > Data partner integration guide for audiences.


Data transfer parameters

Excerpt


ParameterTypeRequiredDescription
dpidinteger

PubMatic data partner ID (DPID) assigned to the data partner at time of integration.
useridintegerThe PubMatic user ID passed to the data partner by PubMatic .
segidinteger array

Use segid to send the complete list of audience segment IDs to which the user belongs. Each subsequent request for that user with the segid parameter overwrites the user’s already existing segments list.

DO NOT send segid in a request that also includes the addseg or remseg parameter.

Warning
Omitting the segid parameter removes the entire list of the user's audience segments. See Remove a user from audiences.


uidtypeinteger

A integer value that determines what the identity partner's PubMatic user ID represents:

  • 0 = UID represents a PubMatic cookie ID. Note: when using uidtype=0, you must first perform the UID sync step below.
  • 1 = UID represents a device ID.
  • A different identity partner ID registered with PubMatic.
Note
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.


addseginteger array

Use addseg to send:

  • A complete list of comma-separated segment IDs to replace the user's current segments. 
  • The addseg parameter with the list of new segments to append to the user’s current segments.

You can include addseg and remseg in the same request, but DO NOT send segid along with these parameters.

remseginteger

Use remseg to send:

  • A complete list of comma-separated segment IDs to replace the user's current segments. 
  • The remseg parameter with the list of segments to remove from the user’s current segments.

You can include remseg and addseg in the same request, but DO NOT send segid along with these parameters.

iptext
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.
countrytext
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.



Comment

dsimerly - 1/10/2021 - You'll find the following included excerpt within the document, Audience > Data partner integration guide for audiences.

SFTP bulk audience data transfer

...