Visão geral da API de modelos

A API de modelos do, também chamada de API de Inclui na lista de bloqueios do, permite que os usuários visualizem e gerenciem a lista de recursos usados em modelos de aprendizado de máquina do Automated Personalization (AP) e Auto-Target (AT) atividades. Se um usuário quiser excluir um recurso de ser usado pelos modelos para atividades de AP ou AT, ele poderá usar a API de modelos para adicionar esse recurso ao "incluo na lista de bloqueios".

A ➡ incluir na lista de bloqueios define o conjunto de recursos que será excluído pelo Adobe Target de seus modelos de aprendizado de máquina. Para obter mais informações sobre recursos, consulte Dados usados por Target algoritmos de aprendizado de máquina do.

As Listas de bloqueios podem ser definidas por atividade (nível de atividade) ou para todas as atividades em um Target conta (nível global).

Especificação da API de modelos

Exibir a especificação da API de modelos aqui.

Pré-requisitos

Para usar a API de modelos, você deve configurar a autenticação usando a variável Console do Adobe Developer, como faria com o API de administração do Target. Para obter mais informações, consulte Como configurar a autenticação.

Diretrizes de uso da API de modelos

Como gerenciar listas de bloqueios do

Etapa 1: Exibir lista de recursos de uma atividade

Etapa 2: Verifique a inclui na lista de bloqueios da atividade

Etapa 3: Adicionar recursos ao incluo na lista de bloqueios da atividade

Etapa 4: (Opcional) Desbloquear

Etapa 5: incluir na lista de bloqueios (Opcional) Gerenciar a pesquisa global

Etapa 1: Exibir lista de recursos de uma atividade step1

Antes de ➡ incluir na lista de bloqueios um recurso, exiba a lista de recursos que estão sendo incluídos atualmente nos modelos para essa atividade.

Solicitação
code language-json line-numbers
GET https://mc.adobe.io/<tenant>/target/models/features/<campaignId>
Resposta
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>
    }
}

No exemplo mostrado aqui, o usuário está verificando para ver a lista de recursos que estão sendo usados no modelo para a atividade cuja ID da atividade é 260840.

Etapa 1

NOTE
Para localizar a ID de atividade, navegue até a Lista de atividades na Target IU. Clique na atividade de interesse. A ID da atividade será exibida no corpo da página Visão geral das atividades resultante, bem como no final do URL dessa página.

A variável externalName é um nome amigável para um recurso. Ele é criado por Target, e é possível que esse valor mude com o tempo. Os usuários podem exibir esses nomes amigáveis na Relatório de insights de personalização.

A variável internalName é o identificador real do recurso. Ele também é criado por Target, mas não pode ser alterado. Este é o valor que você precisará referenciar para identificar os recursos que gostaria de incluir na lista de bloqueios.

Observe que para que a lista de recursos seja preenchida com valores (ou seja, para que ela seja não nula), uma atividade:

  1. Deve ter o Status = Ativo ou deve ter sido ativado anteriormente
  2. Deve ter sido executado por tempo suficiente para que haja atividade de campanha, para que o modelo tenha dados para serem executados.

Etapa 2: verificar a inclui na lista de bloqueios da atividade step2

Em seguida, visualize a inclui na lista de bloqueios. Em outras palavras, verifique quais recursos, se houver, estão sendo impedidos de serem incluídos nos modelos para esta atividade.

ERROR
Observe que /blockList/ diferencia maiúsculas de minúsculas na solicitação.
Solicitação
code language-json line-numbers
GET https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>
Resposta
code language-json line-numbers

No exemplo mostrado aqui, o usuário está verificando a lista de recursos bloqueados para a atividade cuja ID de atividade é 260840. Incluir na lista de bloqueios Os resultados estão vazios, o que significa que essa atividade não tem nenhum recurso alterado no momento.

Etapa 2

NOTE
Você pode ver resultados vazios como este, na primeira vez que você verificar a inclui na lista de bloqueios completa, antes de adicionar qualquer recurso a ela. No entanto, depois de adicionar (e subsequentemente remover) recursos de um incluir na lista de bloqueios incluo na lista de bloqueios, você pode ver resultados ligeiramente diferentes, nos quais um storage de recursos vazio é retornado. Continue lendo para ver um exemplo disso em Etapa 4.

Etapa 3: adicionar recursos ao incluo na lista de bloqueios da atividade µ step3

Para adicionar recursos ao incluo na lista de bloqueios, altere a solicitação de GET para PUT e modifique o corpo da solicitação para especificar o blockedFeatureSources ou blockedFeatures conforme desejado.

  • O corpo da solicitação requer blockedFeatures ou blockedFeatureSources. Ambos podem ser incluídos.
  • Preencher blockedFeatures com valores identificados de internalName. Consulte Etapa 1.
  • Preencher blockedFeatureSources com valores da tabela abaixo.

Observe que blockedFeatureSources indica de onde um recurso veio. Para fins de incluir na lista de bloqueios, eles servem como grupos ou categorias de recursos, que permitem aos usuários bloquear conjuntos inteiros de recursos de uma só vez. Os valores de blockedFeatureSources corresponder aos primeiros caracteres do identificador de um recurso (blockedFeatures ou internalName ); portanto, também podem ser considerados "prefixos de recursos".

Tabela de blockedFeatureSources valores table

