Passer au contenu

Créer ou remplacer des relations d’objets en masse

put

/data_objects/object_relationships

Utilisez cet endpoint pour créer ou remplacer jusqu’à 50 relations d’objet à objet en une seule requête.

Braze accepte la requête et la traite en arrière-plan. Une réponse 202 signifie que le lot est en file d’attente, et non qu’il a été appliqué. Pour modifier une seule relation et voir le changement immédiatement, utilisez Remplacer une relation d’objet. Pour savoir quand utiliser l’un ou l’autre, consultez Endpoints en masse.

Conditions préalables

Pour utiliser cet endpoint, vous avez besoin d’une clé API avec l’autorisation data_objects.object_relationships.bulk_upsert. Les autorisations portant sur un seul enregistrement, comme data_objects.object_relationships.create, ne donnent pas accès à cet endpoint.

Limite de débit

Cet endpoint fait partie du compartiment d’écriture en masse des objets de données, avec une limite par défaut de 1 000 requêtes par minute et par espace de travail. Cette limite est partagée entre les six endpoints en masse ainsi qu’avec les synchronisations d’objets de données de Cloud Data Ingestion, et elle est distincte de la limite d’écriture portant sur un seul enregistrement.

Paramètres de la requête

Le tableau suivant répertorie et décrit les paramètres du corps de requête JSON pour l’endpoint /data_objects/object_relationships.

Paramètre Requis Type de données Description
records Requis Tableau Les relations d’objets à créer ou à remplacer. Doit contenir de 1 à 50 enregistrements. Braze rejette tout autre champ de premier niveau.
records[].type_name Requis Chaîne de caractères Type de l’objet source
records[].object_id Requis Chaîne de caractères Identifiant de l’objet source
records[].rel_kind Requis Chaîne de caractères Nom du type de relation. Pour obtenir la liste des valeurs valides, utilisez Lister les types de relations d’objets.
records[].related_type_name Requis Chaîne de caractères Type de l’objet cible
records[].related_object_id Requis Chaîne de caractères Identifiant de l’objet cible
records[].attributes Requis Objet Attributs de la relation, indexés par nom de champ. Envoyez {} si le type de relation n’en comporte aucun.

Comment Braze traite le lot

  • La validation fonctionne en tout ou rien. Si un enregistrement échoue à la validation, Braze rejette l’ensemble de la requête avec une erreur 400, n’enregistre rien et liste toutes les erreurs. Corrigez les erreurs et renvoyez la requête complète.
  • Les vérifications ont lieu pendant le traitement. Braze vérifie que les types, le type de relation et les objets existent, et que les attributs correspondent aux champs du type de relation, au moment où il traite le lot. Une requête qui renvoie 202 peut donc encore produire des échecs pour certains enregistrements par la suite. Consultez Échecs de traitement.
  • Les enregistrements sont ordonnés selon l’heure de réception. Braze horodate chaque enregistrement avec l’heure à laquelle il a reçu la requête : n’envoyez donc pas updated_at. Braze rejette toute requête qui l’inclut. Lorsque deux requêtes modifient la même relation, celle reçue en dernier par Braze l’emporte, et Braze ignore une écriture plus ancienne qui arrive ensuite.
  • Les relations peuvent attendre leurs objets. Une relation dont l’objet source ou cible n’existe pas encore est mise en attente au lieu d’échouer immédiatement. Braze effectue de nouvelles tentatives pendant environ 40 heures (10 tentatives). Si l’objet n’existe toujours pas passé ce délai, l’enregistrement échoue avec data-object-dependency-not-found.

Exemple de requête

Cette section présente un exemple de payload JSON et un exemple de requête cURL.

Exemple de payload de requête

{
  "records": [
    {
      "type_name": "contact",
      "object_id": "contact-001",
      "rel_kind": "works_at",
      "related_type_name": "account",
      "related_object_id": "acct-001",
      "attributes": {"since": "2024-01-15T00:00:00Z"}
    }
  ]
}

