DokumentationJourney OptimizerHandbuch für Journey Optimizer

Bereitstellen von Angeboten mithilfe der Decisioning-API decisioning-api

Last update: Fri Jan 31 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Experte
  • Entwickler

Mit dem Entscheidungs-Management können Sie personalisierte Angebotserlebnisse für Endbenutzer erstellen und bereitstellen, und zwar über Kanäle und Anwendungen hinweg und unter Verwendung von Business-Logik und Entscheidungsregeln. Ein Angebot ist eine Marketing-Botschaft, der ggf. Regeln zugeordnet sind, die angeben, wer für die Anzeige des Angebots infrage kommt.

Sie können Angebote erstellen und bereitstellen, indem Sie eine POST-Anfrage an die Decisioning-API senden.

Dieses Tutorial erfordert ein Verständnis von APIs, insbesondere im Hinblick auf das Entscheidungs-Management. Weitere Informationen finden Sie im Entwicklerhandbuch zur Entscheidungs-Management-API. Für dieses Tutorial benötigen Sie außerdem Werte für eine eindeutige Platzierungs- und Entscheidungskennung. Wenn Sie diese Werte nicht erhalten haben, finden Sie in den Tutorials zum Erstellen einer Platzierung und zum Erstellen einer Entscheidung weitere Informationen.

Erforderliche Kopfzeilen required-headers

Die folgende Tabelle zeigt die gültigen Werte, die die Felder Content-Type und Accept im Anfrage-Header enthalten:

Header-Name
Wert
Akzeptieren
application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-response;version=1.0"
Inhaltstyp
application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-request;version=1.0"
Autorisierung
Bearer {ACCESS_TOKEN}
x-gw-ims-org-id
{IMS_ORG}
x-sandbox-name
{SANDBOX_NAME}
x-api-key
{API_KEY}
  • Alle Anfragen, die eine Payload enthalten (POST,PUT,PATCH), benötigen eine Inhaltstyp-Kopfzeile.

API-Anfrage request

API-Format

POST /{ENDPOINT_PATH}/decisions
Parameter
Beschreibung
Beispiel
{ENDPOINT_PATH}
Der Endpunktpfad für Repository-APIs.
https://platform.adobe.io/data/core/ods

Anfrage

