Benutzerattribute festlegen

Aufrufadresse

POST /v1/user/property

Authentifizierungsverfahren

Die EngageLab REST API verwendet HTTP Basic Authentication als Verifizierungsmethode. Fügen Sie den Header „Authorization“ hinzu:

              
              Authorization: Basic ${base64_auth_string}

            

Der base64_auth_string wird folgendermaßen generiert: base64(api_key:api_secret).

• Der Header-Name ist „Authorization“, der Wert ist das base64-codierte „username:password“-Paar (durch einen Doppelpunkt getrennt).
• Für die MA API entspricht der Benutzername dem APIKey und das Passwort dem APISecret. Bitte richten Sie eine API-Datenquelle ein, um APIKey und APISecret zu erhalten.

Beispiel für eine Anfrage

Anfrage-Header

              
              > POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            

Anfrage-Body

              
              {
    "euid": 10362473,
    "type": "set",
    "properties": {
        "user_number_once": 46.2, // Benutzerattributname und Attributwert
        "user_string_once": "refef",
        "user_datetime_once": "2023-12-12 00:56:23"
    }
}

            

Anfrageparameter

Operationstypen

Alle Eigenschaften einer Anfrage verwenden denselben type. Unterstützt werden set, increase, add, remove, delete, setOnce und update.

Objekt-Array-Operationen

Bei object_array ist der Wert für add ein einzelnes JSON-Objekt und der Wert für set ein JSON-Objekt-Array. remove und update suchen mit $identifier_key und $identifier_value; das Identifikatorfeld muss ein definiertes string- oder number-Unterfeld sein.

Für remove sind ausschließlich diese Identifikatorfelder zulässig:

              
              {
  "euid": 10362473,
  "type": "remove",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001"
    }
  }
}

            

update erfordert zusätzlich ein nicht leeres $new_object. Es darf das Identifikatorfeld nicht enthalten; Felder mit dem Wert null werden aus dem gefundenen Element entfernt. Der Identifikator muss genau ein Array-Element treffen.

              
              {
  "euid": 10362473,
  "type": "update",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001",
      "$new_object": {
        "model": "iPhone 16",
        "legacy_field": null
      }
    }
  }
}

            

Rückgabeparameter

Erfolgsmeldung

              
              {
    "code": 0,
    "message": "success"
}

            

Fehlerfall

              
              {
    "code": 55102,
    "message": "Ungültige Benutzereigenschaften vorhanden"
}

            

Fehlercodes