API Conversions

Flusso di lavoro ed esempi dello strumento di creazione dei parametri

La libreria dello strumento di creazione dei parametri è un SDK leggero open source progettato per adattarsi alla maggior parte dei sistemi.

Flusso di lavoro

Puoi trovare demo di esempio per ogni linguaggio nelle rispettive sottodirectory: un'app demo basata su localhost è disponibile nella cartella denominata /esempio. Il file README mostra come eseguire l'app demo in localhost passo dopo passo.

SDK lato client

Directory:

Indicazioni generali sull'integrazione:

  • Carica l'SDK: clientParamBuilder viene caricato durante l'inizializzazione della pagina.
  • Chiama le API dell'SDK: il sito web dell'inserzionista chiama le API fornite da clientParamBuilder. Ad esempio:
    • processAndCollectAllParams salva e aggiorna fbp, fpc e fbi (se getIpFn è disponibile)
      • Se getIpFn non è vuoto, fbi sarà salvato nel cookie, in base al risultato della funzione getIpFn passata.
      • Salva fbc se applicabile.
      • Salva fbp se applicabile.
    • getNormalizedAndHashedPII: restituisce dati IIP normalizzati e in formato hash in base al valore e al tipo di input.
    • .getFbc(), getFbp(), getClientIpAddress(): Chiama prima .processAndCollectAllParams per l'impostazione nei cookie e recupera i risultati dal cookie. Nota: questa API salverà/aggiornerà i cookie. Assicurati che il sito web abbia ottenuto il consenso dell'utente ai cookie prima di chiamare .
  • Invio del payload dell'API Conversions: il sito web dell'inserzionista invia il payload dell'API Conversions con i parametri recuperati.

Consulta le istruzioni complete nel file README.

SDK lato server

Directory:

Indicazioni generali sull'integrazione:

  • Importa la libreria dello strumento di creazione dei parametri nell'applicazione server del sito web dell'inserzionista.
  • Elabora la richiesta: chiama updatedCookieList = builder.processRequest con i dati di input.
  • Ottieni i cookie da impostare: usa updatedCookieList o builder.getCookiesToSet per ottenere una lista di cookie che consigliamo di salvare.
  • Salvataggio dei cookie: il server del sito web dell'inserzionista salva i cookie in base alla lista precedente.
  • Recupera i parametri. Recupera i valori usando:
    • getFbc()
    • getFbp()
    • getClientIpAddress()
    • getNormalizedAndHashedPII()
  • Invio del payload dell'API Conversions: il sito web dell'inserzionista invia il payload con i suddetti parametri.

[Consigliato] SDK lato client + lato server

Puoi anche integrare l'SDK lato client e lato server nella stessa app web. Sono compatibili tra di loro e sfruttano i cookie per le interazioni principali. Questo può aiutare a massimizzare l'efficacia della libreria dello strumento di creazione dei parametri.

clicca sull'immagine per ingrandire



  1. L'applicazione client dell'inserzionista carica lo strumento di creazione dei parametri lato client e invoca l'API processAndCollectAllParams fornita con un puntatore di funzione getIpFn.
  2. La getIpFn fornita verrà invocata e recupererà IPv6 da un endpoint configurato dall'inserzionista a seconda dell'implementazione effettiva di getIpFn.
  3. L'IPv6 verrà restituito dall'endpoint configurato dall'inserzionista e trasmesso nuovamente allo strumento di creazione dei parametri lato client dal valore restituito di getIpFn. L'IPv6 recuperato verrà memorizzato nel cookie con chiave _fbi per un successivo recupero.
  4. Sul lato client, avvia le comunicazioni consuete con il server back-end usando l'API Fetch (o altra comunicazione front-end/back-end) con i cookie proprietari.
  5. Sul lato server, integra la libreria lato server in base al linguaggio scelto nell'endpoint del destinatario (ad esempio, ExampleController) e invoca l'API processRequest fornita per gestire la richiesta.
  6. L'API processRequest restituirà una lista di cookie che consigliamo di aggiornare sul lato client.
  7. Imposta i cookie consigliati nelle intestazioni di risposta per indicare al browser del client di memorizzarli.
  8. Invoca varie API fornite come getFbc(), getFbp(), getClientIpAddress() e getNormalizedAndHashedPII()
  9. L'SDK restituirà diversi valori come fbc, fbp, client_ip_address, email e phone number.
  10. Invia di nuovo questi valori recuperati a Meta attraverso l'API Conversions.