Audience API

Hinweis

Die auf dieser Seite verwendete request_id ist ein Job-Token zur Abfrage des Status einer bulk*-Operation und hat nichts mit der Nachrichten-Anfrage-ID zu tun, die für das HTTP-Level-Tracing verwendet wird.

bulkSetTags

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

Setzt Tag-Werte für die Liste der Geräte.

Wichtig

Stellen Sie bei der Verwendung der bulkSetTags-Methode sicher, dass Tag-Werte für mindestens 50 Geräte festgelegt werden. Um Tags für ein einzelnes Gerät festzulegen, verwenden Sie die setTags-Methode.

Anfragekörper

Name	Typ	Beschreibung
application*	String	Pushwoosh-Anwendungscode
auth*	String	API-Zugriffstoken aus dem Pushwoosh Control Panel.
create_missing_tags	Boolean	Wenn wahr, werden fehlende Tags automatisch erstellt.
devices*	Object	Array von Geräten.
devices.hwid	String	Kann zur Identifizierung eines Geräts anstelle von user_id oder push_token verwendet werden. Mehr erfahren
devices.user_id	String	Kann zur Identifizierung eines Benutzers anstelle von hwid oder push_token verwendet werden. Mehr erfahren
devices.push_token	String	Kann zur Identifizierung eines Geräts anstelle von hwid oder user_id verwendet werden. Mehr erfahren
devices.list_operator	String	Definiert, wie Werte für Tags vom Listentyp festgelegt werden: set, append oder remove
devices.tags*	Object	Werte, die für die angegebenen Tags festgelegt werden sollen.

OK

{
  "request_id": "request_id zur Verwendung in der GET-Methode, um den Job-Status zu erhalten",
  "status": "Pending"
}

Fehler

{
  "message": "ungültige Anfrage"
}

Anfrage:

{
  "application": "application code",   // erforderlich. Pushwoosh-App-Code
  "auth": "Pushwoosh auth token",      // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
  "create_missing_tags": false,        // optional. Soll fehlende Tags automatisch erstellen
  "devices": [{                        // erforderlich. Array von Geräten
    "hwid": "device hwid",             // optional. Kann zur Identifizierung eines Geräts anstelle von
                                       //           "user_id" oder "push_token" verwendet werden.
    "user_id": "user ID",              // optional. Kann zur Identifizierung eines Benutzers anstelle von "hwid" oder "push_token" verwendet werden.
    "push_token": "device push token", // optional. Kann zur Identifizierung eines Geräts anstelle von "hwid" oder "user_id" verwendet werden.
    "list_operator": "set",            // erforderlich. Für Listen-Tags. Definiert, wie Werte für
                                       //           Tags vom Listentyp festgelegt werden: set, append oder remove
    "tags": {                          // erforderlich. Werte, die für die angegebenen Tags festgelegt werden sollen.
      "tag_name": "tagvalue",          //           korrekten Wertetyp verwenden
      "tag_name2": "tagvalue2"
    }
  }]
}

Antwort:

{
  "request_id": "request_id zur Verwendung in der GET-Methode, um den Job-Status zu erhalten",
  "status": "Pending"
}

bulkSetTags-Status

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

Gibt den Status der /bulkSetTags-Operation zurück

Pfadparameter

Name	Typ	Beschreibung
request_id	String	Anfrage-ID aus dem vorherigen /bulkSetTags-Aufruf

Abfrageparameter

Name	Typ	Beschreibung
detailed	Boolean	(true/false) ob detaillierte Informationen pro Gerät zurückgegeben werden sollen

Antwort:

{
  "request_id": "ID der Anfrage",
  "status": "Completed",          // auch "Pending", "Failed"
  "progress": 100,                // Job-Fortschritt 0-100
  "devices_success": 100,         // erfolgreiche Geräte
  "devices_not_found": 0,         // Geräte nicht in Pushwoosh gefunden
  "devices_failed": 0,            // fehlerhaft
  "devices": [{                   // Gerätebericht (nur bei detailed = true)
    "hwid": "device hwid",
    "status": "done",             // auch "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "Tag nicht gefunden",
      "tagName3": "falscher Wert. erwarte :string"
    }
  }]
}

bulkRegisterDevice

Registriert mehrere Geräte in Pushwoosh in einer einzigen Anfrage. Es ermöglicht auch die Angabe verschiedener Tags für jedes Gerät.

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

Parameter des Anfragekörpers

Parameter	Typ	Erforderlich	Beschreibung
application	string	Ja	Pushwoosh-Anwendungscode
auth	string	Ja	API-Zugriffstoken.
devices	array	Ja	Ein Array von Geräteobjekten. Jedes Objekt repräsentiert ein Gerät und die zugehörigen Daten. Details finden Sie in der Tabelle Parameter des Geräteobjekts unten.

Parameter des Geräteobjekts

