Documentation Guide du développeur de Target

Présentation de l’API de modèles

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

Développeur

L’API Modèles, également appelée API de Liste bloquée, permet aux utilisateurs d’afficher et de gérer la liste des fonctionnalités utilisées dans les modèles d’apprentissage automatique pour les activités Automated Personalization (AP) et Auto-Target (AT). Si un utilisateur souhaite exclure une fonctionnalité des modèles utilisés pour les activités AP ou AT, il peut utiliser l’API Modèles pour ajouter cette fonctionnalité à la "liste bloquée".

Un blocklist définit l’ensemble des fonctionnalités qui seront exclues par Adobe Target de ses modèles d’apprentissage automatique. Pour plus d’informations sur les fonctionnalités, voir Données utilisées par Target les algorithmes d’apprentissage automatique.

Les Listes bloquées peuvent être définies par activité (niveau activité) ou pour toutes les activités au sein d’un compte Target (niveau global).

Spécification de l’API de modèles

Affichez la spécification de l’API Modèles ici.

Conditions préalables

Pour utiliser l’API Modèles, vous devez configurer l’authentification à l’aide de Adobe Developer Console, comme vous le feriez avec l’ API d’administration Target. Pour plus d’informations, voir Configuration de l’authentification.

Directives d’utilisation de l’API de modèles

Gestion des listes bloquées

Étape 1 : Afficher la liste des fonctionnalités d’une activité

Étape 2 : Vérifiez la liste bloquée de l’activité.

Étape 3 : Ajouter des fonctionnalités à la liste bloquée de l’activité

Étape 4 : (Facultatif) Débloquer

Étape 5 : (Facultatif) Gestion de la liste bloquée globale

Étape 1 : afficher la liste des fonctionnalités d’une activité step1

Avant de placer sur la liste bloquée une fonctionnalité, consultez la liste des fonctionnalités actuellement incluses dans les modèles de cette activité.

Demande

code language-json line-numbers
`GET https://mc.adobe.io/<tenant>/target/models/features/<campaignId>`

Réponse

code language-json line-numbers

code language-json line-numbers
{ "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> } }

{
    "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>
    }
}

Dans l’exemple illustré ici, l’utilisateur vérifie la liste des fonctionnalités utilisées dans le modèle pour l’activité dont l’ID d’activité est 260840.

Étape 1

NOTE

Pour trouver l’ID d’activité de votre activité, accédez à la Liste des activités dans l’interface utilisateur de Target. Cliquez sur l’activité qui vous intéresse. L’ID d’activité s’affiche dans le corps de la page d’aperçu des activités qui en résulte, ainsi qu’à la fin de l’URL de cette page.

externalName est un nom convivial pour une fonctionnalité. Il est créé par Target et il est possible que cette valeur change au fil du temps. Les utilisateurs peuvent afficher ces noms conviviaux dans le rapport Personalization Insights.

internalName est l’identifiant réel de la fonctionnalité. Il est également créé par Target, mais il ne peut pas être modifié. Il s’agit de la valeur à référencer pour identifier la ou les fonctionnalités que vous souhaitez placer sur la liste bloquée.

Notez que pour que la liste de fonctionnalités soit renseignée avec des valeurs (c’est-à-dire, pour qu’elle ne soit pas nulle), une activité :

Posséder le statut = En direct ou avoir été activé précédemment
L’exécution doit avoir été suffisamment longue pour qu’il y ait une activité de campagne, de sorte que le modèle comporte des données à exécuter.

Etape 2 : Vérifier la liste bloquée de l'activité step2

Affichez ensuite la liste bloquée. En d’autres termes, vérifiez quelles fonctionnalités, le cas échéant, sont actuellement bloquées pour être incluses dans les modèles de cette activité.

ERROR

Notez que /blockList/ est sensible à la casse dans la requête.

Demande

code language-json line-numbers
`GET https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>`

Réponse

code language-json line-numbers

