Prebid

Intégrations
Prebid

The PubProvided ID Prebid module enables publishers to pass a first-party ID into the bid stream of their Prebid integration. This is the preferred method for passing the first-id to prebid bidders who have agreements with First-id.


💡 TIP : ​If you don’t manage your own prebid wrapper, you may need to adapt your wrapper technology to correctly retrieve the first-id identifier and pass it to Prebid. We can contact your service provider to carry out the necessary developments.

💡 TIP : If you are using our SDK, we have a function in place that can build the whole eids object block :

You can use the following function : FIRSTID.getFirstIdEidsObject()
This is the output of the function :


Image

⚠️ Make sure the first-id SDK is loaded soon enough in your page so that the function is available before you trigger it for you prebid instance.

The PubProvided ID module enables publishers to pass a first-party ID into the bid stream of their Prebid integration. This is the preferred method for passing the first-id to prebid bidders who have agreements with First-id.

The module supports a user-defined function that generates an eids object:

pbjs.setConfig({
    userSync: {
        userIds: [{
            name: "pubProvidedId",
            params: {
                eidsFunction: getIdsFn   // any function that exists in the page
            }
        }]
    }
});

​Alternatively, eids values can be passed directly to the setConfig :

pbjs.setConfig({
    userSync: {
        userIds: [{
            name: "pubProvidedId",
            params: {
                eids: [{
                    source: "first-id.fr",
                    uids: [{
                        id: "value read from cookie or local storage",
                        atype: 1,
                        ext: {
                            stype: "ppuid"
                        }

                    }]
                }, {
                    source: "3rdpartyprovided.com",
                    uids: [{
                        id: "value read from cookie or local storage",
                        atype: 3,
                        ext: {
                            stype: "dmp"
                        }
                    }]
                }]
            }
        }]
    }
});

in both cases, the bids adapters will receive the id after the consent has been validated.

This design allows for multiple uiids in the eids object. You may already be working with other id providers, but you can include the first-id identifier in the same eids object.

the extension “source-type eids.uids.ext.stype” helps entities downstream of the bid request to identify the data. For first-id, the source-type to use is :

ppuid - (cet uid provient de l'éditeur nommé dans le eids.source)

Bid adapters listening to userIds.pubprovidedId will not receive a string. Please use the  userIdAsEids value/function to return the id as a string.

To use PubProvidedId, add it to your prebid.js package:

gulp build –modules=pubProvidedIdSystem

Configuration of PubProvidedId for first-id :

NomScopeTypeDescrptionExample
nameRequiredStringID value for the ID modulevaleur du F-id
paramsOptionalObjectDetails for syncing.
params.eidsFunctionOptionalfunctionany function that exists in the pagegetIdsFn()
uids.atypeOptionalintADCOM – Type of user agent the match is from1
uids.ext.stypeOptionalStringDescription of how the id was generated and by whom eg. (‘ppuid’,’DMP’,’other’)ppuid