Dokumentation Target Target-Entwicklerhandbuch

Verwalten des Recommendations-Katalogs mithilfe von APIs

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

Entwickler

Sie haben gelernt, wie Sie mit dem JWT-Authentifizierungsfluss ein Zugriffstoken generieren die Adobe Target-Admin-APIs auf der 🔗Adobe Developer Console verwenden, um sicherzustellen, dass Sie die 🔗 Anforderungen zur Verwendung der Recommendations-APIs.

Sie können jetzt die Recommendations-APIs verwenden, um Elemente in Ihrem Recommendations-Katalog hinzuzufügen, zu aktualisieren oder zu löschen. Wie alle anderen Adobe Target Recommendations Admin-APIs müssen auch diese authentifiziert werden.

NOTE

Senden Sie die IMS: JWT Generate + Auth via User Token-Anfrage immer dann, wenn Sie Ihr Zugriffstoken zur Authentifizierung aktualisieren müssen, da es nach 24 Stunden abläuft. Anweisungen finden unter „Konfigurieren der AdobeAPI-Authentifizierung“.

JWT3ff

Bevor Sie fortfahren, rufen Sie die Recommendations Postman-Sammlung ab.

Erstellen und Aktualisieren von Elementen mit der API zum Speichern von Entitäten

Um Ihre Recommendations-Produktdatenbank mithilfe der API anstelle eines CSV-Produkt-Feeds oder mit Target-Anfragen aufzufüllen, die auf Produktseiten ausgelöst werden, verwenden Sie die Entitäten-API speichern. Diese Anfrage fügt ein Element in einer einzigen Target-Umgebung hinzu oder aktualisiert es. Die Syntax lautet:

POST https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities

Zum Beispiel können „Entitäten speichern“ verwendet werden, um Artikel zu aktualisieren, wenn bestimmte Schwellenwerte - wie Schwellenwerte für den Bestand oder Preis - erreicht werden, um diese Artikel zu kennzeichnen und zu verhindern, dass sie empfohlen werden.

Navigieren Sie zu Target > Setup > Hosts > CONTROL Environments , um die Zielumgebungs-ID abzurufen, in der Sie ein Element hinzufügen oder aktualisieren möchten.
Überprüfen Sie, TENANT_ID und API_KEY auf die zuvor festgelegten Postman-Umgebungsvariablen verweisen. Verwenden Sie die folgende Abbildung zum Vergleich. Ändern Sie bei Bedarf die Kopfzeilen und den Pfad in Ihrer API-Anfrage, sodass sie denen in der Abbildung unten entsprechen.

Geben Sie Ihre JSON als Roh-Code im Textkörper ein. Vergessen Sie nicht, Ihre Umgebungs-ID mithilfe der Variablen environment anzugeben. (Im folgenden Beispiel ist die Umgebungs-ID 6781.)

Nachfolgend finden Sie ein JSON-Beispiel, das entity.id kit2001 mit zugehörigen Entitätswerten für ein Toaster-Ofen-Produkt in die Umgebung 6781 hinzufügt.

code language-none

code language-none
`{ "entities": [{ "name": "Toaster Oven", "id": "kit2001", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 77, "margin": 23, "message": "crashing helicopter", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 19.2 } }] }`

    {
    "entities": [{
            "name": "Toaster Oven",
            "id": "kit2001",
            "environment": 6781,
            "categories": [
                "housewares:appliances"
            ],
            "attributes": {
                "inventory": 77,
                "margin": 23,
                "message": "crashing helicopter",
                "pageUrl": "www.foobar.foo.com/helicopter.html",
                "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
               "value": 19.2
            }
        }]
    }

Klicken Sie auf Send. Sie sollten die folgende Antwort erhalten.

Das JSON-Objekt kann skaliert werden, um mehrere Produkte zu senden. Diese JSON-Datei gibt beispielsweise zwei Entitäten an.

code language-none

code language-none
{ "entities": [{ "name": "Toaster Oven", "id": "kit2001", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 89, "margin": 11, "message": "Toaster Oven", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 102.5 } }, { "name": "Blender", "id": "kit2002", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 36, "margin": 5, "message": "Blender", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 54.5 } } ] }

    {
        "entities": [{
                "name": "Toaster Oven",
                "id": "kit2001",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 89,
                    "margin": 11,
                    "message": "Toaster Oven",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 102.5
                }
            },
            {
                "name": "Blender",
                "id": "kit2002",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 36,
                    "margin": 5,
                    "message": "Blender",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 54.5
                }
            }
        ]
    }

Jetzt seid ihr dran! Verwenden Sie die Save Entities-API, um die folgenden Elemente zu Ihrem Katalog hinzuzufügen. Verwenden Sie die obige Beispiel-JSON als Ausgangspunkt. (Sie müssen die JSON-Datei erweitern, um zusätzliche Entitäten einzuschließen.)

