Referencia de la API de Javascript

Referencia de la API

Una vez que haya instalado inicializado la biblioteca Fanplayr 360, tendrá acceso a una variable global window.fp360.

Este objeto tendrá las siguientes funciones.

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() {
  // Los eventos de Fanplayr 360 se han rastreado con éxito y el usuario puede
  // ser navegado a otra página.
});

identify

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

init

fp360.init({
  writeKey: string
  endpoint: string
  autoStartSession: boolean = false
  batchFlushDelayMs: number = 1000 // 1 segundo
  sessionDurationMs: number = 45 * 60 * 1000, // 45 minutos
  cookieExpiration: number = 365 // 1 año
  storageKey: string = 'fp360'
  storageType: 'localStorage'
  idMaxAgeMs: number = 60 * 60 * 1000, // 1 hora
  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 }?)

Si solo está configurando un único valor, puede llamarlo así:

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 }?)

Si solo está configurando un único valor, puede llamarlo así:

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

user.unset

Puede desconfigurar varios valores a la vez:

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

O un único valor:

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 segundo
  sessionDurationMs: number = 45 * 60 * 1000, // 45 minutos
  cookieExpiration: number = 365 // 1 año
  storageKey: string = 'fp360'
  storageType: 'localStorage'
  idMaxAgeMs: number = 60 * 60 * 1000, // 1 hora
  ip: boolean = true
  debug: true | false | 'none' | 'info' | 'verbose' = false
});

setSessionId

fp360.setSessionId(sessionId: string)

setUserId

fp360.setUserId(uniqueUserId: string);

Referencia de Configuración

{
  // La clave de escritura generada a partir de una integración de Source.
  writeKey: string
  // El endpoint de seguimiento a utilizar, que variará según la región de almacenamiento de datos.
  endpoint: string
  // Si se debe habilitar el registro de depuración en la consola del navegador.
  // Los valores `false` y `'none'` desactivan la depuración
  debug: true | false | 'none' | 'info' | 'verbose' = false
  // Establecer en `false` si se utiliza con Fanplayr Targeting.
  autoStartSession: boolean = true
  // El retraso antes de enviar lotes de datos de seguimiento.
  batchFlushDelayMs: number = 1000 // 1 segundo
  // Cuánto tiempo debe durar una sesión después del último evento.
  sessionDurationMs: number = 45 * 60 * 1000, // 45 minutos
  // Cuánto tiempo debe durar la cookie; la mayoría de los navegadores ignorarán esto.
  cookieExpiration: number = 365 // 1 año
  // La clave en localStorage para almacenar datos locales de Fanplayr 360.
  storageKey: string = 'fp360'
  // Dónde almacenar los datos locales.
  storageType: 'localStorage'
  // La duración máxima para almacenar en caché las llamadas a `identify()`. Esta caché evita
  // solicitudes innecesarias cuando la API `identify()` se repite con la misma entrada.
  idMaxAgeMs: number = 60 * 60 * 1000, // 1 hora
  // Cuando está habilitado, Fanplayr utilizará la dirección IP del cliente para determinar la geolocalización.
  ip: boolean = true
}