curl -X POST 'https://platform.adobe.io/data/core/ods/decisions' \
-H 'Accept: application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-response;version=1.0"' \
-H 'Content-Type: application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-request;version=1.0"' \
-H 'Authorization: Bearer {ACCESS_TOKEN}....' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-H 'x-request-id: e9ac8d7e-3e77-4b38-8726-555ef1737b32-example' \
-d '{
    "xdm:propositionRequests": [
        {
            "xdm:activityId": "dps:offer-activity:15ded04b1786ea27",
            "xdm:placementId": "dps:offer-placement:15d9bc01d35e1238"
        }
    ],
    "xdm:profiles": [
        {
            "xdm:identityMap": {
                "Email": [
                    {
                        "xdm:id": "example@adobe.com",
                        "primary": true
                    }
                ]
            }
        }
    ],
    "xdm:allowDuplicatePropositions": {
        "xdm:acrossActivities": true,
        "xdm:acrossPlacements": true
    },
    "xdm:responseFormat": {
        "xdm:includeContent": true,
        "xdm:includeMetadata": {
            "xdm:activity": [
                "name"
            ],
            "xdm:option": [
                "name"
            ],
            "xdm:placement": [
                "name"
            ]
        }
    }
}'
Eigenschaft
Beschreibung
Beispiel
xdm:propositionRequests
Dieses Objekt enthält die Platzierungs- und Entscheidungskennungen.
xdm:propositionRequests.xdm:placementId
Die eindeutige Platzierungskennung.
"xdm:placementId": "dps:offer-placement:ffed0456"
xdm:propositionRequests.xdm:activityId
Die eindeutige Entscheidungskennung.
"xdm:activityId": "dps:offer-activity:ffed0123"
xdm:itemCount
Die Anzahl der zurückzugebenden Angebote. Die maximale Anzahl ist 30.
"xdm:itemCount": 2
xdm:profiles
Dieses Objekt enthält Informationen über das Profil, für das die Entscheidung angefordert wird. Bei einer API-Anfrage enthält es ein einziges Profil.
xdm:profiles.xdm:identityMap
Dieses Objekt enthält eine Reihe von Endbenutzeridentitäten, die auf dem Namespace-Integrations-Code der Identität basieren. Die Identitätszuordnung kann mehr als eine Identität von jedem Namespace enthalten. Weitere Informationen zu Namespaces finden Sie auf dieser Seite.
Email: [{"xdm:id": "123@abc.com"}]
xdm:profiles.xdm:decisionRequestId
Die vom Client erzeugte Kennung, mit der eine Profilentscheidungsanfrage eindeutig identifiziert werden kann. Diese Kennung wird in der Antwort zurückgesendet und hat keinen Einfluss auf das Ergebnis der Entscheidung.
"xdm:decisionRequestId": "0AA00002-0000-1224-c0de-cjf98Csj43"
xdm:allowDuplicatePropositions
Dieses Objekt ist die Kontrollstruktur der Deduplizierungsregeln. Es besteht aus einer Reihe von Flags, die angeben, ob dieselbe Option für eine bestimmte Dimension vorgeschlagen werden kann. Wenn ein Flag auf „true“ gesetzt ist, sind Duplikate erlaubt und sollten in der durch das Flag angegebenen Kategorie nicht entfernt werden. Wenn ein Flag auf „false“ gesetzt ist, sollte die Entscheidungs-Engine nicht denselben Vorschlag für die gesamte Dimension machen und stattdessen die nächste beste Option für eine der Unterentscheidungen auswählen.
xdm:allowDuplicatePropositions.xdm:acrossActivities
Wenn auf „true“ gesetzt, kann mehreren Entscheidungen dieselbe Option zugewiesen werden.
"xdm:acrossActivities": true
xdm:allowDuplicatePropositions.xdm:acrossPlacements
Wenn auf „true“ gesetzt, kann mehreren Platzierungen dieselbe Option zugewiesen werden.
"xdm:acrossPlacements": true
xdm:mergePolicy.xdm:id
Gibt die Zusammenführungsrichtlinie an, nach der die vom Profilzugriffsdienst zurückgegebenen Daten verwaltet werden. Wenn in der Anfrage keine angegeben ist, gibt das Entscheidungs-Management nichts an den Profilzugriffs-Service weiter, andernfalls wird die vom Aufrufer bereitgestellte ID übergeben.
"xdm:id": "5f3ed32f-eaf1-456c-b0f0-7b338c4cb18a"
xdm:responseFormat
Eine Reihe von Flags, die den Inhalt der Antwort formatieren.
xdm:responseFormat.xdm:includeContent
Ein boolescher Wert, der den Inhalt der Antwort einschließt, wenn er auf true gesetzt wird.
"xdm:includeContent": true
xdm:responseFormat.xdm:includeMetadata
Ein Objekt, mit dem festgelegt wird, welche zusätzlichen Metadaten zurückgegeben werden. Wenn diese Eigenschaft nicht enthalten ist, werden standardmäßig xdm:id und repo:etag zurückgegeben.
name
xdm:responseFormat.xdm:activity
Dieses Flag identifiziert die spezifischen Metadateninformationen, die für xdm:activity zurückgegeben werden.
name
xdm:responseFormat.xdm:option
Dieses Flag identifiziert die spezifischen Metadateninformationen, die für xdm:option zurückgegeben werden.
name, characteristics
xdm:responseFormat.xdm:placement
Dieses Flag identifiziert die spezifischen Metadateninformationen, die für xdm:placement zurückgegeben werden.
name, channel, componentType

Antwort

Eine erfolgreiche Antwort gibt Informationen zu Ihrem Vorschlag zurück, einschließlich der eindeutigen xdm:propositionId.

