,
hash: string,
}
```
**Syntaxe**
```
parseUrl(url);
```
**Exemple**
```
const parseUrl = require('parseUrl');const urlObject = parseUrl('https://abc:xyz@example.com:8080/foo?param=val%2Cue#bar');
```
**Paramètres**
| Paramètre | Type | Description |
| --------- | -------- | --------------------------------- |
| **`url`** | *string* | L'URL complète qui sera analysée. |
## `sha256`
Calcule le condensat SHA-256 de l'entrée et appelle un callback avec le condensat encodé en base64, sauf si le `options` objet options spécifie un encodage de sortie différent.
Cette signature et ce comportement de l'API correspondent à [`sha256`](https://developers.google.com/tag-platform/tag-manager/templates/api#sha256) l'API pour les conteneurs web ; cependant, les Custom Templates dans les conteneurs serveur doivent utiliser la [`sha256Sync`](https://developers.google.com/tag-platform/tag-manager/server-side/api#sha256sync) API pour un code plus simple.
**Syntaxe**
```
sha256(input, onSuccess, options = undefined);
```
**Exemple**
```
const encodeUriComponent = require('encodeUriComponent');const sendHttpGet = require('sendHttpGet');const sha256 = require('sha256');sha256('inputString', (digest) => { sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digest));});sha256('inputString', (digest) => { sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digest));}, {outputEncoding: 'hex'});
```
**Paramètres**
| Paramètre | Type | Description |
| --------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`input`** | *string* | La chaîne à hacher. |
| **`onSuccess`** | *fonction* | Appelé avec le condensat résultant, encodé en base64, sauf si l' `options` objet options spécifie un encodage de sortie différent. |
| **`options`** | *object* | *Facultatif* objet options permet de spécifier l'encodage de sortie. S'il est spécifié, l'objet doit contenir la clé `outputEncoding` avec comme valeur l'un de `base64` ou `hex`. |
## `sha256Sync`
Calcule et renvoie le condensat SHA-256 de l'entrée, encodé en base64, sauf si le `options` objet options spécifie un encodage de sortie différent.
**Syntaxe**
```
sha256Sync(input, options = undefined);
```
**Exemple**
```
const encodeUriComponent = require('encodeUriComponent');const sendHttpGet = require('sendHttpGet');const sha256Sync = require('sha256Sync');const digestBase64 = sha256Sync('inputString');const digestHex = sha256Sync('inputString', {outputEncoding: 'hex'});sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digestBase64));sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digestHex));
```
**Paramètres**
| Paramètre | Type | Description |
| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`input`** | *string* | La chaîne à hacher. |
| **`options`** | *object* | *Facultatif* objet options permet de spécifier l'encodage de sortie. S'il est spécifié, l'objet doit contenir la clé `outputEncoding` avec comme valeur l'un de `base64` ou `hex`. |
## `signHmac`
Génère une signature HMAC pour le payload donné, en utilisant `sha256` et `base64` l'encodage par défaut, sauf si l' `options` objet options indique le contraire. Les objets passés en tant que payload sont automatiquement `JSON.stringify`'d. Renvoie un **string**.
**Syntaxe**
```javascript
signHmac(payload, secret, options = undefined);
```
**Exemple**
```javascript
const signHmac = require('signHmac');
// Signe une chaîne avec les options par défaut (sha256 + base64)
const signature = signHmac('my payload', 'mySecretKey');
// Signe avec un algorithme et un encodage personnalisés
const signatureHex = signHmac('my payload', 'mySecretKey', { alg: 'sha1', outputEncoding: 'hex' });
// Signe un objet (automatiquement JSON.stringify'd)
const objectSignature = signHmac({ key: 'value' }, 'mySecretKey');
```
**Paramètres**
| Paramètre | Type | Description |
| ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **`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 la génération HMAC. |
| **`options`** | *object* | *Facultatif* Objet options permettant de personnaliser l'algorithme et l'encodage de sortie. Voir les détails des options ci-dessous. |
**Options**
| Propriété | Type | Par défaut | Description |
| -------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`alg`** | *string* | `'sha256'` | L'algorithme de hachage. Valeurs prises en charge : `'sha256'`, `'sha1'`, `'sha512'`, `'sha384'`, `'md5'` et autres algorithmes de condensat 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**
```
toBase64(input);
```
**Exemple**
```
const toBase64 = require('toBase64');const base64Hello = toBase64('hello');
```
**Paramètres**
| Paramètre | Type | Description |
| ----------- | -------- | ----------------- |
| **`input`** | *string* | Chaîne à encoder. |
## `JSON`
Renvoie un objet qui fournit des fonctions JSON.
Le `parse()` la fonction analyse une chaîne JSON pour construire la valeur ou l'objet décrits par la chaîne. Si la valeur ne peut pas être analysée (JSON mal formé), la fonction renverra `undefined`. Si la valeur d'entrée n'est pas une chaîne, l'entrée sera convertie en chaîne.
Le `stringify()` la fonction convertit l'entrée en chaîne JSON. Si la valeur ne peut pas être sérialisée (ex. l'objet a un cycle), la méthode renverra `undefined`.
**Syntaxe**
```
JSON.parse(yourString);
JSON.stringify(yourObject);
```
**Exemple**
```
const JSON = require('JSON');
// La chaîne d'entrée JSON est convertie en objet.
const object = JSON.parse('{"foo":"bar"}');
// L'objet d'entrée est converti en chaîne JSON.
const str = JSON.stringify({foo: 'bar'});
```
***
## `Math`
Un objet fournissant `Math` fonctions.
**Syntaxe**
```
const Math = require('Math');
// Récupère la valeur absolue.
const absolute = Math.abs(-5);
// Arrondit l'entrée à l'entier inférieur le plus proche.
const roundedDown = Math.floor(4.6);
// Arrondit l'entrée à l'entier supérieur le plus proche.
const roundedUp = Math.ceil(2.1);
// Arrondit l'entrée à l'entier le plus proche.
const rounded = Math.round(4.2);
// Renvoie le plus grand argument.
const biggest = Math.max(1, 4);
// Renvoie le plus petit argument.
const smallest = Math.min(4, 5);
// Renvoie le premier argument élevé à la puissance du second argument.
const powerful = Math.pow(4, 2);
// Renvoie la racine carrée de l'argument.
const unsquared = Math.sqrt(81);
```
**Paramètres**
Les paramètres des fonctions Math sont convertis en nombres.
## `sendHttpGet`
Effectue une requête HTTP GET vers l'URL spécifiée, et invoque un callback avec la réponse une fois la requête terminée ou expirée.
**Syntaxe**
```javascript
sendHttpGet(url[, callback[, options]]);
```
**Exemple**
```javascript
const sendHttpGet = require('sendHttpGet');
// Envoie une requête GET et nomme la réponse// en fonction de la réponse du GET
sendHttpGet('https://example.com/collect', function(statusCode, headers, body) {
if (statusCode != 200) {yourCallbackFunction();}
}, {
headers: {key: 'value'},
timeout: 500
});
```
**Paramètres**
| Paramètre | Type | Description |
| -------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`url`** | *string* | L'URL de la requête. |
| **`callback`** | *fonction* | Un callback facultatif à invoquer à la fin de la requête, en cas d'erreur ou de timeout.
Il est appelé avec le code d'état de la réponse, le les en-têtes de la réponse, et le corps de la réponse (ou undefined s'il n'y avait pas de corps de réponse).
Si la requête a échoué (par ex. URL invalide, aucune route vers l'hôte, échec de la négociation SSL, etc.), le callback sera appelé avec un code d'état de réponse égal à zéro, aucun en-tête, et un corps undefined.
Si l' '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 égal à -1, aucun en-tête, et un corps undefined.
|
| **`options`** | *object* | 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**: Le timeout, en millisecondes, avant l'abandon de la requête.
* **extraOptions**: Options avancées (ex : {strictSSL:true})
## `sendHttpRequest`
Effectue une requête HTTP vers l'URL spécifiée et appelle un callback avec la réponse une fois la requête terminée ou expirée.
**Syntaxe**
```
sendHttpRequest(url[, callback[, options[, body]]]);
```
**Exemple**
```javascript
const sendHttpRequest = require('sendHttpRequest');
const body = {
user_type:'vip',
account:'123'
};
// Envoie une requête POST
sendHttpRequest('https://example.com/collect', function(statusCode, headers, body) {
// votre code de callback...
}, {
headers: {
token: '123456789'
},
method: 'POST',
timeout: 1000
}, JSON.stringify(body));
```
**Paramètres**
| Paramètre | Type | Description |
| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **`url`** | *string* | L'URL de la requête. |
| **`callback`** | *fonction* | Un callback facultatif à invoquer à la fin de la requête, en cas d'erreur ou de timeout.
Il est appelé avec le code d'état de la réponse, le les en-têtes de la réponse, et le corps de la réponse (ou undefined s'il n'y avait pas de corps de réponse).
Si la requête a échoué (par ex. URL invalide, aucune route vers l'hôte, échec de la négociation SSL, etc.), le callback sera appelé 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 égal à -1, aucun en-tête, et un corps undefined.
|
| **`options`** | *object* | 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**: La méthode de requête, la valeur par défaut est 'GET'.
* **timeout**: Le timeout, en millisecondes, avant l'abandon de la requête.
* **extraOptions**: Options avancées (ex : {strictSSL:true})
## `md5Sync`
Calcule et renvoie le `md5` empreinte de l'entrée.
**Syntaxe**
```
md5Sync(input);
```
**Exemple**
```javascript
const md5Sync= require('md5Sync');
const email = {};
const email.md5 = md5Sync(user.user_email);
sendHttpGet('https://example.com/collect?e5=' + email.md5);
```
## `templateDataStorage`
Le `templateDataStorage` helper permet le stockage temporaire et la récupération de données, telles que des tokens API, pendant l'exécution du script. Il est particulièrement utile pour mettre en cache des données réutilisables afin de réduire les appels API redondants. Les données stockées dans `templateDataStorage` persiste 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 pour toutes les exécutions ultérieures du template.
**Syntaxe**
```javascript
templateDataStorage.setItemCopy(key, value);
templateDataStorage.getItemCopy(key);
templateDataStorage.removeItemCopy(key);
```
**Exemple : gestion des tokens API**
```javascript
const sendHttpRequest = require('sendHttpRequest');
const templateDataStorage = require('templateDataStorage');
const tokenKey = 'apiToken';
function fetchNewToken(callback) {
sendHttpRequest('https://example.com/api/token', function (status, _, body) {
if (status === 200) {
const { accessToken, expiresIn } = JSON.parse(body);
const tokenData = { token: accessToken, expiry: Date.now() + expiresIn * 1000 };
templateDataStorage.setItemCopy(tokenKey, tokenData);
callback(accessToken);
} else {
callback(null);
}
}, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ clientId: 'id', clientSecret: 'secret' }) });
}
function sendEvent(eventData) {
const cachedToken = templateDataStorage.getItemCopy(tokenKey);
const token = cachedToken && cachedToken.expiry > Date.now() ? cachedToken.token : null;
sendHttpRequest('https://example.com/api/events', function (status) {
if (status === 401) {
fetchNewToken(function (newToken) {
if (newToken) {
sendHttpRequest('https://example.com/api/events', () => {}, { method: 'POST', headers: { Authorization: `Bearer ${newToken}` }, body: JSON.stringify(eventData) });
}
});
}
}, { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body: JSON.stringify(eventData) });
}
sendEvent({ eventName: 'purchase', value: 100 });
```
| Méthode | Description |
| ----------------------------- | ------------------------------------------------------------------------------------------- |
| **`setItemCopy(key, value)`** | Stocke une valeur sous la clé spécifiée. Écrase 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. |
| Paramètre | Type | Description |
| ------------ | -------- | ----------------------------------------------------- |
| **`clé`** | *string* | L'identifiant unique des données à stocker/récupérer. |
| **`valeur`** | *de* | Les données à stocker (par `setItemCopy`). |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://doc.commandersact.com/fr/fonctionnalites/destinations/destination-builder/javascript-destination-builder/serverside-js-helpers.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.