DocsSzybki start
Zainstaluj agenta Nodale na swojej witrynie
Jeden tag script umieszcza agenta Nodale na twojej witrynie. Gdzie go wkleić, na co witryna musi zezwalać i jak sprawdzić, że działa.
Agent Nodale działa na twojej witrynie dzięki jednemu tagowi script. Ta strona jest dla dewelopera, który go instaluje. Aby sterować agentem z własnego kodu, przeczytaj JavaScript API.
Zanim zaczniesz
W twojej przestrzeni roboczej Nodale muszą być spełnione dwa warunki, inaczej tag nic nie robi:
- Agent jest opublikowany i online. Karta Install twojego agenta pokazuje linię do wklejenia dopiero wtedy, gdy agent jest opublikowany, a jego wdrożenie aktywne.
- Twoja witryna jest zadeklarowana. Dodaj jej adres w sekcji Allowed websites, na tej samej karcie. Zasady są poniżej.
Wklej tag
<script src="https://tag.nodale.app/v1/tag.js" data-workspace="YOUR_WORKSPACE_ID" async></script>
Skopiuj linię z karty Install: zawiera już identyfikator twojej przestrzeni roboczej. Wklej ją na każdej stronie, na której chcesz mieć agenta, w <head> albo tuż przed </body>.
- Jedna linia na przestrzeń roboczą, wklejona raz. Tag odczytuje bieżącą konfigurację twojej przestrzeni roboczej przy każdym załadowaniu strony. Publikacja nowej wersji agenta lub zmiana jego wyświetlania dociera na każdą stronę, a nikt nie musi dotykać witryny.
- Uruchamia się raz na stronę. Wklejenie go dwa razy albo załadowanie go z menedżera tagów oprócz samej strony niczemu nie szkodzi: druga kopia widzi pierwszą i się zatrzymuje.
- Aplikacje jednostronicowe są obsługiwane. Agent pozostaje zamontowany, gdy twoja aplikacja nawiguje przez
pushState,replaceStatelubpopstate. - Język. Widget przyjmuje język strony z
<html lang>. Aby ustawić go samodzielnie, dodaj do tagudata-lang, na przykładdata-lang="fr". - Jedna przestrzeń robocza na stronę. Strona uruchamia jeden tag.
Dozwolone witryny
Tag odpowiada tylko na witrynach, które deklaruje twoja przestrzeń robocza. Na każdej innej witrynie nic nie jest dodawane do strony.
- Wpis to origin, ze schematem i portem:
https://www.example.com. Nie ma ścieżki. - Tylko
https, z wyjątkiemlocalhosti127.0.0.1do pracy lokalnej. https://*.example.comobejmuje każdą subdomenę, na dowolnej głębokości, ale nie samoexample.com. Domenę główną zadeklaruj osobnym wpisem.- Najwyżej 20 witryn na przestrzeń roboczą.
- Zmiana nie wymaga publikacji. Usunięta witryna przestaje pokazywać agenta przy następnym załadowaniu strony przez odwiedzającego.
Gdzie wyświetla się agent
Wyświetlanie to ustawienie karty Install, a nie tagu:
- Floating bar: pływający pasek u dołu strony.
- Button: przycisk uruchamiający w prawym dolnym rogu, który otwiera widget po kliknięciu.
Aby zamiast tego umieścić agenta we własnym układzie strony, dodaj ten element tam, gdzie chcesz. Widget montuje się w pierwszym, który znajdzie, w układzie strony, niezależnie od ustawienia wyświetlania:
<div data-nodale-agent></div>
Trzecie wyświetlanie, hidden, trzyma agenta poza widokiem, dopóki twój kod go nie otworzy. Jest opisane w JavaScript API.
Content Security Policy
Witryna, która wysyła Content Security Policy, dodaje dokładnie trzy źródła do dyrektyw, które już ma:
script-src https://tag.nodale.app;
frame-src https://nodale.app;
connect-src https://nodale.app
- Bez
'unsafe-inline', bez'unsafe-eval', bez symbolu wieloznacznego i bez nonce: tag to zewnętrzny skrypt bez kodu inline. - Bez wpisu
style-src,img-src,font-srcanimedia-src: wszystko, co renderuje widget, ładuje się w jego własnej ramce. require-trusted-types-for 'script'jest zgodne.frame-srcprzechodzi awaryjnie nachild-src, a następnie nadefault-src.
Mikrofon
Głos wymaga mikrofonu, a przeglądarka prosi o niego dopiero wtedy, gdy odwiedzający naciśnie przycisk mikrofonu, nigdy przy ładowaniu strony.
Jeśli twoja witryna wysyła nagłówek Permissions-Policy, nie może on odmawiać widgetowi dostępu do mikrofonu. Pomiń microphone albo zezwól na origin Nodale:
Permissions-Policy: microphone=(self "https://nodale.app")
Banery cookies
Narzędzie do zarządzania zgodami, które automatycznie blokuje skrypty, musi wyłączyć tag Nodale z blokady albo zaliczyć go do kategorii, którą twoja przestrzeń robocza wybrała dla śledzenia wizyt. Zablokowany tag nie może pokazać agenta.
Śledzenie wizyt jest domyślnie wyłączone. Gdy je włączysz, odsłony stron są liczone dopiero po tym, jak odwiedzający wyrazi zgodę. Tag odczytuje odpowiedź z twojego banera cookies; witryna, która go nie ma, zgłasza ją przez nodale('consent'). Sam agent jest montowany w obu przypadkach.
Sprawdź instalację
Otwórz kartę Install. Karta Tag on your sites wymienia każdą zadeklarowaną witrynę jako Detected lub Not detected, z czasem, kiedy tag był ostatnio widziany. Check again odczytuje stronę główną każdej witryny.
Jeśli agent nie wyświetla się na stronie, sprawdź w tej kolejności:
- Witryna jest w Allowed websites, z dokładnym schematem i subdomeną.
- Agent jest opublikowany, a jego wdrożenie jest online.
- Content Security Policy strony zawiera trzy źródła podane wyżej.
- Żadne narzędzie do zarządzania zgodami nie blokuje skryptu.
Tag nigdy nie zapisuje błędu na twojej stronie. Gdy się zatrzymuje, zostawia jedną linię console.debug zaczynającą się od nodale tag:.