Parameter	Typ	Erforderlich	Beschreibung
hwid	string	Ja	Die Hardware-ID oder eindeutige Kennung für das Gerät.
push_token	string	Ja	Push-Token für das Gerät.
platform	integer	Ja	Die Plattformkennung. Mehr erfahren
list_operator	string	Nein	Bestimmt die Aktion für Tags vom Listentyp: - “append”: Fügt den angegebenen Wert zur Tag-Liste hinzu. - “remove”: Entfernt den angegebenen Wert aus der Tag-Liste. Hinweis: Wenn der Parameter list_operator nicht angegeben ist, werden alle vorhandenen Werte in der Tag-Liste durch die angegebenen Werte ersetzt.
tags	object	Nein	Benutzerdefinierte Tags, die dem Gerät zugewiesen sind. Tags sind Schlüssel-Wert-Paare, die zur Segmentierung verwendet werden.

Anfragebeispiel

{
  "application": "application code",   // erforderlich. Pushwoosh-App-Code
  "auth": "Pushwoosh auth token",      // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
  "devices": [{                        // erforderlich. Array von Geräten
    "hwid": "device hwid",             // erforderlich. Eindeutige Kennung für das Gerät (kann eine E-Mail sein).
    "push_token": "device push token", // erforderlich. Push-Benachrichtigungstoken für das Gerät.
    "platform": 14,                    // erforderlich. Geräteplattform (z. B. 14 für E-Mail).
    "list_operator": "append",         // optional. Für Listen-Tags. Fügt den/die angegebenen Wert(e) zum Tag vom Listentyp hinzu oder entfernt ihn/sie.
    "tags": {                          // optional. Werte, die für die angegebenen Tags festgelegt werden sollen.
      "language": "en",                //           korrekten Wertetyp verwenden.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // erforderlich. Eindeutige Kennung für das zweite Gerät.
    "push_token": "device push token 2", // erforderlich. Push-Benachrichtigungstoken für das Gerät.
    "platform": 14,                    // erforderlich. Geräteplattform.
    "list_operator": "remove",         // optional. Fügt Werte zu Tags vom Listentyp hinzu oder entfernt sie.
    "tags": {                          // optional. Werte, die aus den angegebenen Tags entfernt werden sollen.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // erforderlich. Eindeutige Kennung für das dritte Gerät.
    "push_token": "device push token 3", // erforderlich. Push-Benachrichtigungstoken für das Gerät.
    "platform": 14,                    // erforderlich. Geräteplattform.
    "tags": {                          // optional. Werte, die für die angegebenen Tags festgelegt werden sollen.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Antwort

Die Methode antwortet mit einer Operations-ID, die verwendet werden kann, um den Status und die Ergebnisse des Massenregistrierungsprozesses zu verfolgen.

{
  "request_id": "request_id zur Verwendung in der GET-Methode, um den Job-Status zu erhalten",
  "status": "Pending"
}

bulkRegisterDevice-Status

Sie können den Status eines Massenregistrierungsprozesses überprüfen, indem Sie die folgende GET-Anfrage stellen:

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

Parameter	Typ	Erforderlich	Beschreibung
request_id	string	Ja	Die von der POST-Anfrage zurückgegebene Anfrage-ID.
detailed	boolean	Nein	Wenn auf true gesetzt, enthält die Antwort detaillierte Ergebnisse für jedes registrierte Gerät.

Beispielantwort

{
  "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

Meldet mehrere Geräte in einer einzigen Anfrage von Pushwoosh ab.

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

Parameter des Anfragekörpers

Parameter	Typ	Erforderlich	Beschreibung
application	string	Ja	Pushwoosh-Anwendungscode
auth	string	Ja	API-Zugriffstoken
devices	array	Ja	Ein Array von Geräteobjekten. Jedes Objekt repräsentiert ein Gerät und die zugehörigen Daten. Details finden Sie in der Tabelle Parameter des Geräteobjekts unten.

Parameter des Geräteobjekts

Parameter	Typ	Erforderlich	Beschreibung
hwid	string	Ja	Die Hardware-ID oder eindeutige Kennung für das Gerät. Mehr erfahren

Anfragebeispiel

{
  "application": "application code",   // erforderlich. Pushwoosh-App-Code
  "auth": "Pushwoosh auth token",      // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
  "devices": [{                        // erforderlich. Array von Geräten
    "hwid": "device hwid",             // erforderlich. Eindeutige Kennung für das Gerät (kann eine E-Mail sein).
  },
  {
    "hwid": "device hwid 2",           // erforderlich. Eindeutige Kennung für das zweite Gerät.
  },
  {
    "hwid": "device hwid 3",           // erforderlich. Eindeutige Kennung für das dritte Gerät.
  }]
}

Antwort

Die Methode antwortet mit einer Operations-ID, die verwendet werden kann, um den Status und die Ergebnisse des Massenprozesses zu verfolgen.

{
  "request_id": "request_id zur Verwendung in der GET-Methode, um den Job-Status zu erhalten",
  "status": "Pending"
}

bulkUnregisterDevice-Status

Sie können den Status eines Massen-Abmeldungsprozesses überprüfen, indem Sie die folgende GET-Anfrage stellen:

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

Parameter	Typ	Erforderlich	Beschreibung
request_id	string	Ja	Die von der POST-Anfrage zurückgegebene Anfrage-ID.
detailed	boolean	Nein	Wenn auf true gesetzt, enthält die Antwort detaillierte Ergebnisse für jedes abgemeldete Gerät.

Beispielantwort

{
  "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"
    }
  ]
}