Prefixo
Descrição
CAIXA
Parâmetro da mbox
URL
Personalizado - Parâmetro de URL
ENV
Ambiente
SES
Perfil do visitante
GEO
Localização geográfica
PRO
Personalizado - Perfil
SEG
Personalizado - Segmento de relatórios
AAM
Personalizado - Segmento Experience Cloud
MOB
Dispositivo móvel
CRS
Personalizado - Atributos do cliente
UPA
Personalizado - Atributo de perfil RT-CDP
IAC
Áreas de interesse do visitante
Solicitação
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"]
}
Resposta
code language-json line-numbers
{
    "blockedFeatures": [
            "SES_PREVIOUS_VISIT_COUNT",
            "SES_TOTAL_SESSIONS"
        ],
    "blockedFeatureSources": [
            "AAM"
        ]
}

No exemplo mostrado aqui, o usuário está bloqueando dois recursos, SES_PREVIOUS_VISIT_COUNT e SES_TOTAL_SESSIONS, que eles identificaram anteriormente consultando a lista completa de recursos para a atividade cuja ID de atividade é 260480, conforme descrito em Etapa 1. Eles também estão bloqueando todos os recursos provenientes de Segmentos Experience Cloud, o que é obtido ao bloquear recursos com o prefixo "AAM", conforme descrito no tabela acima.

Etapa 3

Observe que, depois de incluir na lista de bloqueios um recurso, é recomendável verificar a inclui na lista de bloqueios atualizada executando Etapa 2 novamente (GET incluo na lista de bloqueios). Verifique se os resultados aparecem como esperado (verifique se os resultados incluem os recursos adicionados da solicitação de PUT mais recente).

Etapa 4: (Opcional) Desbloquear step4

Incluir na lista de bloqueios Para desbloquear todos os recursos migrados, desmarque os valores blockedFeatureSources ou blockedFeatures.

Solicitação
code language-json line-numbers
PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

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

No exemplo mostrado aqui, o usuário está limpando o incluo na lista de bloqueios para a atividade cuja ID de atividade é 260840. Observe que a resposta confirma os arrays vazios para os recursos bloqueados e suas fontes —blockedFeatureSources e blockedFeatures, respectivamente.

Etapa 4

Como sempre, após modificar a inclui na lista de bloqueios, é recomendável executar Etapa 2 novamente (GET inclua na lista de bloqueios para verificar se a lista inclui recursos conforme esperado). No exemplo mostrado aqui, o usuário está verificando se a inclui na lista de bloqueios correspondente agora está vazia.

Etapa 4b

Pergunta: Como posso excluir alguns, mas não todos, de um incluo na lista de bloqueios de navegação?

Incluir na lista de bloqueios incluir na lista de bloqueios Resposta: Para remover um subconjunto discreto de recursos de uma pesquisa com vários recursos, os usuários podem simplesmente enviar a lista atualizada de recursos que gostariam de bloquear na a solicitação de inclui na lista de bloqueios ➡, em vez de limpar todo o incluo na lista de bloqueios e adicionar novamente os recursos desejados. Em outras palavras, envie a lista de recursos atualizada (conforme mostrado na Etapa 3incluir na lista de bloqueios ), certificando-se de excluir os recursos que deseja "excluir" do arquivo.

Etapa 5: (opcional) gerenciar a inclui na lista de bloqueios global step5

Os exemplos acima estavam todos no contexto de uma única atividade. Você também pode bloquear recursos para todas as atividades em um determinado cliente (locatário), em vez de precisar especificar a inclui na lista de bloqueios para cada atividade individualmente. Para executar uma inclui na lista de bloqueios global, use o /blockList/global chame, em vez de blockList/<campaignId>.

Solicitação
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"]
}
Resposta
code language-json line-numbers
{
    "blockedFeatures": [
        "AAM_FEATURE_1",
        "AAM_FEATURE_2"
    ],
    "blockedFeatureSources": [
        "AAM",
        "PRO",
        "ENV"
    ]
}

No exemplo de Solicitação mostrado acima, o usuário está bloqueando dois recursos, "AAM_FEATURE_1" e "AAM_FEATURE_2", para todas as atividades no Target conta. Isso significa que, independentemente da atividade, "AAM_FEATURE_1" e "AAM_FEATURE_2" não serão incluídos nos modelos de aprendizado de máquina dessa conta. Além disso, o usuário também está bloqueando globalmente todos os recursos cujo prefixo é "AAM", "PRO" ou "ENV".

Pergunta: a amostra de código acima não é redundante?

Resposta: Sim. É redundante bloquear recursos com valores que começam com "AAM", além de bloquear todos os recursos cuja origem é "AAM". O resultado final é que todos os recursos com origem no AAM (Segmentos de Experience Cloud) serão bloqueados. Portanto, se o objetivo for bloquear todos os recursos dos Segmentos do Experience Cloud, não é necessário especificar individualmente determinados recursos que começam com "AAM", no exemplo acima.

Etapa final: seja na atividade ou no nível global, é recomendável verificar sua inclui na lista de bloqueios depois de modificá-la, para garantir que ela contenha os valores esperados. Faça isso alterando o PUT para um GET.

A resposta de amostra mostrada abaixo indica Target O está bloqueando dois recursos individuais, além de todos os recursos provenientes de "AAM", "PRO" e "ENV".

Etapa 5

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3