Exemple de requête cURL

Cet exemple relie contact-001 à acct-001 avec le type de relation works_at et enregistre la date de début de la relation.

curl --location --request PUT 'https://rest.iad-01.braze.com/data_objects/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "records": [
    {
      "type_name": "contact",
      "object_id": "contact-001",
      "rel_kind": "works_at",
      "related_type_name": "account",
      "related_object_id": "acct-001",
      "attributes": {"since": "2024-01-15T00:00:00Z"}
    }
  ]
}'

Réponse

Cette section présente un exemple de réponse réussie ainsi que les champs de la réponse.

Exemple de réponse réussie

Le code de statut 202 peut renvoyer le corps de réponse suivant.

{
  "source_import_id": "api-20261022T153012123456-9f3a1c2b",
  "status": "queued",
  "record_count": 1
}

Paramètres de la réponse

Le tableau suivant répertorie et décrit les champs d’une réponse réussie.

Paramètre Requis Type de données Description
source_import_id Requis Chaîne de caractères L’identifiant généré par Braze pour cette requête. Chaque requête constitue sa propre importation.
status Requis Chaîne de caractères Toujours queued. Le lot est accepté et en attente de traitement.
record_count Requis Entier Le nombre d’enregistrements dans la requête

Échecs de traitement

Braze ne renvoie pas ces codes via l’endpoint. Il les enregistre pour chaque enregistrement concerné lors du traitement d’un lot en file d’attente.

Code Signification
data-object-type-not-found type_name ou related_type_name ne désigne aucun type actif dans l’espace de travail.
data-object-relationship-type-not-found rel_kind ne désigne aucun type de relation actif pour ces types.
data-object-schema-mismatch attributes ne correspond pas aux champs du type de relation. Le message indique chaque attribut en cause.
data-object-ingestion-rejected Tout autre rejet.
data-object-dependency-not-found L’objet source ou cible était toujours introuvable après environ 40 heures de nouvelles tentatives.

Erreurs

Une réponse 400 signifie que Braze n’a rien enregistré. Chaque erreur comporte un id, un message, le parameter en cause le cas échéant et, pour les erreurs au niveau de l’enregistrement, l’index de l’enregistrement (sa position dans records, à partir de 0).

{
  "errors": [
    {"index": 0, "id": "schema-mismatch", "parameter": "rel_kind", "message": "rel_kind is required"}
  ]
}

Le tableau suivant répertorie les erreurs courantes de cet endpoint et la manière de les résoudre.

Statut Cause Conseils
400 Requête invalide (invalid-request) : le corps n’est pas un objet JSON ou contient du JSON mal formé, records est absent ou contient moins de 1 ou plus de 50 entrées, ou le corps contient un champ défini par Braze (source_type, source_import_id, source_chunk_id ou record_type) Envoyez un objet JSON dont le seul champ est records, avec 1 à 50 enregistrements.
400 Non-concordance de schéma (schema-mismatch) : un enregistrement ne contient pas un champ requis, contient un champ non reconnu (y compris updated_at), ou contient un champ du mauvais type ou une chaîne vide Corrigez chaque enregistrement listé et renvoyez la requête complète.
401 Clé REST API manquante ou invalide Vérifiez que l’en-tête Authorization utilise Bearer YOUR_REST_API_KEY et que la clé est active.
403 La clé API ne dispose pas de l’autorisation requise ou la requête est bloquée par la liste d’autorisation Vérifiez que la clé dispose de data_objects.object_relationships.bulk_upsert et que votre adresse IP source figure dans la liste d’autorisation de la clé, si elle est configurée.
404 Les objets de données ne sont pas activés pour votre entreprise Vérifiez que votre espace de travail est provisionné pour les comptes.
429 Limite de débit dépassée Réessayez après X-RateLimit-Reset et réduisez la fréquence des requêtes.
500 Le lot n’a pas pu être accepté (internal-error) Braze n’a rien accepté : vous pouvez donc réessayer la requête en toute sécurité.
New Stuff!