Satellitobjektreferens

Det här dokumentet fungerar som referens för klientsidesobjektet _satellite och de olika funktioner du kan utföra med det.

track

Kod

_satellite.track(identifier: string [, detail: *] )

Exempel

_satellite.track('contact_submit', { name: 'John Doe' });

track utlöser alla regler med händelsetypen för direktanrop som har konfigurerats med den angivna identifieraren från Core-taggtillägget. Exemplet ovan utlöser alla regler med en Direct Call-händelsetyp där den konfigurerade identifieraren är contact_submit. Ett valfritt objekt som innehåller relaterad information skickas också. Du kommer åt detaljobjektet genom att ange %event.detail% i ett textfält i ett villkor eller en åtgärd eller event.detail i kodredigeraren i ett villkor eller en åtgärd för anpassad kod.

getVar

Kod

_satellite.getVar(name: string) => *

Exempel

var product = _satellite.getVar('product');

I det angivna exemplet returneras dataelementets värde om det finns ett dataelement med ett matchande namn. Om det inte finns något matchande dataelement kommer det att kontrollera om en anpassad variabel med ett matchande namn tidigare har angetts med _satellite.setVar(). Om en matchande anpassad variabel hittas returneras dess värde.

När en händelse utlöser en regel kan du skicka regelns motsvarande event-objekt till _satellite.getVar() på följande sätt:

// event refers to the calling rule's event
var rule = _satellite.getVar('return event rule', event);

setVar

Kod

_satellite.setVar(name: string, value: *)

Exempel

_satellite.setVar('product', 'Circuit Pro');

setVar() anger en anpassad variabel med ett angivet namn och värde. Värdet för variabeln kan sedan nås med _satellite.getVar().

Du kan också ange flera variabler samtidigt genom att skicka ett objekt där nycklarna är variabelnamn och värdena är respektive variabelvärde.

_satellite.setVar({ 'product': 'Circuit Pro', 'category': 'hobby' });

getVisitorId

Kod

_satellite.getVisitorId() => Object

Exempel

var visitorIdInstance = _satellite.getVisitorId();

Om tillägget Adobe Experience Cloud ID är installerat på egenskapen returnerar den här metoden instansen av Visitor-ID. Mer information finns i Experience Cloud ID-tjänstdokumentationen.

logger

Kod

_satellite.logger.log(message: string)

_satellite.logger.info(message: string)

_satellite.logger.warn(message: string)

_satellite.logger.error(message: string)

Exempel

_satellite.logger.error('No product ID found.');

Objektet logger tillåter att ett meddelande loggas till webbläsarkonsolen. Meddelandet visas bara om taggfelsfunktionen är aktiverad av användaren (genom att anropa _satellite.setDebug(true) eller använda ett lämpligt webbläsartillägg).

Varningar om borttagning av loggning

_satellite.logger.deprecation(message: string)

Exempel

_satellite.logger.deprecation('This method is no longer supported, please use [new example] instead.');

Detta loggar en varning till webbläsarkonsolen. Meddelandet visas oavsett om taggfelsfunktionen är aktiverad av användaren eller inte.

cookie cookie

_satellite.cookie innehåller funktioner för att läsa och skriva cookies. Det är en exponerad kopia av tredjepartsbiblioteket js-cookie. Mer information om mer avancerad användning av det här biblioteket finns i js-cookie-dokumentationen.

Ange en cookie cookie-set

Använd _satellite.cookie.set() om du vill ange en cookie.

Kod

_satellite.cookie.set(name: string, value: string[, attributes: Object])

Exempel

Följande funktionsanrop skriver en cookie som upphör att gälla om en vecka.

_satellite.cookie.set('product', 'Circuit Pro', { expires: 7 });

Hämta en cookie cookie-get

Använd _satellite.cookie.get() om du vill hämta en cookie.

Kod

_satellite.cookie.get(name: string) => string

Exempel

Följande funktionsanrop läser en tidigare angiven cookie.

var product = _satellite.cookie.get('product');

Ta bort en cookie cookie-remove

Använd _satellite.cookie.remove() om du vill ta bort en cookie.

Kod

_satellite.cookie.remove(name: string)

Exempel

Följande funktionsanrop tar bort en tidigare angiven cookie.

_satellite.cookie.remove('product');

buildInfo

Kod

_satellite.buildInfo

Det här objektet innehåller information om bygget av det aktuella biblioteket för tagg-körning. Objektet innehåller följande egenskaper:

turbineVersion

Detta innehåller den turbinversion som används i det aktuella biblioteket.

turbineBuildDate

ISO 8601-datumet när versionen av turbin som används i behållaren skapades.

buildDate

ISO 8601-datumet när det aktuella biblioteket skapades.

I det här exemplet visas objektvärdena:

