Developers » Events » Format des events
Format des events
Ce guide n'est disponible que pour des analyses sur l'Analytics Suite Delta
Envoyer des events
Les events sont envoyés via des requêtes GET ou POST, dans le paramètre de querystring events
. Ce paramètre attend un tableau d’objets, chaque objet étant un event.
Exemple:
https://YOURSSLLOG.YOURDOMAINLOG/pixel?s=YOURSITEID&events=[{<eventsObject>}]
Format de l’objet event
Un objet event a le format suivant:
Propriété | Type | Description |
---|---|---|
name | string | Nom de l’event (minuscule) |
data | object | Propriétés du data model de l’event |
Exemple
{ "name": "av.heartbeat", "data": { "av_content_id": "bc35", "av_session_id": "799d9f3b-7307-4113-a260-2e1371e35fe6", "av_content": "Broadchurch 3.5", ... } }
Reference
Paramètre de querystring events
(array)
Les événements sont envoyés dans le paramètre de querystring events
, qui contient un tableau d’objets URI encodé, chacun représentant un événement :
[ EventObject (object), EventObject (object), EventObject (object) ]
EventObject (object)
Un événement doit suivre ce format :
{ "name": EventName (string), "data": EventData (object) }
EventName (string)
Le nom de l’événement doit suivre ces règles :
- minuscule (notre processing mettra automatiquement en minuscule)
- caractères autorisés :
a→z
0→9
.
_
-
- pas d’espace
Exemple: page.display
EventData (object)
L’objet de données doit suivre ce format :
{ PropKey (string): PropValue (any), PropKey (string): PropValue (any) }
PropKey (string)
La clé d’une propriété doit suivre ces règles :
- minuscule (notre processing mettra automatiquement en minuscule)
- caractères autorisés :
a→z
0→9
_
- pas d’espace
- commencer par
a→z
- ne peut pas commencer par :
m_
ouvisit_
- ne peut pas être :
events
- Les objets JSON seront aplatit avec le caractère
_
(e.g:{'page': {'name':'foo'}}
={'page_name':'foo'}
$
sera considéré comme la racine de l’objet parent (ex.:{'page': {'$':'foo'}}
={'page':'foo'}
)
Property type
Afin de typer une propriété, vous pouvez utiliser un préfixe :
s:
→ chaîne de caractèresf:
→ flottantn:
→ entierb:
→ booléend:
→ datea:X:
→ tableau de type X (e.g:a:s:
signifie tableau de chaînes de caractères)
Les propriétés se terminant par _date
, _utc
, _timestamp
et _ts
sont automatiquement typées comme date si le format :
- est de type Timestamp en secondes
- respecte la norme RFC 3339
YYYY-MM-DDTHH:mm:ssZ
Si vous utilisez des méthodes
events
, si le préfixe n’est pas renseigné, le type JSON sera assigné à la propriété :
- chaîne de caractères
- flottant (tout nombre sera considéré comme flottant)
- booléen
- objet (objet JSON)
PropValue (any)
La valeur d’une propriété peut être de n’importe quel type.
Dernière mise à jour : 28/08/2020