Admin panel helpers | SegmentStream documentation

Helper functions help you write code faster and with fewer errors, plus, they make your code more readable. They can be used only inside the admin panel to setup variable, event, and script handlers.

_queryParam

Get URL parameter value.

_queryParam(paramName);

Where paramName is the name of the query parameter - type string.

Get the value of the parameter on the page www.test.ru?q=blue%20ball:

_queryParam('q'); // blue%20ball

The _queryParam() function always returns values in lowercase

_cookie

Get cookie value.

_cookie(cookieName);

Where cookieName is the name of the cookie - type string.

Get the GA cookie value:

_cookie('_ga'); // GA1.2.1409919348.1513159051

_get

Safely get any property of an object.

_get(object, path);

Where path is the path inside the object - types string and object respectively.

Get the value of ‘transaction.lineItems’ from a digitalData event object:

_get(event, 'transaction.lineItems'); // lineItems array [...]

_digitalData

Safely get any digitalData property.

_digitalData(path);

Where path is the path inside the digitalData object - type string.

Get the value of ‘transaction.lineItems’ from the digitalData object:

_digitalData('transaction.lineItems'); // lineItems array [...]

_loadPixel

Load tracking pixel. Any number of attributes is supported.

_loadPixel({
  src: 'https://someurl.com/pixel.gif',
  id: 'some_id',
  //...any other attributes
});

Where src is the link to the pixel and id is the ID of the loaded pixel.

Load pixel from https://example.com/pixel.png:

_loadPixel({
  src: 'https://example.com/pixel.png',
  id: 'admit_ad'
});

_loadScript

Load script. Any number of attributes is supported.

_loadScript({
  src: 'https://someurl.com/script.js',
  id: 'some_id',
  //...any other attributes
});

Where src is the link to the script and id is the ID of the script tag.

Load script from https://example.com/script.js:

_loadScript({
  src: 'https://example.com/script.js',
  id: 'google'
});

_loadIframe

Load iframe. Any number of attributes is supported.

_loadIframe({
  src: 'https://someurl.com/iframe.html',
  id: 'some_id',
  //...any other attributes
});

Where src is the link to the iframe and id is the ID of the iframe tag.

Load iframe from https://example.com/window:

_loadIframe({
  src: 'https://example.com/window',
  style: 'display: none;'
});

_loadLink

Load link. Any number of attributes is supported.

_loadLink({
  src: 'https://someurl.com/styles.css',
  type: 'text/css',
  //...any other attributes
});

Where src is the link to the file and type is the type of the resource link.

Load link from https://example.com/style.css:

_loadLink({
  href: 'https://example.com/style.css',
  type: "text/css"
});

_global

Safely get any window property.

_global(path);

Where path is the path inside the window object - type string.

Get the value of window.settings.mobile_app:

_global('settings.mobile_app');

_domQuery

Get an array of elements by CSS-selector.

_domQuery(cssSelector);

Where cssSelector is the CSS-selector - type string.

Get an array of elements which have the ‘logo’ id:

_domQuery('#logo');

The _domQuery() function, and the selectors in the triggers Click and Impression work by the following principle:

if jQuery is not loaded on the website (there is no global window.jQuery object) or jQuery is loaded after SegmentStream (is located further down the HTML page), document.querySelectorAll is used,

if jQuery is loaded on the website, jQuery selectors are used.

_dataLayer

Safely get a GTM dataLayer variable.

_dataLayer(path);

Where path is a path inside a _dataLayer event object - type string.

Get the value of ‘ecommerce.purchase’ from the dataLayer:

_dataLayer('ecommerce.purchase');

_fetch

Get data from a remote server using ajax.

return _fetch(link, function(result) {
  return result;
});

Where link is the route to the server, and result is the data from the server response - types string.

Get data about the cart contents from the ‘/ajax?cart’ link:

return _fetch('/ajax?cart', function(result) {
  return result;
});

_timeout

Delay before the handler returns the result.

return _timeout(delay, function() {
  code
});

Where delay (type number) is the length of the delay in milliseconds, and code is the code that should be executed after the delay.

Send an event with a delay of 1500 milliseconds:

return _timeout(1500, function() {
  return {
    name: 'Event With Timeout';
  }
});

_retry

Try calling a function several times. The function takes 3 arguments, the function to be called, the number of attempts, the interval between the attempts.

_retry(callbackFunction, retryQuantity, retryInterval);

Call callbackFunction every retryInterval milliseconds, if the function throws an error, try again retryQuantity times - types function, number, number respectively.

The arguments retryQuantity and retryInterval are optional, the default interval is 1000 milliseconds, the default number of attempts is 5.

Possible use case: An external library is loaded asynchronously, we don’t know how long it will take to load, so in order to avoid any errors, we will use the following code.

_loadScript({src: 'https://example.com/externalLib.js', id: 'someName'});
_retry(function() {
  window.externalLib.method();
}, 10, 2000);

The code above will load the library using the _loadScript helper, and the _retry helper will call the window.externalLib.method() function every 2000 milliseconds, if the function returns an error, it will try 10 times in total.

This document was last updated on June 5, 2017. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, please let us know!