API d'audience

L’API d’audience enregistre, désenregistre et tague des appareils en masse. Chaque méthode en masse accepte une liste d’appareils en une seule requête, la traite en arrière-plan et renvoie un request_id. Transmettez ce request_id à la méthode de statut correspondante pour vérifier le résultat. Utilisez les méthodes en masse pour les importations et les mises à jour de tags à grande échelle, et l’API Appareil pour un seul appareil.

Note

Le request_id utilisé sur cette page est un jeton de tâche pour interroger le statut d’une opération bulk*, sans rapport avec l’ID de requête de message utilisé pour le suivi au niveau HTTP.

bulkSetTags

POST https://api.pushwoosh.com/api/v2/audience/bulkSetTags

Définit les valeurs des tags pour la liste des appareils.

Important

Lors de l’utilisation de la méthode bulkSetTags, assurez-vous que les valeurs des tags sont définies pour un minimum de 50 appareils. Pour définir des tags pour un seul appareil, utilisez la méthode setTags.

Corps de la requête

Nom	Type	Description
application*	String	Code d’application Pushwoosh
auth*	String	Jeton d’accès à l’API depuis le Control Panel de Pushwoosh.
create_missing_tags	Boolean	Si vrai, les tags manquants sont créés automatiquement.
devices*	Object	Tableau d’appareils.
devices.hwid	String	Peut être utilisé pour identifier un appareil au lieu de user_id ou push_token. En savoir plus
devices.user_id	String	Peut être utilisé pour identifier un utilisateur au lieu de hwid ou push_token. En savoir plus
devices.push_token	String	Peut être utilisé pour identifier un appareil au lieu de hwid ou user_id. En savoir plus
devices.list_operator	String	Définit comment définir les valeurs pour les tags de type liste : set, append ou remove
devices.tags*	Object	Valeurs à définir pour les tags spécifiés.

OK

{
  "request_id": "request_id à utiliser dans la méthode GET pour obtenir le statut de la tâche",
  "status": "Pending"
}

Erreur

{
  "message": "requête invalide"
}

Requête :

{
  "application": "code d'application",   // requis. Code d'application Pushwoosh
  "auth": "jeton d'authentification Pushwoosh",      // requis. Jeton d'accès à l'API depuis le Control Panel de Pushwoosh
  "create_missing_tags": false,        // optionnel. Doit créer automatiquement les tags manquants
  "devices": [{                        // requis. Tableau d'appareils
    "hwid": "hwid de l'appareil",             // optionnel. Peut être utilisé pour identifier un appareil au lieu de
                                       //           "user_id" ou "push_token".
    "user_id": "ID utilisateur",              // optionnel. Peut être utilisé pour identifier un utilisateur au lieu de "hwid" ou "push_token".
    "push_token": "jeton push de l'appareil", // optionnel. Peut être utilisé pour identifier un appareil au lieu de "hwid" ou "user_id".
    "list_operator": "set",            // requis. Pour les tags de liste. Définit comment définir les valeurs pour
                                       //           les tags de type liste : set, append ou remove
    "tags": {                          // requis. Valeurs à définir pour les tags spécifiés.
      "nom_du_tag": "valeur_du_tag",          //           utilisez le type de valeur correct
      "nom_du_tag2": "valeur_du_tag2"
    }
  }]
}

Réponse :

{
  "request_id": "request_id à utiliser dans la méthode GET pour obtenir le statut de la tâche",
  "status": "Pending"
}

Statut de bulkSetTags

GET https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false

Retourne le statut de l’opération /bulkSetTags

Paramètres de chemin

Nom	Type	Description
request_id	String	id de la requête de l’appel /bulkSetTags précédent

Paramètres de requête

Nom	Type	Description
detailed	Boolean	(vrai/faux) indique s’il faut retourner des informations détaillées par appareil

Réponse :

{
  "request_id": "id de la requête",
  "status": "Completed",          // aussi "Pending", "Failed"
  "progress": 100,                // progression de la tâche 0-100
  "devices_success": 100,         // appareils réussis
  "devices_not_found": 0,         // appareils non trouvés dans Pushwoosh
  "devices_failed": 0,            // en erreur
  "devices": [{                   // rapport de l'appareil (seulement si detailed = true)
    "hwid": "hwid de l'appareil",
    "status": "done",             // aussi "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag non trouvé",
      "tagName3": "mauvaise valeur. attendu :string"
    }
  }]
}

bulkRegisterDevice

Enregistre plusieurs appareils dans Pushwoosh en une seule requête. Permet également de spécifier divers tags pour chaque appareil.

POST https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice

Paramètres du corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès à l’API.
devices	array	Oui	Un tableau d’objets appareil. Chaque objet représente un appareil et ses données associées. Voir les détails dans le tableau Paramètres de l’objet appareil ci-dessous.

Paramètres de l’objet appareil

