Fanplayr Docs

Italiano

English
日本語
Español

Italiano

English
日本語
Español

Appearance

API Personalizzata ​

Introduzione ​

Potremmo non supportare ancora la vostra piattaforma per l'acquisizione di dati in Fanplayr 360, per questo offriamo una potente API per lavorare direttamente con il nostro sistema per aggiungere dati.

Potete usare l'API personalizzata per inviare dati da un server o da un'applicazione mobile. Le opzioni sono illimitate.

L'API JavaScript utilizza esattamente le stesse chiamate sottostanti.

Invio di Messaggi ​

Una volta creata un'Integrazione personalizzata prima di iniziare, per ottenere una WRITE_KEY e un ENDPOINT che potrete poi utilizzare per inviare dati a Fanplayr 360.

Chiamare l'API è semplice come effettuare una richiesta HTTPS con i seguenti dettagli:

  • URL: https://<ENDPOINT>/v1/collect;
  • Metodo: POST;
  • Headers
    • content-type: application/json;
    • x-api-key: <WRITE_KEY>;
  • Corpo: Una stringa JSON contenente un array di Messaggi.

Esempio di Richiesta ​

WARNING

L'API può gestire messaggi di ~250kb, quindi si consiglia di chiamare l'API con non più di 20 Messaggi in una singola chiamata.

Struttura del Messaggio ​

Ogni messaggio inviato a Fanplayr 360 deve contenere un set di dati di base.

Messaggio di Base ​

  • messageId - Ogni messaggio inviato deve includere un identificatore univoco. Suggeriamo di usare un UUID, nanoID o ulid.
  • writeKey - La WRITE_KEY inviata tramite x-api-key deve essere fornita anche qui.
  • timestamp - L'ora in cui l'evento è avvenuto nel formato ISO-8601 e fuso orario UTC, ad esempio "2023-01-23T15:34:48Z".
  • type - Il tipo di messaggio.
  • userId - Un identificatore univoco per questo utente. Se lo stesso userId viene fornito in una sessione diversa, i messaggi verranno trattati come se provenissero dallo stesso utente. Questo è separato dalla gestione dell'identità tramite chiamate identify.
  • sessionId - Un identificatore univoco per una sessione. Vedere Gestione delle Sessioni per maggiori dettagli.
  • pageId - Un identificatore univoco per la visualizzazione della pagina / schermata corrente. Questo viene utilizzato per collegare gli eventi. Vedere Tracciamento delle Visualizzazioni di Pagina.

La struttura di base del messaggio può includere o meno context, properties, identities e operations a seconda del type inviato.

  • context - può essere usato in qualsiasi tipo di messaggio
  • properties - dovrebbe essere usato solo nei tipi track o page
  • identities - dovrebbe essere usato solo nel tipo identify
  • operations - dovrebbe essere usato solo nei tipi userDataOps e consent

Contesto ​

Il contesto è utilizzato per tracciare informazioni sulla pagina o schermata in cui si trova l'utente, il suo indirizzo IP per la localizzazione e lo userAgent per tracciare il tipo di browser o dispositivo.

  • page
    • url - l'URL della pagina, se si traccia su un sito web.
    • referrer - l'URL della pagina di riferimento, se si traccia su un sito web.
    • type - una stringa che rappresenta la pagina. Qui può essere utilizzato qualsiasi valore, ma alcuni valori aggiungeranno funzionalità - vedere API JavaScript / Traccia Pagine. Può anche essere utilizzato per rappresentare "schermate" in un'app mobile.
    • title - il titolo della pagina del sito web o della schermata dell'app.
  • ipAddress - l'indirizzo IP del dispositivo dell'utente, o del server / dispositivo da cui è stato inviato questo messaggio. Viene utilizzato per generare attributi aggiuntivi come $country.
  • userAgent - la stringa User Agent di un browser, o definita per un tipo di dispositivo come un telefono cellulare. Viene utilizzata per generare attributi aggiuntivi come $device.

Proprietà ​

Le proprietà sono qualsiasi coppia chiave/valore, o Oggetto Semantico, che si desidera tracciare insieme all'evento. Questo dovrebbe essere utilizzato solo con i messaggi di tipo track o page.

INFO

La key per una proprietà può essere qualsiasi valore stringa. Si suggerisce di non iniziare il valore con "$" in quanto ciò potrebbe sovrascrivere gli attributi generati. Potrebbe anche essere buona pratica usare chiavi in camel-case come "myKeyName", e stare lontani dai caratteri non-ASCII poiché alcuni sistemi a cui si esportano i dati potrebbero altrimenti avere problemi.

INFO

Anche se è possibile inviare tipi string, number o boolean, tutti i dati sono memorizzati come stringhe in Fanplayr 360.

Identità ​

Le identità sono coppie chiave/valore che consentono al sistema di sapere come identificare e unire utenti e sessioni. Questo dovrebbe essere fornito solo per il tipo di messaggio identify.

Operazioni ​

Le operazioni dovrebbero essere utilizzate solo con i messaggi di tipo userDataOps e consent. Le proprietà supportate sono diverse per ciascuno.

userDataOps ​

Prossimi passi? ​

Continua a leggere per capire come utilizzare ogni tipo di messaggio, insieme agli esempi.

Copyright © 2011-present Fanplayr Inc