Verwijzing naar satellietobject

Dit document fungeert als referentie voor het client-side _satellite -object en de verschillende functies die u ermee kunt uitvoeren.

track

Code

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

Voorbeeld

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

track brandt alle regels gebruikend het Directe gebeurtenistype van de Vraag dat met het bepaalde herkenningsteken van de de markeringsuitbreiding van de Kern is gevormd. Het bovenstaande voorbeeld brengt alle regels teweeg gebruikend een Directe gebeurtenistype van de Vraag waar het gevormde herkenningsteken contact_submit is. Er wordt ook een optioneel object met gerelateerde informatie doorgegeven. U kunt het detailobject openen door %event.detail% in een tekstveld in te voeren in een voorwaarde of handeling of event.detail in de code-editor in een aangepaste codevoorwaarde of handeling.

getVar

Code

_satellite.getVar(name: string) => *

Voorbeeld

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

In het gegeven voorbeeld, als een gegevenselement met een passende naam bestaat, zal de waarde van het gegevenselement zijn teruggekeerd. Als er geen overeenkomend gegevenselement bestaat, wordt gecontroleerd of er eerder een aangepaste variabele met een overeenkomende naam is ingesteld met _satellite.setVar() . Als een aangepaste variabele wordt gevonden, wordt de waarde ervan geretourneerd.

Wanneer een gebeurtenis een regel activeert, kunt u als volgt het overeenkomende event -object van de regel aan _satellite.getVar() doorgeven:

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

setVar

Code

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

Voorbeeld

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

setVar() stelt een aangepaste variabele met een bepaalde naam en waarde in. De waarde van de variabele kan later worden benaderd met _satellite.getVar() .

U kunt optioneel meerdere variabelen tegelijk instellen door een object door te geven waarin de sleutels variabelenamen zijn en de waarden de respectievelijke variabelewaarden zijn.

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

getVisitorId

Code

_satellite.getVisitorId() => Object

Voorbeeld

var visitorIdInstance = _satellite.getVisitorId();

Als de extensie Adobe Experience Cloud ID op de eigenschap is geïnstalleerd, retourneert deze methode de instantie van de bezoeker-id. Zie de documentatie van de Dienst van identiteitskaart van het Experience Cloudvoor meer informatie.

logger

Code

_satellite.logger.log(message: string)

_satellite.logger.info(message: string)

_satellite.logger.warn(message: string)

_satellite.logger.error(message: string)

Voorbeeld

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

Met het logger -object kan een bericht worden aangemeld bij de browserconsole. Het bericht wordt alleen weergegeven als foutopsporing van tags is ingeschakeld door de gebruiker (door _satellite.setDebug(true) aan te roepen of een geschikte browserextensie te gebruiken).

Waarschuwingen bij deponering van registratie

_satellite.logger.deprecation(message: string)

Voorbeeld

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

Dit registreert een waarschuwing aan de browser console. Het bericht wordt weergegeven of foutopsporing van tags al dan niet is ingeschakeld door de gebruiker.

cookie cookie

_satellite.cookie bevat functies voor het lezen en schrijven van cookies. Het is een belichte kopie van de externe bibliotheek js-cookie. Voor details op geavanceerder gebruik van deze bibliotheek, te herzien gelieve de js-koekjesdocumentatie.

Een cookie instellen cookie-set

Gebruik _satellite.cookie.set() om een cookie in te stellen.

Code

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

Voorbeeld

Met de volgende functieaanroep wordt een cookie geschreven die in een week verloopt.

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

Een cookie ophalen cookie-get

Gebruik _satellite.cookie.get() om een cookie op te halen.

Code

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

Voorbeeld

De volgende functieaanroep leest een eerder ingesteld cookie.

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

Een cookie verwijderen cookie-remove

Als u een cookie wilt verwijderen, gebruikt u _satellite.cookie.remove() .

Code

_satellite.cookie.remove(name: string)

Voorbeeld

De volgende functieaanroep verwijdert een eerder ingestelde cookie.

_satellite.cookie.remove('product');

buildInfo

Code

_satellite.buildInfo

Dit object bevat informatie over de build van de huidige tagruntimebibliotheek. Het object bevat de volgende eigenschappen:

turbineVersion

Dit verstrekt de Turbineversie die binnen de huidige bibliotheek wordt gebruikt.

turbineBuildDate

ISO 8601 datum toen de versie van Turbinebinnen de container werd gebruikt werd gebouwd.