Paramètre	Type	Requis	Description
hwid	string	Oui	L’ID matériel ou identifiant unique de l’appareil.
push_token	string	Oui	Jeton Push pour l’appareil.
platform	integer	Oui	L’identifiant de la plateforme. En savoir plus
list_operator	string	Non	Détermine l’action pour les tags de type liste : - “append” : Ajoute la valeur spécifiée à la liste de tags. - “remove” : Supprime la valeur spécifiée de la liste de tags. Note : Si le paramètre list_operator n’est pas spécifié, toutes les valeurs existantes dans la liste de tags seront remplacées par les valeurs fournies.
tags	object	Non	Tags personnalisés assignés à l’appareil. Les tags sont des paires clé-valeur utilisées pour la segmentation.

Exemple de requête

{
  "application": "code d'application",   // requis. Code d'application Pushwoosh
  "auth": "jeton d'authentification Pushwoosh",      // requis. Jeton d'accès à l'API depuis le Control Panel de Pushwoosh
  "devices": [{                        // requis. Tableau d'appareils
    "hwid": "hwid de l'appareil",             // requis. Identifiant unique pour l'appareil (peut être un e-mail).
    "push_token": "jeton push de l'appareil", // requis. Jeton de notification Push pour l'appareil.
    "platform": 14,                    // requis. Plateforme de l'appareil (par ex., 14 pour e-mail).
    "list_operator": "append",         // optionnel. Pour les tags de liste. Ajoute ou supprime la ou les valeurs spécifiées du tag de type liste.
    "tags": {                          // optionnel. Valeurs à définir pour les tags spécifiés.
      "language": "en",                //           utilisez le type de valeur correct.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "hwid de l'appareil 2",           // requis. Identifiant unique pour le deuxième appareil.
    "push_token": "jeton push de l'appareil 2", // requis. Jeton de notification Push pour l'appareil.
    "platform": 14,                    // requis. Plateforme de l'appareil.
    "list_operator": "remove",         // optionnel. Ajoute ou supprime des valeurs des tags de type liste.
    "tags": {                          // optionnel. Valeurs à supprimer des tags spécifiés.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "hwid de l'appareil 3",           // requis. Identifiant unique pour le troisième appareil.
    "push_token": "jeton push de l'appareil 3", // requis. Jeton de notification Push pour l'appareil.
    "platform": 14,                    // requis. Plateforme de l'appareil.
    "tags": {                          // optionnel. Valeurs à définir pour les tags spécifiés.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Réponse

La méthode répond avec un ID d’opération, qui peut être utilisé pour suivre le statut et les résultats du processus d’enregistrement en masse.

{
  "request_id": "request_id à utiliser dans la méthode GET pour obtenir le statut de la tâche",
  "status": "Pending"
}

Statut de bulkRegisterDevice

Vous pouvez vérifier le statut d’un processus d’enregistrement en masse en effectuant la requête GET suivante :

GET https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice/{request_id}?detailed=true

Paramètre	Type	Requis	Description
request_id	string	Oui	L’ID de requête retourné par la requête POST.
detailed	boolean	Non	Si défini sur true, la réponse inclut des résultats détaillés pour chaque appareil enregistré.

Exemple de réponse

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}

bulkUnregisterDevice

Désenregistre plusieurs appareils de Pushwoosh en une seule requête.

POST https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice

Paramètres du corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès à l’API
devices	array	Oui	Un tableau d’objets appareil. Chaque objet représente un appareil et ses données associées. Voir les détails dans le tableau Paramètres de l’objet appareil ci-dessous.

Paramètres de l’objet appareil

Paramètre	Type	Requis	Description
hwid	string	Oui	L’ID matériel ou identifiant unique de l’appareil. En savoir plus

Exemple de requête

{
  "application": "code d'application",   // requis. Code d'application Pushwoosh
  "auth": "jeton d'authentification Pushwoosh",      // requis. Jeton d'accès à l'API depuis le Control Panel de Pushwoosh
  "devices": [{                        // requis. Tableau d'appareils
    "hwid": "hwid de l'appareil",             // requis. Identifiant unique pour l'appareil (peut être un e-mail).
  },
  {
    "hwid": "hwid de l'appareil 2",           // requis. Identifiant unique pour le deuxième appareil.
  },
  {
    "hwid": "hwid de l'appareil 3",           // requis. Identifiant unique pour le troisième appareil.
  }]
}

Réponse

La méthode répond avec un ID d’opération, qui peut être utilisé pour suivre le statut et les résultats du processus en masse.

{
  "request_id": "request_id à utiliser dans la méthode GET pour obtenir le statut de la tâche",
  "status": "Pending"
}

Statut de bulkUnregisterDevice

Vous pouvez vérifier le statut d’un processus de désenregistrement en masse en effectuant la requête GET suivante :

GET https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice/{request_id}?detailed=true

Paramètre	Type	Requis	Description
request_id	string	Oui	L’ID de requête retourné par la requête POST.
detailed	boolean	Non	Si défini sur true, la réponse inclut des résultats détaillés pour chaque appareil désenregistré.

Exemple de réponse

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}