Přejít na obsah
Pandus
Dokumentace Pandus SDK

JavaScript API

Fronta příkazů pandus(): vlastní události, e-commerce GA4, hashované ID uživatele, vlastnosti uživatele a souhlas, s pravidly pro názvy a limity.

Aktualizováno:

Všechna volání jdou přes jednu funkci, pandus(). Před první volání přidejte tento řádek, aby volání před načtením skriptu čekala ve frontě:

window.pandus = window.pandus || function () { (pandus.q = pandus.q || []).push(arguments); };

Kromě consent žádné volání nic nedělá, dokud návštěvník nesouhlasí s analytikou.

Vlastní události

pandus('event', 'signup', { plan: 'pro' });
pandus('event', 'newsletter_subscribe', { place: 'footer' });
  • Název: snake_case, začíná písmenem, až 40 znaků (a-z, 0-9, _).
  • Parametry: až 25; názvy do 40 znaků; hodnoty jsou čísla, true/false nebo text do 300 znaků.
  • Text, který vypadá jako e-mail, telefon nebo číslo karty, se zahodí v prohlížeči a znovu na našem serveru. Do událostí nikdy nedávejte osobní údaje.
  • Názvy, které SDK posílá samo, jako page_view nebo purchase, jsou v přehledu událostí.

E-commerce

pandus('ecommerce', 'purchase', {
  transaction_id: 'A-1042',
  value: 2190,
  currency: 'CZK',
  items: [{ item_id: 'kettle-1', item_name: 'Konvice', price: 2190, quantity: 1 }],
});

ecommerce přijímá doporučené události GA4; value a currency jdou do vlastních sloupců, aby tržby seděly. items obsahuje až 50 produktů. Všechny události a parametry jsou v části E-commerce.

ID uživatele

pandus('identify', 'customer-48151');

ID spojí návštěvy jednoho přihlášeného zákazníka napříč zařízeními. SDK ho zahashuje SHA-256 v prohlížeči, než opustí stránku; pokud předáte už hotový hash SHA-256, použije se beze změny. E-maily a hodnoty, které vypadají osobně, se odmítnou. Jen se souhlasem.

Vlastnosti uživatele

pandus('set', 'user_properties', { tier: 'gold', plan: 'b2b' });

Až 10 vlastností na návštěvníka, názvy do 24 znaků, textové hodnoty do 36 znaků. Popisují skupinu, nikdy člověka: žádná jména, e-maily ani ID.

Souhlas

pandus('consent', { analytics: true, recordings: false }); // volba návštěvníka
pandus('consent', 'open');                                 // otevřít lištu Pandus

Kdy to použít, popisuje část Souhlas.

Události z vašeho serveru

Objednávky a vrácení z backendu jdou přes endpoint serverových událostí, aby je blokovač v prohlížeči neztratil.

Balíček npm

@pandus/sdk nabízí stejné příkazy jako typované funkce. Zdrojový kód je pod MIT na GitHubu; balíček je na npm.

Funkce Co dělá
init({ site, host?, nonce?, debug? }) Přidá zavaděč jednou; false na serveru, pro špatný token nebo když už na stránce je
consent({ analytics, recordings? }) Předá volbu návštěvníka z vaší lišty
openConsent() Znovu otevře lištu souhlasu Pandus
track(name, params?) Vlastní událost
ecommerce(name, params?) Událost e-commerce nebo leadu GA4
identify(userId) Vaše ID uživatele, zahashované v prohlížeči
setUserProperties(props) Až 10 vlastností uživatele
debug(on = true) Ladicí režim pro tuto kartu
isLoaded() Zda zavaděč běží
pandus(...args) Libovolný surový příkaz SDK
import { init, track, ecommerce } from '@pandus/sdk';

init({ site: 'YOUR_SITE_TOKEN' });
track('signup', { plan: 'pro' });

React a Next.js

// app/providers.tsx
'use client';
import { PandusProvider } from '@pandus/sdk/react';

export function Providers({ children }: { children: React.ReactNode }) {
  return <PandusProvider site="YOUR_SITE_TOKEN">{children}</PandusProvider>;
}
import { usePandus } from '@pandus/sdk/react';

export function SignupButton() {
  const { track } = usePandus();
  return <button onClick={() => track('signup', { plan: 'pro' })}>Sign up</button>;
}

Vue a Nuxt

// main.ts (Vue) or plugins/pandus.client.ts (Nuxt)
import { PandusPlugin } from '@pandus/sdk/vue';

app.use(PandusPlugin, { site: 'YOUR_SITE_TOKEN' });
import { usePandus } from '@pandus/sdk/vue';

const { track } = usePandus();
track('signup', { plan: 'pro' });

Content Security Policy

S Content Security Policy založenou na nonce ho předejte přes init({ site, nonce }); zavaděč pak moduly přidá sám, což 'strict-dynamic' povoluje. Jinak povolte:

script-src  https://pandus.online
connect-src https://pandus.online https://e.pandus.online

Pandus SDK i skener jsou automatické kontroly, ne úplný audit a ne právní poradenství. SDK na webu nic nemění a nezjišťuje, kteří návštěvníci používají asistivní technologie.