Übersicht über die Modelle-API
Mit der Models-API, auch als Blockierungsliste-API bezeichnet, können Benutzer die Liste der Funktionen anzeigen und verwalten, die in Modellen für das maschinelle Lernen für Aktivitäten vom Typ Automated Personalization (AP) und Auto-Target (AT) verwendet werden. Wenn ein Benutzer eine Funktion davon ausschließen möchte, von den Modellen für AP- oder AT-Aktivitäten verwendet zu werden, kann er die Modelle-API verwenden, um diese Funktion der "Blockierungsliste"-Seite hinzuzufügen.
Ein blocklist definiert den Satz von Funktionen, die von Adobe Target aus seinen Modellen für maschinelles Lernen ausgeschlossen werden. Weitere Informationen zu Funktionen finden Sie unter Von Target Algorithmen für maschinelles Lernen verwendete Daten.
Blockierungslisten können pro Aktivität (Aktivitätsebene) oder für alle Aktivitäten innerhalb eines Target -Kontos (globale Ebene) definiert werden.
API-Spezifikation für Modelle
Sehen Sie sich die API-Spezifikation für Modelle hier an.
Voraussetzungen
Um die Modelle-API zu verwenden, müssen Sie die Authentifizierung mit Adobe Developer Console konfigurieren, genau wie mit der Target Admin-API. Weitere Informationen finden Sie unter Konfigurieren der Authentifizierung.
Richtlinien zur API-Nutzung von Modellen
Verwalten von Blockierungslisten
Schritt 1: Liste der Funktionen für eine Aktivität anzeigen
Schritt 2: Überprüfen Sie die Blockierungsliste der Aktivität
Schritt 3: Fügen Sie der Blockierungsliste der Aktivität Funktionen hinzu.
Schritt 4: (Optional) Block aufheben
Schritt 5: (Optional) Globale Blockierungsliste verwalten
Schritt 1: Liste der Funktionen einer Aktivität anzeigen step1
Bevor Sie eine Funktion auf die Blockierungsliste gesetzt haben, sollten Sie sich die Liste der Funktionen ansehen, die derzeit in den Modellen für diese Aktivität enthalten sind.
code language-json line-numbers |
---|
|
code language-json line-numbers |
---|
|
In dem hier gezeigten Beispiel prüft der Benutzer, ob die Liste der Funktionen angezeigt wird, die im Modell für die Aktivität verwendet werden, deren Aktivitäts-ID 260840 lautet.
Der externalName ist ein benutzerfreundlicher Name für eine Funktion. Sie wird von Target erstellt und es ist möglich, dass sich dieser Wert im Laufe der Zeit ändert. Benutzer können diese benutzerfreundlichen Namen im Personalization Insights-Bericht anzeigen.
Die internalName ist die tatsächliche Kennung der Funktion. Er wird auch von Target erstellt, kann jedoch nicht geändert werden. Dies ist der Wert, den Sie referenzieren müssen, um die Funktion(en) zu identifizieren, die Sie Blockierungslisten vornehmen möchten.
Beachten Sie, dass eine Aktivität, damit die Funktionsliste mit Werten aufgefüllt werden kann (d. h. damit sie nicht null ist):
- Muss Status = Live haben oder zuvor aktiviert worden sein
- Muss lange genug ausgeführt worden sein, damit eine Kampagnenaktivität vorhanden ist, damit das Modell über Daten verfügt, die ausgeführt werden können.
Schritt 2: Überprüfen der Blockierungsliste der Aktivität step2
Zeigen Sie als Nächstes die Blockierungsliste an. Überprüfen Sie also, welche Funktionen (sofern vorhanden) derzeit von der Einbeziehung in die Modelle für diese Aktivität ausgeschlossen sind.
/blockList/
in der Anfrage zwischen Groß- und Kleinschreibung unterschieden wird.code language-json line-numbers |
---|
|
code language-json line-numbers |
---|
|
In dem hier gezeigten Beispiel prüft der Benutzer die Liste der gesperrten Funktionen für die Aktivität, deren Aktivitäts-ID 260840 lautet. Die Ergebnisse sind leer, was bedeutet, dass diese Aktivität derzeit keine auf die Blockierungsliste gesetzt Funktionen aufweist.
Schritt 3: Hinzufügen von Funktionen zur Blockierungsliste ""der Aktivität step3
Um der Blockierungsliste Funktionen hinzuzufügen, ändern Sie die Anforderung von GET in PUT und ändern Sie den Text der Anforderung, um die blockedFeatureSources
oder blockedFeatures
anzugeben.
- Der Hauptteil der Anfrage erfordert entweder
blockedFeatures
oderblockedFeatureSources
. Beide können einbezogen werden. - Füllen Sie
blockedFeatures
mit Werten, die ausinternalName
identifiziert werden. Siehe Schritt 1. - Füllen Sie
blockedFeatureSources
mit Werten aus der unten stehenden Tabelle.
Beachten Sie, dass blockedFeatureSources
angibt, woher eine Funktion stammt. Zum Zwecke der auf die Blockierungsliste setz dienen sie als Gruppen oder Funktionskategorien, mit denen Benutzer ganze Funktionssätze gleichzeitig blockieren können. Die Werte von blockedFeatureSources
stimmen mit den ersten Zeichen der Kennung einer Funktion (blockedFeatures
- oder internalName
-Werte) überein. Daher können sie auch als "Feature-Präfixe"betrachtet werden.
Tabelle der Werte für blockedFeatureSources
table
code language-json line-numbers |
---|
|
code language-json line-numbers |
---|
|
In dem hier gezeigten Beispiel blockiert der Benutzer zwei Funktionen, SES_PREVIOUS_VISIT_COUNT
und SES_TOTAL_SESSIONS
, die er zuvor durch Abfrage der vollständigen Liste der Funktionen für die Aktivität mit der Aktivitäts-ID 260480 identifiziert hatte, wie in Schritt 1 beschrieben. Sie blockieren auch alle Funktionen, die von Experience Cloud-Segmenten stammen. Dies wird erreicht, indem Funktionen mit dem Präfix "AAM"blockiert werden, wie in der obigen Tabelle beschrieben.
Beachten Sie, dass es nach der Blockierungsauflistung einer Funktion empfohlen wird, die aktualisierte Blockierungsliste zu überprüfen, indem Sie erneut Schritt 2} ausführen (GET der Blockierungsliste).Überprüfen Sie, ob die Ergebnisse erwartungsgemäß angezeigt werden (überprüfen Sie, ob die Ergebnisse die Funktionen enthalten, die von der neuesten PUT-Anfrage hinzugefügt wurden).
Schritt 4: (Optional) Block aufheben step4
Um alle auf die Blockierungsliste gesetzt Funktionen zu entsperren, löschen Sie die Werte von blockedFeatureSources
oder blockedFeatures
.
code language-json line-numbers |
---|
|
code language-json line-numbers |
---|
|
In dem hier gezeigten Beispiel leert der Benutzer seine Blockierungsliste für die Aktivität, deren Aktivitäts-ID 260840 lautet. Beachten Sie, dass die Antwort leere Arrays sowohl für blockierte Funktionen als auch für ihre Quellen (0 und 1) bestätigt.blockedFeatureSources
blockedFeatures
Wie immer sollten Sie nach dem Ändern der Blockierungsliste Schritt 2 erneut durchführen (GET umfasst Funktionen wie erwartet). In dem hier gezeigten Beispiel prüft der Benutzer, ob seine Blockierungsliste jetzt leer ist.
Frage: Wie kann ich einige, aber nicht alle Blockierungslisten löschen?
Antwort: Um eine separate Untergruppe auf die Blockierungsliste gesetzt Funktionen aus einer Multi-Feature-Blockierungsliste zu entfernen, können Benutzer einfach die aktualisierte Liste der Funktionen senden, die sie in der Blockanfrage hinzufügen möchten, anstatt die gesamte Blockierungsliste zu löschen und die gewünschten Funktionen erneut hinzuzufügen. Senden Sie also die aktualisierte Funktionsliste (wie in Schritt 3.1 gezeigt) und schließen Sie dabei die Funktionen aus, die Sie aus der Blockierungsliste "löschen"möchten.🔗
Schritt 5: (Optional) Globale Blockierungsliste verwalten step5
Die obigen Beispiele befanden sich alle im Kontext einer einzelnen Aktivität. Sie können Funktionen auch für alle Aktivitäten eines bestimmten Clients (Mandanten) blockieren, anstatt die Blockierungsliste für jede Aktivität einzeln angeben zu müssen. Um eine globale Blockierungsliste durchzuführen, verwenden Sie den Aufruf /blockList/global
anstelle von blockList/<campaignId>
.
code language-json line-numbers |
---|
|
code language-json line-numbers |
---|
|
In der oben gezeigten Beispielanfrage blockiert der Benutzer zwei Funktionen, "AAM_FEATURE_1"und "AAM_FEATURE_2", für alle Aktivitäten in seinem Target-Konto. Das bedeutet, dass "AAM_FEATURE_1"und "AAM_FEATURE_2"unabhängig von der Aktivität nicht in die Modelle für maschinelles Lernen für dieses Konto aufgenommen werden. Darüber hinaus blockiert der Benutzer global alle Funktionen, deren Präfix "AAM", "PRO"oder "ENV"lautet.
Frage: Ist das obige Codebeispiel nicht redundant?
Antwort: Ja. Es ist überflüssig, Funktionen mit Werten zu blockieren, die mit "AAM"beginnen, und gleichzeitig alle Funktionen zu blockieren, deren Quelle "AAM"lautet. Das Ergebnis ist, dass alle von AAM (Experience Cloud-Segmenten) bezogenen Funktionen blockiert werden. Wenn das Ziel darin besteht, alle Funktionen von Experience Cloud-Segmenten zu blockieren, ist es daher nicht erforderlich, bestimmte Funktionen, die mit "AAM"beginnen, einzeln anzugeben, wie im obigen Beispiel gezeigt.
Endlicher Schritt: Es wird empfohlen, die Blockierungsliste nach der Änderung auf Aktivitäts- oder globaler Ebene zu überprüfen, um sicherzustellen, dass sie die erwarteten Werte enthält. Ändern Sie dazu die PUT
in eine GET
.
Die unten dargestellte Beispielantwort weist darauf hin, dass Target zwei einzelne Funktionen sowie alle von "AAM", "PRO"und "ENV"bezogenen Funktionen blockiert.