buildDate

De ISO 8601-datum waarop de huidige bibliotheek is gemaakt.

In dit voorbeeld worden de objectwaarden getoond:

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

environment

Dit object bevat informatie over de omgeving waarin de huidige tagruntime-bibliotheek wordt geïmplementeerd.

Code

_satellite.environment

Het object bevat de volgende eigenschappen:

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

notify

Code

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

Voorbeeld

_satellite.notify('Hello world!');

notify geeft een bericht weer aan de browserconsole. Het bericht wordt alleen weergegeven als foutopsporing van tags is ingeschakeld door de gebruiker (door _satellite.setDebug(true) aan te roepen of een geschikte browserextensie te gebruiken).

Een facultatief registrerenniveau kan worden overgegaan dat het stileren en het filtreren van het bericht zal beïnvloeden dat wordt geregistreerd. De ondersteunde niveaus zijn als volgt:

3 - Informatieberichten.

4 - Waarschuwingsberichten.

5 - Foutberichten.

Als u geen registrerenniveau verstrekt of geen andere niveauwaarde overgaat, zal het bericht als regelmatig bericht worden geregistreerd.

setCookie setCookie

Code

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

Voorbeeld

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

Hiermee wordt een cookie ingesteld in de browser van de gebruiker. Het cookie blijft gedurende het opgegeven aantal dagen aanwezig.

readCookie

Code

_satellite.readCookie(name: string) => string

Voorbeeld

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

Dit leest een koekje van browser van de gebruiker.

removeCookie

Code

_satellite.removeCookie(name: string)

Voorbeeld

_satellite.removeCookie('product');

Hierdoor wordt een cookie verwijderd uit de browser van de gebruiker.

Foutopsporingsfuncties

De volgende functies zijn niet toegankelijk via de productiecode. Ze zijn alleen bedoeld voor foutopsporingsdoeleinden en worden na verloop van tijd aangepast.

container

Code

_satellite._container

Voorbeeld

monitor

Code

_satellite._monitors

Voorbeeld

Steekproef

Voeg op uw webpagina met een tagbibliotheek een codefragment toe aan de HTML. Doorgaans wordt de code in het element <head> ingevoegd vóór het element <script> dat de tagbibliotheek laadt. Hierdoor kan de monitor de vroegste systeemgebeurtenissen afvangen die in de tagbibliotheek voorkomen. Bijvoorbeeld:

<!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>

In het eerste scriptelement wordt, omdat de tagbibliotheek nog niet is geladen, het eerste _satellite -object gemaakt en wordt een array op _satellite._monitors geïnitialiseerd. Het script voegt vervolgens een monitorobject aan die array toe. Het monitorobject kan de volgende methoden opgeven, die later door de tagbibliotheek worden aangeroepen:

ruleTriggered

Deze functie wordt aangeroepen nadat een gebeurtenis een regel activeert, maar voordat de voorwaarden en handelingen van de regel zijn verwerkt. Het gebeurtenisobject dat aan ruleTriggered is doorgegeven, bevat informatie over de regel die is geactiveerd.

ruleCompleted

Deze functie wordt aangeroepen nadat een regel volledig is verwerkt. Met andere woorden, de gebeurtenis heeft plaatsgevonden, alle voorwaarden zijn vervuld en alle handelingen zijn uitgevoerd. Het gebeurtenisobject dat aan ruleCompleted wordt doorgegeven, bevat informatie over de regel die is voltooid.

ruleConditionFailed

Deze functie wordt aangeroepen nadat een regel is geactiveerd en een van de voorwaarden ervan is mislukt. Het gebeurtenisobject dat aan ruleConditionFailed is doorgegeven, bevat informatie over de regel die is geactiveerd en de voorwaarde die is mislukt.

Als ruleTriggered wordt aangeroepen, wordt ruleCompleted of ruleConditionFailed kort daarna aangeroepen.

De monitor testen

In het bovenstaande voorbeeld worden alle drie methoden in de monitor opgegeven. Wanneer ze worden opgeroepen, meldt de monitor relevante informatie. Als u dit wilt testen, stelt u twee regels in de tagbibliotheek in:

Als u de pagina opent in Chrome , opent u de browserconsole en selecteert u de pagina, wordt het volgende weergegeven in de console:

Indien nodig kunnen extra haken of aanvullende informatie aan deze handlers worden toegevoegd.