top of page

TECH DOCS

SDK javascript First-id

First-id vous met à disposition un SDK afin de disposer d'un ensemble d'outils facilitant l'utilisation de l'ID.

💡 Pourquoi installer le sdk ?
 Léger, facile à installer et sans impact sur la performance de vos sites, le sdk first-id est très utile :
  • Pour faciliter vos intégrations relatives à l'utilisation de l'identifiant first-id ((envoi à votre adserver, à votre stack adtech, ...)
  • Pour faciliter les intégrations de vos partenaires tiers (dmp, wrappers prebid externes)
  • Pour permettre le suivi des campagnes publicitaires basées sur l'identifiant first-id (attribution/mesure)
  • Pour être assuré de disposer des dernières fonctionnalités liées à l'évolution du produit First-id

URL

Le SDK est disponible en version normale et minifiée sur notre environnement de preprod et production :

Cache

Pour éviter de charger le SDK à chaque fois, notre CDN renvoie des headers de cache.

Le loader a un cache de 1H, le SDK a un cache de 1an. Le loader se charge de changer la version du SDK appelé.

Installation

⚠️ IMPORTANT ⚠️

Le sdk doit être appelé avant l'initialisation de votre stack publicitaire, afin que toutes les ressources soient disponible avant l'activation de ses fonctionnalités

Le SDK est composé de 2 parties :

  • Le loader : il très léger pour un chargement optimisé. Il va s'occuper de charger le SDK et d'appeller les callbacks de chargement.

  • Le SDK : Le SDK en lui même qui contient toutes les méthodes.

Exemple d'installation (avec l'url de preprod pour test, vous pourrez changer pour l'url de prod pour passer en production) : 

<script type = "text/javascript" defer src = "https://cdn.preprod.first-id.fr/sdk/loader/loader.min.js" > < /script>

    <script type = "text/javascript" >
   // create firstId SDK configuration
   window.firstId = window.firstId || {
       callbacks: [],
       debug: true, // by default debug mode is on false. Debug mode will be enable log message in console
       cookieName: 'firstId' // by default the SDK will expect find a cookie with name "firstId" where the FirstID value is store. You can override the cookie name (if you store the FirstID in another cookie name) with the config key "cookieName"
   };

// register callback will be call when SDK load
// callback will be call in same order as push in array
window.firstId.callbacks.push(() => console.log('FirstID is loaded !'))


window.firstId.callbacks.push(() => {
       // you can use firstID with 2 ways :

        // Built a new instance of SDK
       let fid = new FirstIdSdk();

        // call some method
       console.log(fid.getVersion());

        // or you can use the global var FIRSTID
       console.log(FIRSTID.getVersion());

        // to read the FirstID :
       try {
           let firstIdValue = fid.getId();
       } catch (e) {
           // catch error
           if (e.code === 'FirstIdCookieNotFound') {
               // the cookie specify in config was nos foud
           }

            if (e.code === 'FirstIdEmptyValue') {
               // the cookie was found, but the value if empty
           }
       }
   }) </script>

Copyright First-id 2023 - all rights reserved

bottom of page