Service du webtracking |
|
DéfinitionLe service de gestion du webtracking vous permet de récupérer l'ensemble des sites disponibles. Récupérez l'url, sa description, le trackingID, son typage et la date des dernieres données collectés pour les sites.
|
Récupération de la liste des sitesNom de la méthode : GetLightSiteListCette méthode récupère le descriptif complet ('url, description, trackingID, typage, date des dernieres données collectés ...) des sites de la base, disponibles sur la plateforme DOLIST-V8.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
4 | ForbiddenActionException | L'action demandée n'est pas autorisée |
|
|
Les objets du service de webtracking |
AuthenticationTokenContext |
|
Champ | Type | Description |
---|
AccountID | int | Identifiant du client | Key | string | Clé du jeton d'authentification | ListID | int | Identifiant du client: obsolète. Utilisez AccountID à la place |
|
GetLightSiteListRequest |
la classe hérite de : BaseServiceRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre d'éléments à retourner |
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Les cultures possibles sont en_US et fr_FR.
|
BaseServiceRequest |
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur |
|
GetLightSiteListResult |
|
Champ | Type | Description |
---|
Total | int | Nombre total de sites | Count | int | Nombre de sites retournés | LightSiteList | LightSite[]
| Liste des sites |
|
LightSite |
la classe hérite de : Site | ||
|
Champ | Type | Description |
---|
ID | int | Identifiant du site | TrackingID | string | Identifiant du tracking | URL | string | Url du site | Description | string | Description du site | LastImportDate | dateTime | Date des derniers données collectées pour le site | TypeID | int | Identifiant du type de site | TypeName | string | Nom du type de site |
- TypeID : Les valeurs possible sont e-commerce (TypeID=1) et Site web (TypeID=2). Pour la récupération de statistiques de webtracking pour les campagnes d'un site, en fonction du type de site, vous devez appeler certaines méthodes :
- Statistiques de webtracking pour les sites de e-commerce ici
- Statistiques de webtracking pour les sites web ici
|
Site |
|
Champ | Type | Description |
---|
ID | int | Identifiant du site | TrackingID | string | Identifiant du tracking |
|
ServiceException |
|
Champ | Type | Description |
---|
Ticket | string | Le numéro de ticket | Message | string | Le message d'erreur | Description | string | La description de l'erreur | ErrorCodeType | ErrorCodeType | Type du code de l'erreur | ErrorCode | int | Code de l'erreur |
|
ValidationFault |
|
Champ | Type | Description |
---|
Details | ValidationDetail[]
| Liste des détails de l'erreur de validation de la requête |
|
ValidationDetail |
|
Champ | Type | Description |
---|
Key | string | Nom du champ à valider | Message | string | Résultat de la validation | Tag | string | Tag de validation |
|
Liste des erreurs communes |
|
Code | Nom | Description |
---|
0 | UnexpectedException | Erreur inattendue | 1 | AuthenticationException | Erreur d'authentification | 2 | NullTokenException | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | 3 | NullRequestException | L'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée | 5 | InvalidArgumentException | Les arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité | 6 | BadRequestException | La requête n'est pas correcte | 7 | NothingToDoException | La requête demandée n'effectue aucun traitement, car les données soient déjà à jour, il est possible que la requête ai été exécuté plusieurs fois | 8 | InvalidDataTypeException | Le type de donnée n'est pas valide | 9 | UnknownTicketException | Le ticket n'est pas connu, vérifiez la valeur de celui-ci | 10 | UnavailableTicketResultException | Le résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard. | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | 999998 | TokenNull | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | 999999 | TokenNotAuthorized | L'objet 'token' n'est pas autorisé, vérifiez les propriétés |
|