Información general de API de modelos

La API de modelos, también denominada API de Lista de bloqueados, permite a los usuarios ver y administrar la lista de características utilizadas en los modelos de aprendizaje automático para las actividades Automated Personalization (AP) y Auto-Target (AT). Si un usuario desea excluir una función de la utilización por parte de los modelos para actividades AP o AT, puede utilizar la API de modelos para añadir esa función a la "lista de bloqueados".

Un(a) blocklist define el conjunto de características que Adobe Target excluirá de sus modelos de aprendizaje automático. Para obtener más información sobre las características, consulte Datos utilizados por Target algoritmos de aprendizaje automático.

Las listas de bloqueados se pueden definir por actividad (nivel de actividad) o para todas las actividades de una cuenta de Target (nivel global).

Especificación de API de modelos

Vea la especificación de API de modelos aquí.

Requisitos previos

Para usar la API de modelos, debe configurar la autenticación mediante Adobe Developer Console, tal como lo haría con Target Admin API. Para obtener más información, consulte Cómo configurar la autenticación.

Directrices de uso de API de modelos

Administración de listas de bloqueados

Paso 1: Ver la lista de características de una actividad

Paso 2: Compruebe la lista de bloqueados de la actividad

Paso 3: Agregar características a la lista de bloqueados de la actividad

Paso 4: (Opcional) Desbloquear

Paso 5: (opcional) Administrar la lista de bloqueados global

Paso 1: Ver la lista de funciones de una actividad step1

Antes de realizar la inclusión en la lista de bloqueados de una función, consulte la lista de funciones que se están incluyendo actualmente en los modelos de para esa actividad.

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

En el ejemplo que se muestra a continuación, el usuario comprueba la lista de funciones que se utilizan en el modelo para la actividad cuyo ID de actividad es 260840.

externalName es un nombre descriptivo para una característica. Lo crea Target y es posible que este valor cambie con el tiempo. Los usuarios pueden ver estos nombres descriptivos en el informe de perspectivas de Personalization.

internalName es el identificador real de la característica. También lo creó Target, pero no se puede cambiar. Este es el valor al que deberá hacer referencia para identificar las funciones a las que desea hacer lista de bloqueados.

Tenga en cuenta que para que la lista de funciones se rellene con valores (es decir, para que no sea nula), una actividad de:

Paso 2: Compruebe la lista de bloqueados de la actividad step2

A continuación, vea la lista de bloqueados. En otras palabras, compruebe qué funciones, si las hay, se están bloqueando actualmente para que no se incluyan en los modelos de esta actividad.

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

En el ejemplo que se muestra a continuación, el usuario está comprobando la lista de funciones bloqueadas de la actividad cuyo ID de actividad está 260840. Los resultados están vacíos, lo que significa que esta actividad no tiene actualmente ninguna función incluida en la lista de bloqueados.

Paso 3: Añadir funciones a la lista de bloqueados de la actividad step3

Para agregar características a la lista de bloqueados, cambie la solicitud de GET a PUT y modifique el cuerpo de la solicitud para especificar blockedFeatureSources o blockedFeatures como desee.

Tenga en cuenta que blockedFeatureSources indica de dónde proviene una característica. A efectos de inclusión en la lista de bloqueados, sirven como grupos o categorías de funciones, que permiten a los usuarios bloquear conjuntos completos de funciones a la vez. Los valores de blockedFeatureSources coinciden con los primeros caracteres del identificador de una característica (blockedFeatures o internalName valores); por lo tanto, también pueden considerarse "prefijos de característica".

Tabla de blockedFeatureSources valores 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"
        ]
}

En el ejemplo que se muestra aquí, el usuario está bloqueando dos características, SES_PREVIOUS_VISIT_COUNT y SES_TOTAL_SESSIONS, que identificó previamente consultando la lista completa de características de la actividad cuyo ID de actividad es 260480, tal como se describe en Paso 1. También están bloqueando todas las características que provienen de los segmentos del Experience Cloud AAM, lo cual se logra bloqueando características con el prefijo "", tal como se describe en la tabla anterior.

Tenga en cuenta que después de la inclusión en la lista de bloqueados de una característica, se recomienda que compruebe la lista de bloqueados actualizada realizando de nuevo el Paso 2 (GET de la lista de bloqueados). Compruebe que los resultados aparecen según lo esperado (compruebe que los resultados incluyen las funciones agregadas desde la última solicitud de PUT).

Paso 4: (Opcional) Desbloquear step4

Para desbloquear todas las características incluidas en la lista de bloqueados, borre los valores de blockedFeatureSources o blockedFeatures.

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

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

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

En el ejemplo que se muestra a continuación, el usuario está borrando su lista de bloqueados de la actividad cuyo ID de actividad está 260840. Tenga en cuenta que la respuesta confirma matrices vacías para las características bloqueadas y sus orígenes: blockedFeatureSources y blockedFeatures, respectivamente.

Como siempre, después de modificar la lista de bloqueados, se recomienda que vuelva a realizar el Paso 2 (la GET lista de bloqueados para comprobar que la lista incluye las características esperadas). En el ejemplo que se muestra aquí, el usuario comprueba que su lista de bloqueados está vacía.

Pregunta: ¿Cómo puedo eliminar algunas listas de bloqueados, pero no todas?

Respuesta: Para quitar un subconjunto discreto de características incluidas en la lista de bloqueados de una lista de bloqueados de varias características, los usuarios simplemente pueden enviar la lista actualizada de características que desean bloquear en la solicitud de lista de bloqueados, en lugar de borrar toda la lista de bloqueados y volver a agregar las características deseadas. En otras palabras, envíe la lista de características actualizada (como se muestra en el Paso 3), asegurándose de excluir las características que desee "eliminar" de la lista de bloqueados.

Paso 5: (Opcional) Administrar la lista de bloqueados global step5

Los ejemplos anteriores se encontraban en el contexto de una sola actividad. También puede bloquear funciones para todas las actividades en un cliente determinado (inquilino), en lugar de tener que especificar la lista de bloqueados de cada actividad individualmente. Para realizar una lista de bloqueados global, use la llamada de /blockList/global en lugar de 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"
    ]
}

AAM AAM En la solicitud de ejemplo que se muestra arriba, el usuario está bloqueando dos características, "_FEATURE_1" y "_FEATURE_2", para todas las actividades de su cuenta de Target. AAM AAM Esto significa que, independientemente de la actividad, "_FEATURE_1" y "_FEATURE_2" no se incluirán en los modelos de aprendizaje automático de esta cuenta. AAM Además, el usuario también está bloqueando globalmente todas las funciones cuyo prefijo sea "", "PRO" o "ENV".

Pregunta: ¿No es redundante el ejemplo de código anterior?

Respuesta: Sí. AAM AAM Es redundante bloquear funciones con valores que comienzan por "", a la vez que bloquea todas las funciones cuyo origen sea "". AAM El siguiente resultado es que todas las funciones originadas en los segmentos de Experience Cloud (segmentos de) se bloquearán. Por lo tanto, si el objetivo es bloquear todas las funciones de los segmentos de Experience Cloud AAM, no es necesario especificar individualmente determinadas funciones que comienzan con "", como en el ejemplo anterior.

Paso final: Ya sea a nivel de actividad o a nivel global, se recomienda comprobar la lista de bloqueados después de modificarla para asegurarse de que contiene los valores esperados. Para ello, cambie PUT por GET.

AAM La respuesta de ejemplo que se muestra a continuación indica que Target está bloqueando dos características individuales, además de todas las características originadas en "", "PRO" y "ENV".