Dans l’exemple illustré ici, l’utilisateur vérifie la liste des fonctionnalités bloquées pour l’activité dont l’ID d’activité est 260840. Les résultats sont vides, ce qui signifie que cette activité ne comporte actuellement aucune fonctionnalité placée sur la liste bloquée.

Étape 2

NOTE

Vous pouvez voir des résultats vides comme celui-ci, la première fois que vous vérifiez la liste bloquée complète, avant d’y ajouter des fonctionnalités. Cependant, une fois que vous avez ajouté (et par la suite supprimé) des fonctionnalités d’une liste bloquée, vous pouvez voir des résultats légèrement différents, dans lesquels un tableau de fonctionnalités placées sur la liste bloquée vide est renvoyé. Poursuivez la lecture pour voir un exemple de cela dans Étape 4.

Étape 3 : Ajout de fonctionnalités à la liste bloquée de l’activité step3

Pour ajouter des fonctionnalités à la liste bloquée, remplacez la requête de GET en PUT, puis modifiez le corps de la requête pour spécifier les blockedFeatureSources ou blockedFeatures selon vos besoins.

Le corps de la requête nécessite blockedFeatures ou blockedFeatureSources. Les deux peuvent être inclus.
Renseignez blockedFeatures avec les valeurs identifiées de internalName. Voir Étape 1.
Renseignez blockedFeatureSources avec les valeurs du tableau ci-dessous.

Notez que blockedFeatureSources indique d’où provient une fonctionnalité. Pour placer sur la liste bloquée, ils servent de groupes ou de catégories de fonctionnalités, ce qui permet aux utilisateurs de bloquer simultanément des ensembles complets de fonctionnalités. Les valeurs de blockedFeatureSources correspondent aux premiers caractères de l’identifiant d’une fonctionnalité (blockedFeatures ou internalName valeurs) ; elles peuvent donc être également considérées comme des "préfixes de fonctionnalités".

Table des valeurs `blockedFeatureSources` table

Préfixe

Description

BOX

Paramètre de mbox

URL

Personnalisé - Paramètre d’URL

ENV

Environnement

SES

Profil du visiteur

GEO

Emplacement géographique

PRO

Personnalisé - Profil

SEG

Personnalisé - Segment de création de rapports

AAM

Personnalisé - Segment Experience Cloud

MOB

Mobile

CRS

Personnalisé - Attributs du client

UPA

Personnalisé - Attribut de profil RT-CDP

IAC

Centres d’intérêt du visiteur

Demande

code language-json line-numbers
`PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId> { "blockedFeatureSources": ["AAM"], "blockedFeatures": ["SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS"] }`

Réponse

code language-json line-numbers
`{ "blockedFeatures": [ "SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS" ], "blockedFeatureSources": [ "AAM" ] }`

Dans l’exemple illustré ici, l’utilisateur bloque deux fonctionnalités, SES_PREVIOUS_VISIT_COUNT et SES_TOTAL_SESSIONS, qu’il a précédemment identifiées en interrogeant la liste complète des fonctionnalités pour l’activité dont l’ID d’activité est 260480, comme décrit à l’ étape 1. Ils bloquent également toutes les fonctionnalités provenant des segments Experience Cloud, ce qui se fait en bloquant les fonctionnalités avec le préfixe "AAM", comme décrit dans la table ci-dessus.

Étape 3

Notez qu’après avoir placé sur la liste bloquée une fonction, il est recommandé de vérifier la liste bloquée mise à jour en réexécutant Étape 2 (GET de la liste bloquée). Vérifiez que les résultats s’affichent comme prévu (vérifiez que les résultats incluent les fonctionnalités ajoutées à partir de la dernière requête de PUT).

Étape 4 : (facultative) Débloquer step4

Pour débloquer toutes les fonctionnalités placées sur la liste bloquée, effacez les valeurs de blockedFeatureSources ou blockedFeatures.

Demande

code language-json line-numbers
`PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId> { "blockedFeatureSources": [], "blockedFeatures": [] }`

