Übersicht über die Models-API

Die Models-API, auch als Blockierungsliste-API bezeichnet, ermöglicht es Benutzenden, die Liste der Funktionen anzuzeigen und zu verwalten, die in Modellen für maschinelles Lernen für Automated Personalization (AP)- und Auto-Target (AT)-Aktivitäten verwendet werden. Wenn ein(e) Benutzende® eine Funktion von der Verwendung durch die Modelle für AP- oder AT-Aktivitäten ausschließen möchte, kann er/sie die Models-API verwenden, um diese Funktion der "Blockierungsliste" hinzuzufügen.

Ein blocklist definiert die Reihe von Funktionen, die von Adobe Target aus seinen Modellen für maschinelles Lernen ausgeschlossen werden. Weitere Informationen zu Funktionen finden Sie unter Von Algorithmen für Target 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.

Models-API-Spezifikation

Die Models-API-Spezifikation hier.

Voraussetzungen

Um die Models-API zu verwenden, müssen Sie die Authentifizierung mithilfe der Adobe Developer Console konfigurieren, genau wie bei der Target Admin-API. Weitere Informationen finden Sie unter Konfigurieren der Authentifizierung.

Richtlinien zur Verwendung der Models-API

Verwalten von Blockierungslisten

Schritt 1: Liste der Funktionen für eine Aktivität anzeigen

auf die Blockierungsliste setzen Schritt 2: der Aktivität prüfen

Schritt 3: Funktionen zur Blockierungsliste der Aktivität hinzufügen

Schritt 4: (Optional) Entsperren

Schritt 5: (Optional) Verwalten der globalen Blockierungsliste

Schritt 1: Anzeigen einer Liste der Funktionen einer Aktivität step1

Auf die Blockierungsliste setzen Bevor Sie eine Funktion bearbeiten, zeigen Sie die Liste der Funktionen an, die derzeit in den Modellen für diese Aktivität enthalten sind.

GET https://mc.adobe.io/<tenant>/target/models/features/<campaignId>

{
    "features": [
        {
            "externalName": "Visitor Profile - Total Visits to Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Total Visits",
            "internalName": "SES_TOTAL_SESSIONS",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Pages Seen Before Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Activity Lifetime Time on Site",
            "internalName": "SES_TOTAL_TIME",
            "type": "CONTINUOUS"
        }
    ],
    "reportParameters": {
        "clientCode": <tenant>,
        "campaignId": <campaignId>
    }
}

In dem hier gezeigten Beispiel prüft der Benutzer, ob die Liste der Funktionen vorhanden ist, die im Modell für die Aktivität verwendet werden, deren Aktivitäts-ID 260840 ist.

Der externalName ist ein benutzerfreundlicher Name für eine Funktion. Er 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. Es wird auch von Target erstellt, kann jedoch nicht geändert werden. Auf die Blockierungsliste setzen Dies ist der Wert, auf den Sie verweisen müssen, um die Funktion(en) zu identifizieren, die Sie ändern möchten.

Damit die Funktionsliste mit Werten gefüllt werden kann (d. h. damit sie nicht null ist), muss eine Aktivität sein:

Schritt 2: Überprüfen Sie die Blockierungsliste der Aktivität step2

Zeigen Sie als Nächstes die Blockierungsliste an. Mit anderen Worten: Überprüfen Sie, welche Funktionen (sofern vorhanden) derzeit von der Aufnahme in die Modelle für diese Aktivität blockiert sind.

GET https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

In dem hier gezeigten Beispiel prüft der Benutzer die Liste der blockierten Funktionen für die Aktivität, deren Aktivitäts-ID 260840 ist. Die Ergebnisse sind leer, was bedeutet, dass diese Aktivität derzeit keine auf die Blockierungsliste gesetzt Funktionen aufweist.

Schritt 3: Funktionen zur Blockierungsliste der Aktivität hinzufügen step3

Um der Blockierungsliste Funktionen hinzuzufügen, ändern Sie die Anfrage von GET auf PUT und ändern Sie den Textkörper der Anfrage, um die blockedFeatureSources oder blockedFeatures nach Bedarf anzugeben.

Beachten Sie, dass blockedFeatureSources angibt, woher eine Funktion kam. Zur Blockierungsauflistung dienen sie als Gruppen oder Kategorien von Funktionen, mit denen Benutzende ganze Funktionssätze gleichzeitig blockieren können. Die Werte von blockedFeatureSources stimmen mit den ersten Zeichen der Kennung eines KE (blockedFeatures oder internalName Werte) überein; daher können sie auch als „Feature-Präfixe“ betrachtet werden.

Tabelle der blockedFeatureSources Werte table

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": ["AAM"],
    "blockedFeatures": ["SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS"]
}

{
    "blockedFeatures": [
            "SES_PREVIOUS_VISIT_COUNT",
            "SES_TOTAL_SESSIONS"
        ],
    "blockedFeatureSources": [
            "AAM"
        ]
}

