Service de gestion des segments |
|
Nom de la méthode : CreateSegmentMéthode permettant de créer un segment. Vous pourrez définir le nom et le caractère aléatoire de votre segment.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
int | L'identifiant du segment créé |
|
|
Nom de la méthode : CreateSegmentLawMéthode permettant d'ajouter une loi à votre segment.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
int | L'identifiant de la loi créée |
|
|
Ajout d'un critère à une loiNom de la méthode : CreateSegmentLawCriteriaMéthode permettant d'ajouter un critère à une loi.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
int | L'identifiant d'un critère créé |
|
|
Modification d'un segmentNom de la méthode : UpdateSegmentMéthode permettant de modifier votre segment. Vous pourrez modifier le nom et le caractère aléatoire de votre segment.
|
Les paramètres attendus en entrée |
|
|
Modification d'une loi d'un segmentNom de la méthode : UpdateSegmentLawMéthode permettant de modifier une loi d'un segment.
|
Les paramètres attendus en entrée |
|
|
Modification d'un critère d'une loi d'un segmentNom de la méthode : UpdateSegmentLawCriteriaMéthode permettant de modifier un critère d'une loi d'un segment.
|
Les paramètres attendus en entrée |
|
|
Nom de la méthode : DeleteSegmentMéthode permettant de supprimer un segment et l'intégralité de ses lois.
|
Les paramètres attendus en entrée |
|
|
Suppression d'une loi d'un segmentNom de la méthode : DeleteSegmentLawMéthode permettant de supprimer une loi d'un segment et les critères s'y référant.
|
Les paramètres attendus en entrée |
|
|
Suppression d'un critère d'une loi d'un segmentNom de la méthode : DeleteSegmentLawCriteriaMéthode permettant de supprimer un critère d'une loi d'un segment.
|
Les paramètres attendus en entrée |
|
|
Récupération d'un segmentNom de la méthode : GetSegmentByIdMéthode permettant de récupérer l'ensemble des informations d'un segment.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération de la loi d'un segmentNom de la méthode : GetSegmentLawByIdMéthode permettant de récupérer les informations d'une loi d'un segment.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération des lois d'un segmentNom de la méthode : GetSegmentLawListBySegmentIdMéthode permettant de récupérer l'ensemble des lois d'un segment.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération d'un critère d'une loi d'un segmentNom de la méthode : GetSegmentLawCriteriaMéthode permettant de récupérer l'information d'un critère par rapport à une loi donnée.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération des critères d'une loiNom de la méthode : GetSegmentLawCriteriaListByLawIdMéthode permettant de récupérer l'ensemble des critères d'une loi.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération d'un critère de référenceNom de la méthode : GetCriteriaReferenceByIdMéthode permettant de récupérer un critère via son identifiant.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération de l'ensemble des critères de référenceNom de la méthode : GetAllCriteriaReferenceMéthode permettant de récupérer l'ensemble des critères.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération des critères de référence autorisésNom de la méthode : GetAllowedCriteriaReferenceListLorsque vous créez une première loi avec un premier critère, vous pouvez croiser les données de ce critère avec d'autres du même univers.
Cette méthode va vous permettre de récupérer la liste des critères que vous pouvez utiliser avec le premier critère déjà créé.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Récupération d'une liste de segmentsNom de la méthode : GetSegmentListMéthode permettant de récupérer une liste de segments en fonction de différents critères de recherche (nombre de contacts supérieur/inférieur, date de modification de segment...)
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
GetSegmentListResult | La liste des segments correspondants au critères de recherche passées en paramètre |
|
|
Demande de récupération des contacts d'un segmentNom de la méthode : CreateMembersSegmentationRequestMéthode permettant de demander la liste des contacts répondant à un segment.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
string | Le ticket unique de la demande |
|
|
Récupération des contacts d'un segmentNom de la méthode : GetSegmentMemberListMéthode permettant de récupérer votre liste de contacts suite à l'appel de la méthode "CreateMembersSegmentationRequest".
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Nom de la méthode : CreateMembersCountDemand |
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
string | Le ticket de la demande de comptage |
|
|
Récupération du comptage d'un segmentNom de la méthode : GetSegmentMembersCountMéthode permettant de récupérer le comptage de votre segment.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Nom de la méthode : GetSegmentMembersActifsCount |
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
|
Les objets du service de gestion des segments |
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 |
|
CreateSegmentRequest |
la classe hérite de : BaseServiceRequest | ||
Objet représentant un segment. |
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 | SegmentName | string | Le nom du segment à créer | RandomCount | boolean | Indique si la segmentation est aléatoire | RandomType | RandomType | Le type de segmentation aléatoire
| RandomValue | int | La valeur de la segmentation aléatoire | Groups | int[]
| Groupes d'utilisateurs |
Le champ "Groups" correspond aux groupes utilisateurs définis sur la plateforme Dolist-V8. Laissez le champ vide si vous n'en possédez pas ou si vous ne souhaitez pas en indiquer. A ce niveau, le champ "SegmentLawList" est optionnel. Vous pourrez rajouter des lois une fois votre segment créé. Le champ "RandomType" est une énumération. Les valeurs possibles sont : - ContactNumber : Nombre de contacts aléatoire.
- iso-8859-1, iso-8859-2,iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7,iso-8859-8,iso-8859-9,iso-8859-13,iso-8859-15
|
CreateSegmentLawRequest |
la classe hérite de : BaseServiceRequest | ||
Objet représentant une loi. |
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 | SegmentID | int | Identifiant du segment | LawOrder | int | L'ordre de la loi dans le segment | Operator | LawOperator | L'ordre de la loi dans le segment | SegmentLawCriteriaList | CreateSegmentLawCriteriaRequest[]
| La liste des critères de la loi |
Le champ Operator peut prendre 2 valeurs. |
CreateSegmentLawCriteriaRequest |
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 | SegmentID | int | Identifiant du segment | LawID | int | Identifiant de la loi du segment | CriteriaReferenceID | string | Identifiant du critère de référence | OperatorID | int | Identifiant de l'operateur | SearchValue | string | La valeur du critère | CriteriaParameterValuesList | CriteriaParameterValueRequest[]
| La liste des paramètres supplémentaires |
|
CriteriaParameterValueRequest |
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 | ParameterID | int | Le parametre attendu | ParameterValue | string | La valeur du pâramètre |
|
UpdateSegmentRequest |
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 | SegmentID | int | Identifiant du segment mettre à jour | SegmentName | string | Le nouveau nom du segment | RandomCount | boolean | Indique si la récupération des contacts est basé sur une valeur aléatoire | RandomType | RandomType | Le type de segmentation aléatoire | RandomValue | int | La valeur de la segmentation aléatoire | Groups | int[]
| Groups d'utilisateurs |
|
UpdateSegmentLawRequest |
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 | LawId | int | Identifiant de la loi à modifier | LawOrder | int | Le nouvel ordre de la loi dans le segment. Si une loi avec cet ordre existe, les valeurs seront inversées | Operator | LawOperator | Le nouvel opérateur boolean de la loi. |
|
UpdateSegmentLawCriteriaRequest |
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 | CriteriaID | int | Identifiant du critère à mettre à jour | CriteriaReferenceID | string | Identifiant du critère de référence | OperatorID | int | Nouveau identifiant de l'opérateur | SearchValue | string | La nouvelle valeur du critère | CriteriaParameterValuesList | CriteriaParameterValueRequest[]
| La nouvelle liste des paramètres requis avec leurs valeur |
|
DeleteSegmentRequest |
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 | SegmentID | int | Identifiant de segment à supprimer | checkIsUsedInRunningCampaigns | boolean | API.DOC.SEGMENT.OPERATIONCONTRACT.DELETESEGMENT.PARAM.CHECKISUSEDINRUNNINGCAMPAIGNS |
|
DeleteSegmentLawRequest |
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 | LawID | int | Identifiant de la loi à supprimer |
|
DeleteSegmentLawCriteriaRequest |
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 | CriteriaID | int | Identifiant du critère à supprimer |
|
GetSegmentByIdRequest |
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 | SegmentID | int | Identifiant du segment à récuperer |
|
GetSegmentByIdResult |
|
Champ | Type | Description |
---|
Segment | Segment | Segment |
|
Segment |
|
Champ | Type | Description |
---|
CreationDate | dateTime | Date de création | ExecutionCount | int | Le nombre d'executions du segment | LastExecutionDelay | int | La durée de la derniere execution | MemberCount | int | Le nombre de contacts email | RandomCount | boolean | Indique si la récupération des contacts est basé sur une valeur aléatoire | RandomType | RandomType | Le type de segmentation aléatoire | RandomValue | int | La valeur de la segmentation aléatoire | SegmentID | int | Identifiant du segment | SegmentLawsList | SegmentLaw[]
| La liste des lois du segment | SegmentName | string | Le nom du segment | SmsMemberCount | int | Le nombre de contacts sms | UpdateDate | dateTime | Date de mise à jour | UserGroups | int[]
| Groupes d'utilisateurs autorisés |
|
SegmentLaw |
|
Champ | Type | Description |
---|
LawID | int | Identifiant de la loi | LawOrder | int | L'ordre de la loi au sein du segment | Operator | LawOperator | Operateur booléen de la loi | SegmentID | int | Identifiant du segment | SegmentLawCriteriaList | SegmentLawCriteria[]
| La liste des critères de la loi |
|
SegmentLawCriteria |
|
Champ | Type | Description |
---|
CriteriaID | int | Identifiant du critère | CriteriaName | string | Le nom du critère de référence | CriteriaParameterValuesList | CriteriaParameterValue[]
| La liste des parametres supplementaires | CriteriaReferenceID | string | Identifiant du critère de référence | DisplayAllowed | boolean | Indique si le critère est autorisé | LawId | int | Identifiant de la loi | Operator | CriteriaOperator | Opérateur utilisé | SearchValue | string | La valeur du critère |
|
CriteriaParameterValue |
|
Champ | Type | Description |
---|
CriteriaParameter | CriteriaParameter | Le parametre attendu | ParameterValue | string | La valeur du pâramètre |
|
CriteriaParameter |
|
Champ | Type | Description |
---|
ParameterID | int | Identifiant du parametre | ParameterLabel | string | Le nom de parametre | ParameterOrder | int | L'ordre de parametre | ParameterSuffixLabel | string | Libellé suffixe | ParameterType | CriteriaType | Le type de parametre |
|
CriteriaType |
|
Champ | Type | Description |
---|
ControlType | ControlType | Dolist: type de contrôle | DisplayColumnName | string | Le nom de la colonne à afficher | TypeID | int | identifiant du type de critère | TypeName | string | Nom du type de critère |
|
CriteriaOperator |
|
|
SegmentOperator |
|
Champ | Type | Description |
---|
OperatorCode | string | Le code de l'opérateur | OperatorID | int | Identifiant de l'opérateur | OperatorLabel | string | Le libellé de l'opérateur | ValueRequired | boolean | Indique si la valeur de critère est obligatoire pour cet opérateur | ValueUnitLabel | string | Libellé de l'unité de valeur |
|
GetSegmentLawByIdRequest |
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 | LawID | int | Identifiant de la loi à récuperer |
|
GetSegmentLawByIdResult |
|
Champ | Type | Description |
---|
SegmentLaw | SegmentLaw | La loi d'un segment |
|
GetSegmentLawListBySegmentIdRequest |
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 | SegmentID | int | Identifiant du segment |
|
GetSegmentLawListBySegmentIdResult |
|
Champ | Type | Description |
---|
SegmentLawList | SegmentLaw[]
| La liste des lois d'un segment | Count | int | Nombre de lois d'un segment |
|
GetSegmentLawCriteriaRequest |
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 | CriteriaID | int | Identifiant du critère |
|
GetSegmentLawCriteriaResult |
|
|
GetSegmentLawCriteriaListByLawIdRequest |
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 | LawID | int | Identifiant de la loi d'un segment | ProfileID | int | Identifiant profil utilisateur |
|
GetSegmentLawCriteriaListByLawIdResult |
|
|
GetCriteriaReferenceByIdRequest |
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 | CriteriaReferenceID | string | L'identifiant de critère de référence |
|
GetCriteriaReferenceByIdResult |
|
|
CriteriaReference |
|
Champ | Type | Description |
---|
AllowedOperatorsList | CriteriaOperator[]
| La liste des opérateurs autorisés | CategoryID | int | Identifiant de la catégorie | CriteriaFieldLabel | string | Libellé du critère de référence | CriteriaReferenceCode | string | Le code du critère de référence | CriteriaReferenceID | string | L'identifiant du critère de référence | DisplayRank | int | L'ordre d'affichage | RequiredParametersList | CriteriaParameter[]
| La liste des paramètres supplementaires requis |
|
GetAllCriteriaReferenceRequest |
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 | ProfileID | int | (Facultatif) - Profil Utilisateur |
|
GetAllCriteriaReferenceResult |
|
Champ | Type | Description |
---|
CriteriaReferenceList | CriteriaReference[]
| La liste des critères de référence |
|
GetAllowedCriteriaReferenceListRequest |
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 | CriteriaReferenceID | string | L'identifiant du critère de référence pour lequel on effectue la recherche des critères autorisés | CategoryID | int | Identifiant de la catégorie | ProfileID | int | Identifiant profil utilisateur |
|
GetAllowedCriteriaReferenceListResult |
|
Champ | Type | Description |
---|
AllowedCriteriaReferenceList | CriteriaReference[]
| La liste des critères de référence autorisés |
|
GetSegmentListRequest |
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 | CreateDateBegin | dateTime | Date début de création d'un segment | CreateDateEnd | dateTime | Date fin de création de segment | UpdateDateBegin | dateTime | Date début de modification d'un segment | UpdateDateEnd | dateTime | Date fin de modification d'un segment | SegmentName | string | Le nom de segment | ContactNumberLowBound | int | Nombre de contact inférieur | ContactNumberUpperBound | int | Nombre de contact superieur |
|
GetSegmentListResult |
|
Champ | Type | Description |
---|
SegmentList | SegmentLight[]
| Liste des segments correspondants au critères de recherche | TotalSegmentCount | int | Le nombre de segments retourné par la requête |
|
SegmentLight |
|
Champ | Type | Description |
---|
SegmentID | int | Identifiant du segment | SegmentName | string | Le nom du segment | MemberCount | int | Le nombre de contacts | CreationDate | dateTime | Date de création | UpdateDate | dateTime | Date de mise à jour | ExecutionCount | int | Le nombre d'executions du segment | LastExecutionDelay | int | La durée de la derniere execution | RandomCount | boolean | Indique si la récupération des contacts est basé sur une valeur aléatoire | RandomType | RandomType | Le type de segmentation aléatoire | RandomValue | int | La valeur de la segmentation aléatoire | SmsMemberCount | int | Le nombre de contacts SMS |
|
GetSegmentMemberListRequest |
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 | SegmentationTicket | string | Le ticket de la demande de segmentation | FieldList | string[]
| La liste des champs à récuperer | Offset | int | L'indice du 1er element à récuperer | Interests | boolean | Indique si la méthode retourne des intérets | AllFields | boolean | Indique si la méthode retourne récuperer tous les champs | MaxResults | int | Le nombre de résultats à retourner par paquet. La valeur par défaut est 50 et est une valeur maximum acceptée | SaleManagementId | int | Identifiant de l'entité gestionnaire | TestMode | boolean | Indique si la recherche doit se porter uniquement sur des membres testeurs |
|
GetSegmentMemberListResult |
|
Champ | Type | Description |
---|
SegmentID | int | Identifiant du segment | ContactList | ContactData[]
| Liste des contacts du segment | TotalContactsCount | int | Le nombre total des contacts du segment correspondants aux critères de la requête | ReturnContactsCount | int | Le nombre des contacts retournés par la requête |
|
CreateMembersCountDemandRequest |
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 | SegmentID | int | L'identifiant de segment | TestMode | boolean | testeurs uniquement | AddTestContacts | boolean | Ajoute les contacts testeurs au segment | SaleManagementId | int | Identifiant de l'entité gestionnaire |
|
GetSegmentMembersCountRequest |
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 | Ticket | string | Ticket de la demande | Media | Media | Le canal de duffusion, Valuers possibles : All, Email,Mobile | OptoutSubGroupID | int | Optout des contacts(All, Active, Unsubscribed, Unreachable, Excluded, DolistInactive, SubscriptionPending, SpamTemporary,RentedContactExpiration) |
|
GetSegmentMembersCountResult |
|
Champ | Type | Description |
---|
SegmentID | int | Identifiant de segment | SegmentMembersCountList | SegmentMemberCount[]
| La réportion du nombre des contacts d'un segment par optout | EmailTotalContactCount | int | Le nombre total des membres du segment | EmailTotalActiveOwnerCount | int | Le nombre de contacts actifs | EmailTotalActiveRentedCount | int | Le nombre de contacts actifs loués | EmailTotalInactifOwnerCount | int | Le nombre de contacts inactifs | EmailTotalInactifRentedCount | int | Le nombre de contacts inactifs loués | EmailTotalInactifTemporaryOwnerCount | int | Le nombre de contacts inactifs temporaires | EmailTotalInactifTemporaryRentedCount | int | Le nombre de contacts inactifs temporaires loués | MobileTotalContactCount | int | Le nombre total des contacts SMS | MobileTotalActiveOwnerCount | int | Le nombre contacts propriétaire SMS actifs | MobileTotalActiveRentedCount | int | Le nombre contacts loués SMS actifs | MobileTotalInactifOwnerCount | int | Le nombre contacts propriétaire SMS inactifs | MobileTotalInactifRentedCount | int | Le nombre contacts loués SMS inactifs | MobileTotalInactifTemporaryOwnerCount | int | Le nombre contacts propriétaires SMS en softbounce | MobileTotalInactifTemporaryRentedCount | int | Le nombre de contacts inactifs temporaires loués |
|
SegmentMemberCount |
|
Champ | Type | Description |
---|
ContactCount | int | Le nombre de contacts | Media | Media | Media de diffusion | OptoutSubGroup | OptoutSubGroup | Le sous groupe d'optout | OptoutValue | int | Optout | RentedContactCount | int | Le nombre de contacts loués |
|
OptoutSubGroup |
|
Champ | Type | Description |
---|
GroupID | int | L'identifiant de groupe d'optout | ID | int | L'identifiant de sous-groupe d'optout | Name | string | Le nom de sous-groupe d'optout |
|
GetSegmentMembersActifsCountRequest |
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 | Ticket | string | Ticket de la demande |
|
GetSegmentMembersActifsCountResult |
|
Champ | Type | Description |
---|
SegmentID | int | L'identifiant de groupe d'optout | MembersCount | int | Nombre de contacts email actifs | SmsMembersCount | int | Nombre de contacts mobiles actifs |
|
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 |
|
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 |
|
ContactData |
|
Champ | Type | Description |
---|
CustomFields | CustomField[]
| Liste des champs du contact | Email | string | Email du contact | Error | int | Compteur d'erreur du contact | Interests | Interest[]
| Liste des intérêts déclarés du contact | MemberId | int | Identifiant du contact | OptoutEmail | int | Optout email du contact | OptoutMobile | int | Optout sms du contact | ReadOnly | boolean | Indique si le optout du contact est modifiable et si la suppression est autorisée | RentCount | int | Le compteur de location | Status | int | Status du contact | SubscribeDate | dateTime | Date d'inscription du contact | UnsubscribeDate | dateTime | Date de désabonnement du contact | UpdateDate | dateTime | Date de modification du contact |
|
CustomField |
|
Champ | Type | Description |
---|
CustomName | string | Nom personnalisé du champ | FieldType | int | Champ Système DOLIST - Typage de champ | Name | string | Nom du champ | Value | string | Valeur du champ |
|
Interest |
|
Champ | Type | Description |
---|
Group | InterestGroup | Groupe d'intérêt déclaré | InterestDate | dateTime | Date d'inscription à l'intérêt déclaré | Value | InterestValue | Intérêt déclaré |
|
InterestGroup |
|
Champ | Type | Description |
---|
Id | int | Identifiant du groupe d'intérêt déclaré | Name | string | Nom du groupe d'intérêt déclaré |
|
InterestValue |
|
Champ | Type | Description |
---|
Id | int | Identifiant de l'intérêt déclaré | Name | string | Nom de l'intérêt déclaré |
|
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 |
|
Gestion des lois
Lois et critères Un segment est un ensemble de lois. Ces lois sont composées des critères. Les critères vous permettent de définir les conditions de votre segmentation. Dans une même loi, vous pourrez avoir autant de critères que vous souhaitez, tant qu'ils sont dans le même "univers". C'est-à-dire que vous pourrez croiser des données comportementales, croiser des données de contacts...Tous ces critères seront reliés par des "ET" logique. C'est-à-dire que chaque critère devra être rempli par le contact pour faire partie du segment. Les lois, entre elles, sont reliées par des opérateurs logiques : "ET / OU".
Ajouter des lois et critères Vous pouvez ajouter autant de lois et de critères que vous souhaitez. A tout moment, vous pouvez ajouter, modifier ou supprimer des lois. Vous pouvez, également,ajouter, modifier ou supprimer des critères dans une loi.
Récupérer les critères Pour réaliser vos lois, vou devez disposer de la liste des critères possibles. Ces critères vont de la gestion de contacts aux statististiques comportementales par rapport à une ou plusieurs campagnes d'emailing. 3 méthodes sont disponibles pour pouvoir récupérer ces critères.
GetAllCriteriaReference : Récupérer l'ensemble des critères existants.GetAllowedCriteriaReferenceList : Récupérer la liste des critères que vous pouvez utiliser avec le premier critère créé.GetCriteriaReferenceById : Récupérer un critère via son identifiant Dolist.
|