{
  "xdm:propositionId": "5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8",
  "xdm:propositions": [
    {
      "xdm:activity": {
        "xdm:id": "dps:activity:ffed0123",
        "repo:etag": 4
      },
      "xdm:placement": {
        "xdm:id": "dps:placement:ffed0456",
        "repo:etag": 1
      },
      "xdm:options": [
        {
          "xdm:id": "dps:personalized-option:ccc0111",
          "repo:etag": 3,
          "@type": "https://ns.adobe.com/experience/decisioning/content-component-html-template",
          "xdm:content": "<html>some html</html>"
        },
        {
          "xdm:id": "dps:personalized-option:ccc0222",
          "repo:etag": 5,
          "@type": "https://ns.adobe.com/experience/decisioning/content-component-html-template",
          "xdm:content": "<html>hello, world</html>",
          "xdm:score": 45.65
        }
      ]
    },
    {
      "xdm:activity": {
        "xdm:id": "dps:activity:ffed0123",
        "repo:etag": 4
      },
      "xdm:placement": {
        "xdm:id": "dps:placement:ffed0789",
        "repo:etag": 2
      },
      "xdm:fallback": {
        "xdm:id": "dps:fallback:ccc0222",
        "repo:etag": 5,
        "@type": "https://ns.adobe.com/experience/decisioning/content-component-imagelink",
        "dc:format": "image/png",
        "xdm:deliveryURL": "https://cdn.adobe.com/content/1445323-1134331.png",
        "xdm:content": "https://www.adobe.com/index2.html"
      }
    }
  ],
  "ode:createDate": 1566497582038
}
Eigenschaft
Beschreibung
Beispiel
xdm:propositionId
Die eindeutige Kennung für die mit einem XDM-Entscheidungsereignis verbundene Vorschlagsentität.
"xdm:propositionId": "5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8"
xdm:propositions
Dieses Objekt enthält einen Vorschlag für eine einzelne Entscheidung. Für die Entscheidung können mehrere Optionen zurückgegeben werden. Wenn keine Optionen gefunden werden, wird das Fallback-Angebot der Entscheidung zurückgegeben. Vorschläge für einzelne Entscheidungen umfassen immer entweder eine options-Eigenschaft oder eine fallback-Eigenschaft. Wenn vorhanden, darf die options-Eigenschaft nicht leer sein.
xdm:propositions.xdm:activity
Dieses Objekt enthält die eindeutige Kennung für eine Entscheidung.
"xdm:id": "dps:activity:ffed0123"
xdm:propositions.xdm:placement
Dieses Objekt enthält die eindeutige Kennung für eine Angebotsplatzierung.
"xdm:id": "dps:placement:ffed0456"
xdm:propositions.xdm:options
Dieses Objekt enthält eine einzelne Option, einschließlich der eindeutigen Kennung. Falls vorhanden, darf dieses Objekt nicht leer sein.
xdm:id": "dps:personalized-option:ccc0111
xdm:propositions.xdm:options.@type
Definiert den Typ der Komponente. @type fungiert als Verarbeitungsvertrag für den Client. Wenn das Erlebnis zusammengestellt wird, sucht der Composer nach den Komponenten eines bestimmten Typs.
https://ns.adobe.com/experience/offer-management/content-component-imagelink
xdm:propositions.xdm:content
Das Format des Antwortinhalts.
Antwortinhalte können sein: text, html block oder image link.
xdm:score
Der Punktwert für eine Option, der auf Basis einer Ranking-Funktion berechnet wird, die der Option oder der Entscheidung zugeordnet ist. Dieses Feld wird von der API zurückgegeben, wenn eine Ranking-Funktion an der Ermittlung des Ergebnisses eines Angebots während des Rankings beteiligt ist.
"xdm:score": 45.65
xdm:propositions.xdm:fallback
Dieses Objekt enthält ein einzelnes Fallback-Angebot, einschließlich der eindeutigen Kennung.
"xdm:id": "dps:fallback:ccc0222"
xdm:propositions.xdm:fallback.dc:format
Die physische oder digitale Manifestation der Ressource. Normalerweise sollte das Format den Medientyp der Ressource enthalten. Das Format kann verwendet werden, um die Software, Hardware oder andere Geräte zu bestimmen, die zum Anzeigen oder Betreiben der Ressource erforderlich sind. Es wird empfohlen, einen Wert aus einem kontrollierten Vokabular auszuwählen, z. B. aus der Liste von Internet-Medientypen, die Computermedienformate definieren.
"dc:format": "image/png" oder "image/jpeg"
xdm:propositions.xdm:fallback.xdm:deliveryURL
Eine optionale URL, um das Asset aus einem Content Delivery Network oder Service-Endpunkt zu lesen. Diese URL wird verwendet, um von einem User Agent aus öffentlich auf das Asset zuzugreifen.
https://d37yhxrr0p3l3l.cloudfront.net/0fd0f090-a148-11ea-89e3-f1f2ad52f7e8/urn:aaid:sc:US:a68c86a6-9295-4940-a083-11916b665500/0/40d78a12-f8b6-3f07-8e67-7cb8ae2cc7ec
ode:createDate
Der Zeitpunkt, zu dem die Entscheidungsantwortnachricht erstellt wurde. Dies wird als Epoche-Zeit dargestellt.
"ode:createDate": 1566497582038

Antwort-Codes

In der folgenden Tabelle sind alle Codes aufgeführt, die in der Antwort zurückgegeben werden können:

Code
Beschreibung
200
Erfolgreich. Die Entscheidung wurde für bestimmte Tätigkeiten getroffen
400
Ungültiger Anfrageparameter. Die Anfrage kann vom Server aufgrund einer fehlerhaften Syntax nicht verstanden werden.
403
Verbotene, unzureichende Berechtigungen.
422
Nicht verarbeitbare Entität. Die Anfragesyntax ist korrekt, kann jedoch aufgrund von semantischen Fehlern nicht verarbeitet werden.
429
Zu viele Anfragen. Der Benutzer oder die Benutzerin hat zu viele Anfragen innerhalb einer bestimmten Zeit gesendet.
500
Interner Server-Fehler. Der Server ist auf eine unerwartete Bedingung gestoßen, die ihn daran hindert, die Anfrage zu bearbeiten.
503
Dienst aufgrund einer Server-Überlastung nicht verfügbar. Der Server kann die Anfrage aufgrund einer temporären Überlastung derzeit nicht verarbeiten.

Nächste Schritte next-steps

Durch Befolgen dieses API-Handbuchs haben Sie Angebote mithilfe der Decisions-API erstellt und bereitgestellt. Weitere Informationen finden Sie unter Übersicht über das Entscheidungs-Management.

recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76