{
  turbineVersion: "14.0.0",
  turbineBuildDate: "2016-07-01T18:10:34Z",
  buildDate: "2016-03-30T16:27:10Z"
}

environment

Det här objektet innehåller information om den miljö som det aktuella taggredigeringsbiblioteket är distribuerat till.

Kod

_satellite.environment

Objektet innehåller följande egenskaper:

{
  id: "ENbe322acb4fc64dfdb603254ffe98b5d3",
  stage: "development"
}

notify

Kod

_satellite.notify(message: string[, level: number])

Exempel

_satellite.notify('Hello world!');

notify loggar ett meddelande till webbläsarkonsolen. Meddelandet visas bara om taggfelsfunktionen är aktiverad av användaren (genom att anropa _satellite.setDebug(true) eller använda ett lämpligt webbläsartillägg).

Du kan skicka en loggningsnivå som kan påverka formatering och filtrering av meddelandet som loggas. Följande nivåer stöds:

3 - Informationsmeddelanden.

4 - Varningsmeddelanden.

5 - Felmeddelanden.

Om du inte anger någon loggningsnivå eller skickar något annat nivåvärde loggas meddelandet som ett vanligt meddelande.

setCookie setCookie

Kod

_satellite.setCookie(name: string, value: string, days: number)

Exempel

_satellite.setCookie('product', 'Circuit Pro', 3);

Detta ställer in en cookie i användarens webbläsare. Cookien kvarstår i det angivna antalet dagar.

readCookie

Kod

_satellite.readCookie(name: string) => string

Exempel

var product = _satellite.readCookie('product');

Detta läser en cookie från användarens webbläsare.

removeCookie

Kod

_satellite.removeCookie(name: string)

Exempel

_satellite.removeCookie('product');

Detta tar bort en cookie från användarens webbläsare.

Felsökningsfunktioner

Följande funktioner ska inte kommas åt från produktionskoden. De är endast avsedda för felsökning och kommer att ändras med tiden efter behov.

container

Kod

_satellite._container

Exempel

monitor

Kod

_satellite._monitors

Exempel

Exempel

Lägg till ett kodfragment på HTML på din webbsida som kör ett taggbibliotek. Normalt infogas koden i elementet <head> före elementet <script> som läser in taggbiblioteket. På så sätt kan övervakaren fånga upp de tidigaste systemhändelserna som inträffar i taggbiblioteket. Exempel:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Title</title>
  <script>
    window._satellite = window._satellite || {};
    window._satellite._monitors = window._satellite._monitors || [];
    window._satellite._monitors.push({
      ruleTriggered: function (event) {
        console.log(
          'rule triggered',
          event.rule
        );
      },
      ruleCompleted: function (event) {
        console.log(
          'rule completed',
          event.rule
        );
      },
      ruleConditionFailed: function (event) {
        console.log(
          'rule condition failed',
          event.rule,
          event.condition
        );
      }
    });
  </script>
  <script src="//assets.adobedtm.com/launch-EN5bfa516febde4b22b3e7c6f96f6b439f.min.js"
          async></script>
</head>
<body>
  <h1>Click me!</h1>
</body>
</html>

I det första skriptelementet skapas det ursprungliga _satellite-objektet och en array på _satellite._monitors initieras eftersom taggbiblioteket inte har lästs in ännu. Skriptet lägger sedan till ett övervakarobjekt i den arrayen. Övervakningsobjektet kan ange följande metoder som senare anropas av taggbiblioteket:

ruleTriggered

Den här funktionen anropas efter att en händelse utlöser en regel, men innan regelns villkor och åtgärder har bearbetats. Händelseobjektet som skickades till ruleTriggered innehåller information om regeln som utlöstes.

ruleCompleted

Den här funktionen anropas efter att en regel har bearbetats fullständigt. Händelsen har med andra ord inträffat, alla villkor har skickats och alla åtgärder har utförts. Händelseobjektet som skickades till ruleCompleted innehåller information om regeln som slutfördes.

ruleConditionFailed

Den här funktionen anropas efter att en regel har utlösts och ett av dess villkor har misslyckats. Händelseobjektet som skickades till ruleConditionFailed innehåller information om regeln som utlöstes och villkoret som misslyckades.

Om ruleTriggered anropas kommer antingen ruleCompleted eller ruleConditionFailed att anropas kort därefter.

Testa monitorn

I exemplet ovan anges alla tre metoderna i monitorn. När de anropas loggar övervakaren ut relevant information. Om du vill testa detta ställer du in två regler i taggbiblioteket:

Om du öppnar sidan i Chrome, öppnar webbläsarkonsolen och väljer sidan visas följande i konsolen:

Ytterligare kopplingar eller ytterligare information kan läggas till i dessa hanterare efter behov.