Réponse

code language-json line-numbers
`{ "blockedFeatures": [], "blockedFeatureSources": [] }`

Dans l’exemple illustré ici, l’utilisateur efface sa liste bloquée pour l’activité dont l’ID d’activité est 260840. Notez que la réponse confirme les tableaux vides pour les fonctionnalités bloquées et leurs sources : blockedFeatureSources et blockedFeatures, respectivement.

Étape 4

Comme toujours, après avoir modifié la liste bloquée, il est recommandé d’effectuer à nouveau l’ Étape 2 (GET de la liste bloquée pour vérifier que la liste inclut des fonctionnalités comme prévu). Dans l’exemple illustré ici, l’utilisateur vérifie que sa liste bloquée est désormais vide.

Étape 4b

Question : Comment puis-je supprimer une partie, mais pas toutes, d’une liste bloquée ?

Réponse : pour supprimer un sous-ensemble distinct de fonctionnalités placées sur la liste bloquée d’une liste bloquée multifonction, les utilisateurs peuvent simplement envoyer la liste mise à jour des fonctionnalités qu’ils souhaitent bloquer dans la demande de liste bloquée, plutôt que d’effacer la liste bloquée entière et de rajouter les fonctionnalités souhaitées. En d’autres termes, envoyez la liste des fonctionnalités mise à jour (comme indiqué à l’ étape 3), en veillant à exclure de la liste bloquée les fonctionnalités que vous souhaitez "supprimer".

Étape 5 : (facultative) Gestion de la liste bloquée globale step5

Les exemples ci-dessus étaient tous dans le contexte d’une seule activité. Vous pouvez également bloquer des fonctionnalités pour toutes les activités sur un client donné (client), au lieu d’avoir à spécifier la liste bloquée de chaque activité individuellement. Pour effectuer une liste bloquée globale, utilisez l’appel /blockList/global au lieu de blockList/<campaignId>.

Demande

code language-json line-numbers
`PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/global { "blockedFeatureSources": ["AAM", "PRO", "ENV"], "blockedFeatures": ["AAM_FEATURE_1", "AAM_FEATURE_2"] }`

Réponse

code language-json line-numbers
`{ "blockedFeatures": [ "AAM_FEATURE_1", "AAM_FEATURE_2" ], "blockedFeatureSources": [ "AAM", "PRO", "ENV" ] }`

Dans l’exemple de requête illustré ci-dessus, l’utilisateur bloque deux fonctionnalités, "AAM_FEATURE_1" et "AAM_FEATURE_2", pour toutes les activités de son compte Target. Cela signifie que, quelle que soit l’activité, "AAM_FEATURE_1" et "AAM_FEATURE_2" ne seront pas inclus dans les modèles d’apprentissage automatique pour ce compte. En outre, l’utilisateur bloque également globalement toutes les fonctionnalités dont le préfixe est "AAM", "PRO" ou "ENV".

Question : L’exemple de code ci-dessus n’est-il pas redondant ?

Réponse : Oui. Il est redondant de bloquer les fonctionnalités avec des valeurs commençant par "AAM", tout en bloquant également toutes les fonctionnalités dont la source est "AAM". Par conséquent, toutes les fonctionnalités provenant d’AAM (segments Experience Cloud) seront bloquées. Par conséquent, si l’objectif est de bloquer toutes les fonctionnalités des segments Experience Cloud, la spécification individuelle de certaines fonctionnalités commençant par "AAM" n’est pas nécessaire, dans l’exemple ci-dessus.

Étape finale : que ce soit au niveau de l’activité ou global, il est recommandé de vérifier votre liste bloquée après l’avoir modifiée, afin de vous assurer qu’elle contient les valeurs attendues. Pour ce faire, remplacez PUT par GET.

L’exemple de réponse illustré ci-dessous indique que Target bloque deux fonctionnalités individuelles, plus toutes provenant de "AAM", "PRO" et "ENV".

Étape 5