API de Tags

Note

Pour définir les valeurs de tag pour les HWID et les UserID, utilisez la méthode /setTags de l’API de l’appareil. addTag est facultatif, car setTags crée tout nom de tag qu’il ne reconnaît pas encore et déduit le type à partir de la valeur : un nombre entier devient Integer, un nombre avec une virgule décimale devient Price, une chaîne de caractères devient String (ou Date, pour un format de date et d’heure reconnu tel que 2024-10-02 22:11), un tableau devient List, et un booléen devient Boolean. Utilisez addTag pour un tag de type Version, car la création automatique ne peut pas le déduire, ou pour un tag spécifique à l’utilisateur. La création automatique de tags est activée par défaut pour la grande majorité des comptes. Si setTags ne crée pas un nouveau tag comme prévu, contactez le Support Pushwoosh pour vérifier si cette option a été désactivée pour votre compte.

addTag

POST https://api.pushwoosh.com/json/1.3/addTag

Crée un tag dans votre compte.

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès API depuis le Panneau de Contrôle Pushwoosh.
tag*	object	Paramètres du tag.
tag.name*	string	Nom du tag.
tag.type*	integer	Type de tag. Voir les valeurs possibles ci-dessous.
tag.user_specific	boolean	Lorsque true, la valeur du tag est stockée au niveau de l’utilisateur et partagée sur tous les appareils d’un utilisateur lorsqu’elle est définie par UserID. Lorsque false (par défaut), le tag est au niveau de l’appareil et défini par HWID.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}

Exemple

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Panneau de Contrôle Pushwoosh
    "tag": {
      "name": "TAG_NAME",           // requis.
      "type": 1,                    // requis. Voir les valeurs possibles ci-dessous
      "user_specific": false        // facultatif. true = tag au niveau de l'utilisateur (partagé sur tous les appareils) ; false = tag au niveau de l'appareil (par défaut)
    }
  }
}

Types de valeurs de tag possibles :

• 1 - Integer
• 2 - String
• 3 - List
• 4 - Date
• 5 - Boolean
• 6 - Decimal. Ex : 19.95
• 7 - Version. Ex : “1.0.0.0”

deleteTag

POST https://api.pushwoosh.com/json/1.3/deleteTag

Supprime complètement un tag avec toutes les informations associées de la base de données.

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès API depuis le Panneau de Contrôle Pushwoosh.
tag*	object	Paramètres du tag.
tag.name*	string	Nom d’un tag à supprimer.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": true
  }
}

Exemple

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Panneau de Contrôle Pushwoosh
    "tag": {
      "name": "TAG_NAME"            // requis. Nom d'un tag à supprimer
    }
  }
}

listTags

POST https://api.pushwoosh.com/json/1.3/listTags

Récupère une liste de tags sur le compte.

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès API depuis le Panneau de Contrôle Pushwoosh.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "tags": [{
      "name":"Language",
      "type":2
    }, {
      "name":"List tag",
      "type":3
    }]
  }
}

Exemple

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H" // Jeton d'accès API depuis le Panneau de Contrôle Pushwoosh
  }
}

Types de tag :

• 1 - Integer
• 2 - String
• 3 - List
• 4 - Date
• 5 - Boolean
• 6 - Decimal. Ex : 19.95
• 7 - Version. Ex : “1.0.0.0”