A Search Modul API leírása az UserMachine rendszerhez.
A Search modul a search event-eken keresztül kapja az adatokat, a meghatározott paraméterekkel.
FindGoreNativeClient::sendEvent(
$user,
$password,
$domain,
'search',
array(
...
)
);A $user és $password változók az API user authentikációs adatait tartalmazzák, a $domain pedig az a domain, amibe az eseményt kell küldeni (tipikusan a $_SERVER['HTTP_HOST'] ). Az utolsó, tömb típusú paraméter tartalmazza a konkrét esemény paramétereit.
FindGoreUrlTrack.sendEvent(
'search',
{
...
}
);Az utolsó, objektum típusú paraméter tartalmazza a konkrét esemény paramétereit.
A következő folyamatok példák, a kereső motor működésétől, illetve a user viselkedésétől függően egyes elemek eltűnhetnek, vagy ismétlődhetnek, illetve új folyamatok is létrejöhetnek.
User belekattint a kereső mezőbe (keresési folyamat indítása)
User beírja a kereső szavakat (gépelés kereső mezőben)
User rákattint a keresés gombra (keresés manuálisan)
User megkapja a találati listát (találati lista megjelenítése)
User megnyit egy elemet (elem megnyitása)
User belekattint a kereső mezőbe (keresési folyamat indítása)
User beírja a kereső szavakat (gépelés kereső mezőben)
User rákattint a keresés gombra (keresés manuálisan)
User megkapja az üres találati listát (üres találati lista megjelenítése)
User belekattint a kereső mezőbe (keresési folyamat indítása)
User elkezdi beírni a kereső szavakat (gépelés kereső mezőben)
User kap egy automata kulcsszó ajánlást (kulcsszó ajánlás)
User rákattint az automata kulcsszó ajánlásra (kulcsszó ajánlás elfogadása)
User megkapja a találati listát (találati lista megjelenítése)
User megnyit egy elemet (elem megnyitása)
User belekattint a kereső mezőbe (keresési folyamat indítása)
User elkezdi beírni a kereső szavakat (gépelés kereső mezőben)
User kap egy automata kulcsszó ajánlást (kulcsszó ajánlás)
User rákattint az automata kulcsszó ajánlásra (kulcsszó ajánlás elfogadása)
User megkapja az üres találati listát (üres találati lista megjelenítése)
User belekattint a kereső mezőbe (keresési folyamat indítása)
User elkezdi beírni a kereső szavakat (gépelés kereső mezőben)
User kap egy üres automata kulcsszó ajánlást (sikertelen kulcsszó ajánlás)
Az itt található példák JavaScript szintaxisban szerepelnek.
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
step:'start',
source: 'input'
}
);Ezt az eseményt akár minden egyes karakter leütésnél lehet küldeni, amennyiben mérés szempontjából ennek van haszna. Amennyiben automata kulcsszó ajánlás is van, de az karakterszámhoz van kötve (pl 3 karakter alatt nincs ajánlás), érdemes ennek az eseménynek a küldését is ehhez a logikához igazítani.
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part:'typing',
source: 'input',
term: searchInput.value
}
);term
Ezt az eseményt akkor kell küldeni, amikor a user kapott egy automata kulcsszó ajánlást az általa beírt kereső szó alapján.
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part:'autocomplete',
source: 'input',
term: searchInput.value,
result: 'success'
}
);Ezt az eseményt akkor kell küldeni, amikor a user kapott volna egy automata kulcsszó ajánlást, de nem sikerült találni semmit az általa beírt kereső szó alapján.
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part:'autocomplete',
source: 'input',
term: searchInput.value,
result: 'fail'
}
);Ezt az eseményt akkor kell küldeni, amikor a user kapott egy automata kulcsszó ajánlást, és azon lekattintott egy konkrét elemet.
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part:'autocomplete',
source: 'input',
term: searchInput.value,
item: itemValue,
result: 'accept'
}
);Ezt az eseményt akkor kell küldeni, amikor a user manuálisan elindította a keresést.
Például:
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part: 'manual',
source: 'input',
term: searchInput.value
}
);Ezt az eseményt akkor kell küldeni, amikor a user a keresést elindítva kapott egy találati listát.
Például:
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part:'resultlist',
term: searchInput.value,
result: 'success'
}
);Ezt az eseményt akkor kell küldeni, amikor a user a keresést elindítva kapott egy üres találati listát.
Emellett az esemény mellett kötelezően küldeni kell egy ‘Keresési folyamat befejezése’ eseményt is.
Például:
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part: 'resultlist',
term: searchInput.value,
result: 'fail'
}
);Ezt az eseményt akkor kell küldeni, amikor a user megnyitott egy konkrét elemet a találati listán.
Emellett az esemény mellett kötelezően küldeni kell egy ‘Keresési folyamat befejezése’ eseményt is.
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
part: 'item',
term: searchInput.value,
item: itemValue,
position: itemPosition
}
);Akkor kell küldeni, amikor biztosan vége van az aktuális keresési folyamatnak.
Például:
Példa kód:
FindGoreUrlTrack.sendEvent(
'search',
{
step:'done'
}
);