Aides Javascript server-side
Cet article décrit les API de destination server-side.
decodeURI
Décode tous les caractères encodés dans l’URI fourni. Renvoie une chaîne qui représente l’URI décodé. Renvoie undefined si l’entrée fournie est invalide.
Syntaxe
decodeUri(encoded_uri);Exemple
const decodeUri = require('decodeUri');
const decodedUrl = decodeUri(data.encodedUrl);
if (decodedUrl) {
// ...
}decodeUriComponent
Décode tous les caractères encodés dans le composant d’URI fourni. Renvoie une chaîne qui représente le composant d’URI décodé. Renvoie undefined si l’entrée fournie est invalide.
Syntaxe
decodeUriComponent(encoded_uri_component);Exemple
encoded_uri_component
string
Un composant d’URI encodé avec encodeUriComponent() ou par d’autres moyens.
encodeUri
Renvoie un identifiant uniforme de ressource (URI) encodé en échappant les caractères spéciaux. Renvoie une chaîne qui représente la chaîne fournie, encodée en URI.
Syntaxe
Exemple
uri
string
Un URI complet.
encodeUriComponent
Renvoie un identifiant uniforme de ressource (URI) encodé en échappant les caractères spéciaux. Renvoie une chaîne qui représente la chaîne fournie, encodée en URI.
Syntaxe
Exemple
str
string
Un composant d’URI.
fromBase64
Décode une chaîne encodée en base64. Renvoie undefined si l’entrée est invalide.
Syntaxe
Exemple
base64EncodedString
string
Chaîne encodée en Base64.
generateRandom
Renvoie un nombre (entier) dans la plage indiquée.
Syntaxe
Exemple
min
nombre
Valeur minimale possible de l'entier renvoyé (incluse).
max
nombre
Valeur maximale possible de l'entier renvoyé (incluse).
getAllEventData
Renvoie une copie des données de l’événement.
Syntaxe
Exemple d’utilisation
Exemple de données :
Si vous envoyez cet événement web :
La fonction getAllEventData() renverra alors cet objet :
getCookieValues
Renvoie un tableau contenant les valeurs de tous les cookies portant le nom indiqué.
Syntaxe
Exemple
Paramètres
name
string
Nom du cookie.
noDecode
booléen
Si true, les valeurs du cookie ne seront pas décodées avant d’être renvoyées. La valeur par défaut est false.
getEventData
Renvoie une copie de la valeur située au chemin indiqué dans les données de l’événement. Renvoie undefined s’il n’y a pas de données d’événement ou si aucune valeur n’existe au chemin indiqué.
Syntaxe
Exemple
Paramètres
keyPath
any
Le chemin de la clé, dont les composants sont séparés par des points. Les composants du chemin peuvent être des clés d’un objet ou des indices d’un tableau. Si keyPath n’est pas une chaîne, sa valeur est convertie en chaîne.
getRemoteAddress
Renvoie une string représentation de l’adresse IP à l’origine de la requête, par exemple 62.123.65.780 pour IPv4 ou 2001:0db8:85a3:0:0:8a2e:0370:1234 pour IPv6
Syntaxe
getTimestamp
Obsolète. Utilisez de préférence getTimestampMillis.
Renvoie un number qui représente l’heure actuelle en millisecondes depuis l’époque Unix, telle que renvoyée par Date.now().
Syntaxe
getTimestampMillis
Renvoie un number qui représente l’heure actuelle en millisecondes depuis l’époque Unix, telle que renvoyée par Date.now().
Syntaxe
getType
Renvoie une chaîne décrivant le type de la valeur indiquée.
string
'string'
nombre
'number'
booléen
'boolean'
null
'null'
undefined
'undefined'
Tableau
'array'
Object
'object'
Function
'function'
Syntaxe
Exemple
Paramètres
value
any
Valeur d’entrée.
logToConsole
Affiche son ou ses arguments dans la console.
Ces journaux sont visibles dans la console de Destination Builder.
Exemple
Syntaxe
Paramètres
La fonction accepte un ou plusieurs arguments, convertis chacun en chaîne si nécessaire, puis affichés dans la console.
makeInteger
Convertit la valeur donnée en un nombre (entier).
Syntaxe
Paramètres
value
tout type
Valeur à convertir.
makeNumber
Convertit la valeur donnée en un nombre.
Syntaxe
Paramètres
value
tout type
Valeur à convertir.
makeString
Renvoie la valeur donnée sous forme de chaîne.
Syntaxe
Paramètres
value
tout type
Valeur à convertir.
parseUrl
Renvoie un objet contenant toutes les composantes d’une URL donnée, comme l’objet URL .
Cette API renvoie undefined pour toute URL mal formée. Pour les URL correctement formatées, les champs absents de la chaîne d’URL auront une valeur de chaîne vide, ou, dans le cas de searchParams, un objet vide.
L’objet renvoyé contient les champs suivants :
Syntaxe
Exemple
Paramètres
url
string
L’URL complète qui sera analysée.
sha256
Calcule le condensat SHA-256 de l’entrée et appelle une fonction de rappel avec le condensat encodé en base64, sauf si l’objet options spécifie un encodage de sortie différent.
Cette signature et ce comportement d’API correspondent à l’API sha256 pour les conteneurs Web ; toutefois, dans les conteneurs serveur, les modèles personnalisés doivent utiliser l’API sha256Sync pour simplifier le code.
Syntaxe
Exemple
Paramètres
input
string
La chaîne à hacher.
onSuccess
fonction
Appelée avec le condensat obtenu, encodé en base64, sauf si l’objet options spécifie un encodage de sortie différent.
options
objet
Facultatif Objet options facultatif permettant de spécifier l’encodage de sortie. S’il est spécifié, l’objet doit contenir la clé outputEncoding avec pour valeur l’une des options suivantes : base64 ou hex.
sha256Sync
Calcule et renvoie le condensat SHA-256 de l’entrée, encodé en base64, sauf si l’objet options spécifie un encodage de sortie différent.
Syntaxe
Exemple
Paramètres
input
string
La chaîne à hacher.
options
objet
Facultatif Objet options facultatif permettant de spécifier l’encodage de sortie. S’il est spécifié, l’objet doit contenir la clé outputEncoding avec pour valeur l’une des options suivantes : base64 ou hex.
signHmac
Génère une signature HMAC pour le payload fourni, à l’aide de sha256 et de l’encodage base64 par défaut, sauf si l’objet options spécifie une autre option. Les objets transmis comme payload sont automatiquement convertis en chaîne avec JSON.stringify'd. Renvoie une chaîne.
Syntaxe
Exemple
Paramètres
payload
string|object
Les données à signer. Les objets sont automatiquement convertis en chaînes JSON.
secret
string
La clé secrète utilisée pour générer le HMAC.
options
objet
Facultatif Objet options permettant de personnaliser l’algorithme et l’encodage de sortie. Voir les détails des options ci-dessous.
Options
alg
string
'sha256'
L’algorithme de hachage. Valeurs prises en charge : 'sha256', 'sha1', 'sha512', 'sha384', 'md5' et d’autres algorithmes de hachage OpenSSL.
outputEncoding
string
'base64'
L’encodage de sortie. Valeurs prises en charge : 'base64', 'base64url', 'hex', 'binary' (latin1).
toBase64
Encode une chaîne en base64.
Syntaxe
Exemple
Paramètres
input
string
Chaîne à encoder.
JSON
Renvoie un objet qui fournit des fonctions JSON.
La fonction parse() analyse une chaîne JSON pour construire la valeur ou l’objet qu’elle décrit. Si la valeur ne peut pas être analysée (JSON malformé), la fonction renvoie undefined. Si la valeur d’entrée n’est pas une chaîne, elle est convertie en chaîne.
La fonction stringify() convertit la valeur d’entrée en chaîne JSON. Si la valeur ne peut pas être convertie (par exemple, si l’objet contient un cycle), la méthode renvoie undefined.
Syntaxe
Exemple
Math
Un objet qui fournit des Math fonctions.
Syntaxe
Paramètres
Les paramètres des fonctions Math sont convertis en nombres.
sendHttpGet
Effectue une requête HTTP GET à l'URL spécifiée et appelle une fonction de rappel avec la réponse lorsque la requête se termine ou expire.
Syntaxe
Exemple
Paramètres
url
string
L'URL de la requête.
callback
fonction
Une fonction de rappel facultative à appeler lorsque la requête se termine, échoue ou expire.
Elle est appelée avec le code d'état de la réponse, les en-têtes de la réponse, et le corps de la réponse (ou undefined si la réponse ne comporte pas de corps).
Si la requête échoue (par exemple, URL non valide, absence de route vers l'hôte, échec de la négociation SSL, etc.), la fonction de rappel est appelée avec un code d'état de réponse égal à zéro, aucun en-tête, et un corps undefined.
Si la 'timeout' option a été définie et que la requête a expiré, le callback sera appelé avec un code d’état de réponse de -1, aucun en-tête, et un corps undefined.
options
objet
Options de requête facultatives. Les options prises en charge sont headers, timeout. Des options avancées peuvent être ajoutées dans extraOptions
Options
headers: En-têtes de requête supplémentaires représentés sous forme d’objet.
timeout: Délai d’attente, en millisecondes, avant l’abandon de la requête.
extraOptions: Options avancées (ex. : {strictSSL:true})
sendHttpRequest
Effectue une requête HTTP à l’URL spécifiée et appelle un callback avec la réponse une fois la requête terminée ou expirée.
Syntaxe
Exemple
Paramètres
url
string
L'URL de la requête.
callback
fonction
Une fonction de rappel facultative à appeler lorsque la requête se termine, échoue ou expire. Elle est appelée avec le code d'état de la réponse, les en-têtes de la réponse, et le corps de la réponse (ou undefined si la réponse ne comporte pas de corps). Si la requête échoue (par exemple, URL non valide, absence de route vers l'hôte, échec de la négociation SSL, etc.), la fonction de rappel est appelée avec un code d'état de réponse égal à zéro, aucun en-tête, et un corps undefined. Si l’option 'timeout' a été définie et que la requête a expiré, le callback sera appelé avec un code d’état de réponse de -1, aucun en-tête, et un corps undefined.
options
objet
Options de requête facultatives. Les options prises en charge sont : headers, method, et timeout. Les clés d’option inconnues sont ignorées. Des options avancées peuvent être ajoutées dans extraOptions.
body
string
Corps de requête facultatif.
Options
headers: En-têtes de requête supplémentaires.
method: Méthode de la requête, GET par défaut.
timeout: Délai d’attente, en millisecondes, avant l’abandon de la requête.
extraOptions: Options avancées (ex. : {strictSSL:true})
md5Sync
Calcule et renvoie le md5 digest de l’entrée.
Syntaxe
Exemple
templateDataStorage
Le templateDataStorage helper permet de stocker et de récupérer temporairement des données, comme des jetons API, pendant l’exécution d’un script. Il est particulièrement utile pour mettre en cache des données réutilisables et réduire les appels API redondants. Les données stockées dans templateDataStorage persistent sur le serveur qui exécute le template. Comme les templates s’exécutent sur plusieurs serveurs, et que chaque serveur peut avoir plusieurs instances, il n’est pas garanti que les données stockées soient accessibles lors de toutes les exécutions ultérieures du template.
Syntaxe
Exemple : gestion des jetons API
setItemCopy(key, value)
Stocke une valeur sous la clé spécifiée. Remplace la valeur si la clé existe déjà.
getItemCopy(key)
Récupère la valeur associée à la clé spécifiée. Renvoie undefined si la clé n’existe pas.
removeItemCopy(key)
Supprime la valeur associée à la clé spécifiée.
key
string
Identifiant unique des données à stocker ou à récupérer.
value
any
Les données à stocker (pour setItemCopy).
Mis à jour
Ce contenu vous a-t-il été utile ?