Die letzten beiden Elemente gehören anscheinend nicht dazu. Sehen wir uns diese mithilfe der Get Entity-API an und löschen Sie sie ggf. mithilfe der Delete Entities-API.

Abrufen von Elementdetails mit der Get Entity API

Um die Details eines vorhandenen Elements abzurufen, verwenden Sie die Entitäts-API. Die Syntax lautet:

GET https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities/[entity.id]

Entitätsdetails können jeweils nur für eine Entität abgerufen werden. Sie können Entität abrufen verwenden, um zu bestätigen, dass Aktualisierungen im Katalog erwartungsgemäß vorgenommen wurden, oder um anderweitig den Inhalt des Katalogs zu überprüfen.

Geben Sie in der API-Anfrage die Entitäts-ID mithilfe der Variablen entityId an. Das folgende Beispiel gibt Details für die Entität zurück, deren entityId=kit2004 ist.
Überprüfen Sie, TENANT_ID und API_KEY auf die zuvor festgelegten Postman-Umgebungsvariablen verweisen. Verwenden Sie die folgende Abbildung zum Vergleich. Ändern Sie bei Bedarf die Kopfzeilen und den Pfad in Ihrer API-Anfrage, sodass sie denen in der Abbildung unten entsprechen.

Senden Sie die Anfrage.

GetEntity3
Wenn Sie einen Fehler erhalten, der besagt, dass die Entität nicht gefunden wurde, wie im Beispiel oben gezeigt, überprüfen Sie, ob Sie die Anfrage an die richtige Zielumgebung senden.

note note
NOTE
Wenn keine Umgebung explizit angegeben ist, versucht Get Entity, die Entität nur aus Ihrer Standardumgebung“. Wenn Sie aus einer anderen Umgebung als der Standardumgebung abrufen möchten, müssen Sie die Umgebungs-ID angeben.

Fügen Sie bei Bedarf den environmentId Parameter hinzu und senden Sie die Anfrage erneut.
Senden Sie eine weitere Get Entity-Anfrage, dieses Mal, um die Entität zu überprüfen, deren entityId=kit2005 ist.

Angenommen, Sie entscheiden, dass diese Entitäten aus Ihrem Katalog entfernt werden müssen. Verwenden wir die Delete Entities-API.

Löschen von Elementen mit der Delete Entities-API

Um Elemente aus Ihrem Katalog zu entfernen, verwenden Sie die Entitäten löschen-API. Die Syntax lautet:

DELETE https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities?ids=[comma-delimited-entity-ids]&environment=[environmentId]

WARNING

Die Delete Entities-API löscht Entitäten, auf die von den von Ihnen angegebenen IDs verwiesen wird. Wenn keine Entitäts-IDs angegeben werden, werden alle Entitäten in der angegebenen Umgebung gelöscht. Wenn keine Umgebungs-ID angegeben wird, werden Entitäten aus allen Umgebungen gelöscht. Verwenden Sie dies mit Vorsicht!

Navigieren Sie zu Target > Setup > Hosts > Environments , um die Zielumgebungs-ID abzurufen, aus der Sie Elemente löschen möchten.
Geben Sie in der API-Anfrage die Entitäts-IDs der Entitäten an, die Sie löschen möchten, indem Sie die &ids=[comma-delimited-entity-ids] (einen Abfrageparameter) verwenden. Wenn Sie mehr als eine Entität löschen, trennen Sie die IDs durch Kommas.
Geben Sie die Umgebungs-ID mithilfe der &environment=[environmentId] an. Andernfalls werden Entitäten aus allen Umgebungen gelöscht.
Überprüfen Sie, TENANT_ID und API_KEY auf die zuvor festgelegten Postman-Umgebungsvariablen verweisen. Verwenden Sie die folgende Abbildung zum Vergleich. Ändern Sie bei Bedarf die Kopfzeilen und den Pfad in Ihrer API-Anfrage, sodass sie denen in der Abbildung unten entsprechen.
Senden Sie die Anfrage.
Überprüfen Sie Ihre Ergebnisse mit Get Entity, das nun anzeigen sollte, dass die gelöschten Entitäten nicht gefunden werden können.

Herzlichen Glückwunsch! Sie können jetzt die Recommendations-APIs verwenden, um Details zu den Entitäten in Ihrem Katalog zu erstellen, zu aktualisieren, zu löschen und zu erhalten. Im nächsten Abschnitt erfahren Sie, wie Sie benutzerdefinierte Kriterien verwalten.

<!— Nächste „Benutzerdefinierte Kriterien verwalten“ > —>

recommendation-more-help

6906415f-169c-422b-89d3-7118e147c4e3