Zum Inhalt springen

Diese Seite wurde automatisch übersetzt und kann Ungenauigkeiten enthalten. Um einen Übersetzungsfehler zu melden, nutzen Sie das Feedback unten im Inhaltsverzeichnis rechts auf der Seite.

Datenobjekt ersetzen

put

/data_objects/objects/{type_name}/{object_id}

Verwenden Sie diesen Endpunkt, um ein Datenobjekt zu erstellen oder zu ersetzen. Dabei werden alle Attribute vollständig ersetzt.

Wichtig

Datenobjekte sind allgemein verfügbar, aber Ihr Workspace muss für Accounts bereitgestellt sein, bevor Sie diesen Endpunkt verwenden können. Um die Bereitstellung anzufordern, gehen Sie zu Dateneinstellungen > Accounts und füllen Sie den Fragebogen aus. Weitere Informationen finden Sie unter Accounts aktivieren.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung data_objects.update.

Rate-Limit

Dieser Endpunkt gehört zum Schreib-Bucket für Datenobjekte und hat ein Standardlimit von 1000 Anfragen pro Minute.

Pfadparameter

Die folgende Tabelle listet und beschreibt die Pfadparameter für den Endpunkt /data_objects/objects/{type_name}/{object_id}.

Parameter	Erforderlich	Datentyp	Beschreibung
`type_name`	Erforderlich	String	Maschinenname des Datenobjekttyps
`object_id`	Erforderlich	String	Objektbezeichner

Anfrageparameter

Die folgende Tabelle listet und beschreibt die Parameter des JSON-Anfragekörpers für den Endpunkt /data_objects/objects/{type_name}/{object_id}.

Parameter	Erforderlich	Datentyp	Beschreibung
`attributes`	Erforderlich	Objekt	Vollständige Objektattribute. Ausgelassene Felder werden geleert
`display_name`	Optional	String	Anzeigename für das Objekt. Wenn der Typ ein Quellfeld für den Anzeigenamen hat, hat der Wert dieses Feldes Vorrang. Standardmäßig `object_id`

Beispielanfrage

Dieser Abschnitt enthält einen JSON-Beispiel-Payload und eine cURL-Beispielanfrage.

Beispiel-Payload für die Anfrage

{
  "attributes": {
    "name": "Updated Account"
  }
}

cURL-Beispielanfrage

Dieses Beispiel ersetzt die gespeicherten Attribute von acct-123 durch die im Payload enthaltenen. Wenn kein Datensatz mit diesem Bezeichner existiert, wird er durch diese Anfrage erstellt.

curl --location --request PUT 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "attributes": {
    "name": "Updated Account"
  }
}'

Antwort

Dieser Abschnitt enthält ein Beispiel für eine erfolgreiche Antwort sowie die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 200 kann den folgenden Antwortkörper zurückgeben. Dieser Endpunkt gibt 200 zurück, unabhängig davon, ob die Anfrage das Objekt erstellt oder ersetzt hat.

{
  "data_object": {
    "type_name": "account",
    "object_id": "acct-123",
    "attributes": { "name": "Updated Account" }
  }
}

Antwortparameter

Die folgende Tabelle listet und beschreibt die Felder in einer erfolgreichen Antwort.

Parameter	Erforderlich	Datentyp	Beschreibung
`data_object`	Erforderlich	Objekt	Erstellter oder ersetzter Datenobjektdatensatz
`data_object.type_name`	Erforderlich	String	Maschinenname des Datenobjekttyps
`data_object.object_id`	Erforderlich	String	Bezeichner des Datenobjekts
`data_object.attributes`	Erforderlich	Objekt	Gespeicherte Objektattribute, nach Feldnamen geschlüsselt

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt auf und zeigt, wie Sie diese beheben können.

Status	Ursache	Lösungshinweis
`400`	Validierungsfehler	Überprüfen Sie, ob jedes Feld in `attributes` im Typschema existiert und den richtigen Datentyp verwendet.
`404`	Typ nicht gefunden (`data-object-type-not-found`)	Überprüfen Sie, ob `type_name` im Workspace existiert und exakt mit dem Maschinennamen übereinstimmt.
`422`	Datensatzlimit erreicht (`data-object-record-limit-exceeded`), wenn diese Anfrage ein neues Objekt erstellen würde	Reduzieren Sie die Anzahl der Objekte für den Typ oder kontaktieren Sie den Braze-Support bezüglich Ihrer Workspace-Limits.
`401`	Fehlender oder ungültiger REST-API-Schlüssel	Überprüfen Sie, ob der `Authorization`-Header `Bearer YOUR_REST_API_KEY` verwendet und der Schlüssel aktiv ist.
`403`	API-Schlüssel hat keine Berechtigung oder die Anfrage wird durch eine Allowlist blockiert	Überprüfen Sie, ob der Schlüssel über die Berechtigung `data_objects.update` verfügt und ob Ihre Quell-IP auf der Allowlist des Schlüssels steht, sofern konfiguriert.
`429`	Rate-Limit überschritten	Versuchen Sie es nach `X-RateLimit-Reset` erneut und reduzieren Sie die Anfragehäufigkeit.

New Stuff!