Overview

The /setuid endpoint in Prebid Server is crucial for managing user IDs during cookie synchronization processes. This endpoint is responsible for saving the results in the Prebid Server's uids cookie, which helps in recognizing users across different bidding platforms.

Endpoint Details

• Endpoint URL: /setuid
• Purpose: Saves a UserID for a Bidder in the Cookie. The saved IDs are valid for 7 days before they are considered "stale" and require re-synchronization.

Query Parameters

• bidder: The key of the bidder being synchronized. This may not always match the bidder's name.
• uid: The ID used by the Bidder to recognize the user. If undefined, the UID for the bidder will be deleted.
• gdpr: Indicates if GDPR is in effect. Use 1 if GDPR applies, 0 if not, and leave undefined if unsure.
• gdpr_consent: Required if gdpr is 1. It should be an unpadded base64-URL encoded Vendor Consent String.
• f: Specifies the desired format of the response:
  • f=i (format=image): Responds with a blank 1x1 PNG.
  • f=b (format=blank): Responds with empty HTML.

GDPR Considerations

The endpoint will not write a cookie unless:

• The Vendor ID set by the Prebid Server host has permission to save cookies for the user.
• The Prebid Server host is not configured to run with GDPR support.

If unsure about GDPR readiness, contact the company hosting the Prebid Server.

Sample Request

GET https://gosrv.pixfuture.com/setuid?bidder=[BIDDER_CODE_NAME]&uid=[USER_ID]&gdpr=[GDPR]&gdpr_consent=[GDPR_CONSENT]

Return Values

• HTTP 400: The request is in GDPR scope, and the consent string is missing or invalid.
• HTTP 451: PBS does not have permission to set a cookie due to GDPR or another privacy rule.
• HTTP 200:
  • Success with image response: If f=i is specified, PBS responds with a blank 1x1 PNG.
  • Success with empty response: If f=b is specified, PBS responds with empty HTML.

This endpoint is essential for maintaining user privacy and compliance with GDPR while ensuring effective user ID synchronization across bidding platforms.