,
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 complet qui sera analysé. |
## `sha256`
Calcule le digest SHA-256 de l’entrée et appelle un callback avec le digest encodé en base64, sauf si l’ `options` objet spécifie un autre encodage de sortie.
Cette signature et ce comportement de l’API correspondent à l’ [`sha256`](https://developers.google.com/tag-platform/tag-manager/templates/api#sha256) API pour les conteneurs web ; toutefois, les modèles personnalisés dans les conteneurs serveur doivent utiliser l’ [`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`** | *function* | Appelé avec le digest résultant, encodé en base64, sauf si l’ `options` objet spécifie un autre encodage de sortie. |
| **`options`** | *object* | *Optionnel* objet options pour spécifier l’encodage de sortie. Si indiqué, l’objet doit contenir la clé `outputEncoding` avec pour valeur l’une des options suivantes : `base64` ou `hex`. |
## `sha256Sync`
Calcule et renvoie le digest SHA-256 de l’entrée, encodé en base64, sauf si l’ `options` objet spécifie un autre encodage de sortie.
**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* | *Optionnel* objet options pour spécifier l’encodage de sortie. Si indiqué, 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 donné, en utilisant `sha256` et `base64` l’encodage par défaut, sauf si l’ `options` objet spécifie autre chose. 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');
// Signer une chaîne avec les options par défaut (sha256 + base64)
const signature = signHmac('my payload', 'mySecretKey');
// Signer avec un algorithme et un encodage personnalisés
const signatureHex = signHmac('my payload', 'mySecretKey', { alg: 'sha1', outputEncoding: 'hex' });
// Signer 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 du HMAC. |
| **`options`** | *object* | *Optionnel* objet options pour personnaliser l’algorithme et l’encodage de sortie. Voir les détails des options ci-dessous. |
**Options**
| Property | Type | Default | Description |
| -------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`alg`** | *string* | `'sha256'` | L’algorithme de hachage. Valeurs prises en charge : `'sha256'`, `'sha1'`, `'sha512'`, `'sha384'`, `'md5'` et d’autres algorithmes de digest 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.
La `parse()` La fonction analyse une chaîne JSON pour construire la valeur ou l’objet décrit 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.
La `stringify()` la fonction convertit l’entrée en chaîne JSON. Si la valeur ne peut pas être analysée (par 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érer la valeur absolue.
const absolute = Math.abs(-5);
// Arrondir l’entrée à l’inférieur à l’entier le plus proche.
const roundedDown = Math.floor(4.6);
// Arrondir l’entrée à l’entier supérieur le plus proche.
const roundedUp = Math.ceil(2.1);
// Arrondir l’entrée à l’entier le plus proche.
const rounded = Math.round(4.2);
// Renvoyer le plus grand argument.
const biggest = Math.max(1, 4);
// Renvoyer le plus petit argument.
const smallest = Math.min(4, 5);
// Renvoyer le premier argument élevé à la puissance du deuxième argument.
const powerful = Math.pow(4, 2);
// Renvoyer 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 appelle un callback avec la réponse une fois que la requête se termine ou expire.
**Syntaxe**
```javascript
sendHttpGet(url[, callback[, options]]);
```
**Exemple**
```javascript
const sendHttpGet = require('sendHttpGet');
// Envoie une requête GET et désigne la réponse// selon 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`** | *function* | Un callback facultatif à invoquer à la fin de la requête, en cas d’erreur ou de délai d’attente.
Il est invoqué avec le code de statut de la réponse, le en-têtes de 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 négociation SSL, etc.), le callback sera invoqué avec un code de statut de réponse de zéro, aucun en-tête, et un corps undefined.
Si l’ 'timeout' option était définie et que la requête a expiré, le callback sera invoqué avec un code de statut de réponse de -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 supplémentaires de requête représentés sous forme d’objet.
* **timeout**: Le 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 vers l’URL spécifiée et appelle un callback avec la réponse une fois que la requête se termine ou expire.
**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`** | *function* | Un callback facultatif à invoquer à la fin de la requête, en cas d’erreur ou de délai d’attente.
Il est invoqué avec le code de statut de la réponse, le en-têtes de 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 négociation SSL, etc.), le callback sera invoqué avec un code de statut de réponse de zéro, aucun en-tête, et un corps undefined.
Si l’option 'timeout' était définie et que la requête a expiré, le callback sera invoqué avec un code de statut de réponse de -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’options 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 supplémentaires de requête.
* **method**: La méthode de requête, par défaut 'GET'.
* **timeout**: Le 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**
```
md5Sync(input);
```
**Exemple**
```javascript
const md5Sync= require('md5Sync');
const email = {};
email.md5 = md5Sync(user.user_email);
sendHttpGet('https://example.com/collect?e5=' + email.md5);
```
## `templateDataStorage`
La `templateDataStorage` helper permet le stockage et la récupération temporaires de données, telles que des jetons 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` persistent sur le serveur exécutant le modèle. Comme les modèles 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 modèle.
**Syntaxe**
```javascript
templateDataStorage.setItemCopy(key, value);
templateDataStorage.getItemCopy(key);
templateDataStorage.removeItemCopy(key);
```
**Exemple : gestion des jetons 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 });
```
| Method | 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. |
| **`value`** | *de* | Les données à stocker (pour `setItemCopy`). |
---
# Agent Instructions: 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:
```
GET https://doc.commandersact.com/fr/fonctionnalites/destinations/destination-builder/javascript-destination-builder/serverside-js-helpers.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.