In dem hier gezeigten Beispiel blockiert der Benutzer zwei Funktionen, SES_PREVIOUS_VISIT_COUNT und SES_TOTAL_SESSIONS, die er zuvor identifiziert hat, indem er die vollständige Liste der Funktionen für die Aktivität abgefragt hat, deren Aktivitäts-ID 260480 ist, wie in Schritt 1 beschrieben. Sie blockieren auch alle Funktionen, die von Experience Cloud-Segmenten stammen, was durch die Blockierung von Funktionen mit dem Präfix "AAM" erreicht wird, wie in der Tabelle oben beschrieben.

Beachten Sie, dass Sie nach der Blockierungsauflistung auf die Blockierungsliste setzte einer Funktion die aktualisierte Datei überprüfen sollten, indem Sie Schritt 2 erneut ausführen (GET auf die Blockierungsliste setzte). Überprüfen Sie, ob die Ergebnisse erwartungsgemäß angezeigt werden (stellen Sie sicher, dass die Ergebnisse die Funktionen enthalten, die mit der neuesten PUT-Anfrage hinzugefügt wurden).

Schritt 4: (Optional) Entsperren step4

Auf die Blockierungsliste setzen Um die Blockierung aller Funktionen aufzuheben, löschen Sie die Werte aus blockedFeatureSources oder blockedFeatures.

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": [],
    "blockedFeatures": []
}

{
    "blockedFeatures": [],
    "blockedFeatureSources": []
}

Im hier gezeigten Beispiel löscht der Benutzer seine Blockierungsliste für die Aktivität, deren Aktivitäts-ID 260840 ist. Beachten Sie, dass die Antwort leere Arrays für blockierte Funktionen und ihre Quellen - blockedFeatureSources bzw. blockedFeatures - bestätigt.

Wie immer wird nach der Änderung der Blockierungsliste empfohlen, Schritt 2 erneut auszuführen (die GET auf die Blockierungsliste setzte zur Überprüfung der Liste enthält Funktionen wie erwartet). In dem hier gezeigten Beispiel verifiziert der Benutzer, dass seine -Blockierungsliste jetzt leer ist.

Frage: Wie kann ich einige, aber nicht alle einer Blockierungsliste löschen?

Antwort: Um eine einzelne Teilmenge auf die Blockierungsliste gesetzt Funktionen aus einer Multi-Feature-Blockierungsliste auf die Blockierungsliste setzen auf die Blockierungsliste setzte zu entfernen, können Benutzende einfach die aktualisierte Liste der Funktionen senden, die sie in der -Funktionsanfrage blockieren möchten, anstatt die gesamte -Datei zu löschen und die gewünschten Funktionen erneut hinzuzufügen. Mit anderen Worten, senden Sie die aktualisierte Funktionsliste (wie in Schritt 3) und stellen Sie sicher, dass Sie die Funktionen, die Sie „löschen“ möchten, aus der Blockierungsliste ausschließen.

Schritt 5: (Optional) Verwalten der globalen Blockierungsliste step5

Die obigen Beispiele bezogen sich alle auf eine einzige Aktivität. Sie können auch Funktionen für alle Aktivitäten auf einem bestimmten Client (Mandanten) blockieren, anstatt die Blockierungsliste für jede Aktivität einzeln angeben zu müssen. Auf die Blockierungsliste setzen Um eine globale durchzuführen, verwenden Sie den /blockList/global-Aufruf anstelle von blockList/<campaignId>.

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/global

{
    "blockedFeatureSources": ["AAM", "PRO", "ENV"],
    "blockedFeatures": ["AAM_FEATURE_1", "AAM_FEATURE_2"]
}

{
    "blockedFeatures": [
        "AAM_FEATURE_1",
        "AAM_FEATURE_2"
    ],
    "blockedFeatureSources": [
        "AAM",
        "PRO",
        "ENV"
    ]
}

In der obigen Beispielanfrage blockiert der Benutzer zwei Funktionen, "AAM_FEATURE_1“ und "AAM_FEATURE_2“, für alle Aktivitäten in seinem Target. 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 Code-Beispiel nicht redundant?

Antwort: Ja. Es ist redundant, Funktionen zu blockieren, deren Werte mit "AAM" beginnen, während gleichzeitig alle Funktionen blockiert werden, deren Quelle "AAM" ist. Das Ergebnis ist, dass alle Funktionen, die von AAM (Experience Cloud-Segmenten) bezogen werden, blockiert werden. Wenn das Ziel also darin besteht, alle Funktionen aus Experience Cloud-Segmenten zu blockieren, ist es im obigen Beispiel nicht erforderlich, bestimmte Funktionen einzeln anzugeben, die mit "AAM" beginnen.

Letzter Schritt: Unabhängig davon, ob auf Aktivitäts- oder globaler Ebene, wird empfohlen, dass Sie Ihre Blockierungsliste nach der Änderung überprüfen, um sicherzustellen, dass sie die erwarteten Werte enthält. Ändern Sie dazu die PUT in eine GET.

Die folgende Beispielantwort zeigt, Target zwei einzelne Funktionen blockiert, sowie alle Funktionen, die von "AAM", „PRO“ und „ENV“ bezogen werden.