Riferimento API Javascript

Riferimento API

Una volta installata inizializzata la libreria Fanplayr 360 avrai accesso a una variabile globale window.fp360.

Questo oggetto avrà le seguenti funzioni.

consent.set

fp360.consent.set(consentKey:string, consentValue:string, {
    purpose: Array<{
        type: string,
        topics?: string[]
    }>
}?);

consent.unset

fp360.consent.unset(consentKey:string, consentValue:string);

flush

fp360.flush(function() {
  // Gli eventi di Fanplayr 360 sono stati tracciati con successo e l'utente può
  // essere reindirizzato a un'altra pagina.
});

identify

fp360.identify({
  [identifyKey: string]: string
})

init

fp360.init({
  writeKey: string
  endpoint: string
  autoStartSession: boolean = false
  batchFlushDelayMs: number = 1000 // 1 second
  sessionDurationMs: number = 45 * 60 * 1000, // 45 minutes
  cookieExpiration: number = 365 // 1 year
  storageKey: string = 'fp360'
  storageType: 'localStorage'
  idMaxAgeMs: number = 60 * 60 * 1000, // 1 hour
  ip: boolean = true
  debug: true | false | 'none' | 'info' | 'verbose' = false
});

page

fp360.page({
    type: string,
    name?: string
})

track

fp360.track(eventName: string, {
    [attributeKey: string]: string | number | boolean | {
        [semanticAttributeKey:string]: string | number | boolean
    }
})

user.set

fp360.user.set({
    [userAttributeKey: string]: string | number | boolean
}, { expires: string, number, Date }?)

Se stai impostando un solo valore puoi richiamarlo in questo modo:

fp360.user.set(
    userAttributeKey: string,
    value: string | number | boolean,
    { expires: string, number, Date }?
)

user.setOnce

fp360.user.setOnce({
    [userAttribute: string]: string | number | boolean
}, { expires: string, number, Date }?)

Se stai impostando un solo valore puoi richiamarlo in questo modo:

fp360.user.setOnce(
    userAttributeKey: string,
    value: string | number | boolean,
    { expires: string, number, Date }?
)

user.unset

Puoi annullare l'impostazione di più valori contemporaneamente:

fp360.user.unset(userAttributeKeys: string[])

O un singolo valore:

fp360.user.unset(userAttributeKey: string)

user.increment

fp360.increment(userAttributeKey: string, value:number = 1)

setConfig

fp360.setConfig({
  writeKey: string
  endpoint: string
  autoStartSession: boolean = false
  batchFlushDelayMs: number = 1000 // 1 second
  sessionDurationMs: number = 45 * 60 * 1000, // 45 minutes
  cookieExpiration: number = 365 // 1 year
  storageKey: string = 'fp360'
  storageType: 'localStorage'
  idMaxAgeMs: number = 60 * 60 * 1000, // 1 hour
  ip: boolean = true
  debug: true | false | 'none' | 'info' | 'verbose' = false
});

setSessionId

fp360.setSessionId(sessionId: string)

setUserId

fp360.setUserId(uniqueUserId: string);

Riferimento Configurazione

{
  // La chiave di scrittura generata da un'integrazione della Sorgente.
  writeKey: string
  // L'endpoint di tracciamento da utilizzare, varierà a seconda della regione di archiviazione dei dati.
  endpoint: string
  // Se abilitare il logging di debug nella console del browser.
  // I valori `false` e `'none'` disattivano il debugging
  debug: true | false | 'none' | 'info' | 'verbose' = false
  // Impostare su `false` se utilizzato con Fanplayr Targeting.
  autoStartSession: boolean = true
  // Il ritardo prima di inviare batch di dati di tracciamento.
  batchFlushDelayMs: number = 1000 // 1 second
  // Quanto a lungo dovrebbe durare una sessione dopo l'ultimo evento.
  sessionDurationMs: number = 45 * 60 * 1000, // 45 minutes
  // Quanto a lungo dovrebbe durare il cookie - la maggior parte dei browser ignorerà questo.
  cookieExpiration: number = 365 // 1 year
  // La chiave in localStorage per memorizzare i dati locali di Fanplayr 360.
  storageKey: string = 'fp360'
  // Dove memorizzare i dati locali.
  storageType: 'localStorage'
  // La durata massima per memorizzare nella cache le chiamate a `identify()`. Questa cache previene
  // richieste non necessarie quando l'API `identify()` viene ripetuta con lo stesso input.
  idMaxAgeMs: number = 60 * 60 * 1000, // 1 hour
  // Quando abilitato, Fanplayr utilizzerà l'indirizzo IP del client per determinare la geolocalizzazione.
  ip: boolean = true
}