Ponto de acesso de políticas de mesclagem

O Adobe Experience Platform permite reunir fragmentos de dados de várias fontes e combiná-los para obter uma visualização completa de cada cliente individual. Ao reunir esses dados, as políticas de mesclagem são as regras que Platform O usa o para determinar como os dados serão priorizados e quais dados serão combinados para criar uma visualização unificada.

Por exemplo, se um cliente interagir com sua marca em vários canais, sua organização terá vários fragmentos de perfil relacionados a esse único cliente que aparecem em vários conjuntos de dados. Quando esses fragmentos são assimilados na Platform, eles são mesclados para criar um único perfil para esse cliente. Quando os dados de várias origens entram em conflito (por exemplo, um fragmento lista o cliente como "único" enquanto o outro lista o cliente como "casado"), a política de mesclagem determina quais informações incluir no perfil do indivíduo.

Usando APIs RESTful ou a interface do usuário, você pode criar novas políticas de mesclagem, gerenciar políticas existentes e definir uma política de mesclagem padrão para sua organização. Este guia fornece etapas para trabalhar com políticas de mesclagem usando a API.

Para trabalhar com políticas de mesclagem usando a interface do, consulte o guia da interface do usuário de políticas de mesclagem. Para saber mais sobre as políticas de mesclagem em geral e sua função no Experience Platform, comece lendo o visão geral das políticas de mesclagem.

Introdução

O endpoint da API usado neste guia faz parte da Real-Time Customer Profile API. Antes de continuar, reveja o guia de introdução para obter links para a documentação relacionada, um guia para ler as chamadas de API de exemplo neste documento e informações importantes sobre os cabeçalhos necessários para fazer chamadas com êxito para qualquer Experience Platform API.

Componentes das políticas de mesclagem

As políticas de mesclagem são privadas para sua organização, permitindo criar políticas diferentes para mesclar esquemas das maneiras específicas necessárias. Qualquer API que acesse Profile os dados exigem uma política de mesclagem, embora um padrão seja usado se um não for fornecido explicitamente. Platform O fornece às organizações uma política de mesclagem padrão, ou você pode criar uma política de mesclagem para uma classe de esquema específica do Experience Data Model (XDM) e marcá-la como o padrão para sua organização.

Embora cada organização possa ter várias políticas de mesclagem por classe de esquema, cada classe pode ter apenas uma política de mesclagem padrão. Qualquer política de mesclagem definida como padrão será usada nos casos em que o nome da classe de esquema for fornecido e uma política de mesclagem for necessária, mas não fornecida.

Para garantir que todos os consumidores de perfil estejam trabalhando com a mesma exibição nas bordas, as políticas de mesclagem podem ser marcadas como ativas na borda. Para que um segmento seja ativado na borda (marcado como um segmento de borda), ele deve estar vinculado a uma política de mesclagem marcada como ativa na borda. Se um segmento for não vinculado a uma política de mesclagem marcada como ativa na borda, o segmento não será marcado como ativo na borda e será marcado como um segmento de transmissão.

Além disso, cada organização só pode ter um política de mesclagem ativa no edge. Se uma política de mesclagem estiver ativa na borda, ela poderá ser usada para outros sistemas na borda, como Perfil da borda, Segmentação da borda e Destinos na borda.

Concluir objeto de política de mesclagem

O objeto de política de mesclagem completo representa um conjunto de preferências que controlam os aspectos da mesclagem de fragmentos de perfil.

Objeto de política de mesclagem

    {
        "id": "{MERGE_POLICY_ID}",
        "name": "{NAME}",
        "imsOrgId": "{ORG_ID}",
        "schema": {
            "name": "{SCHEMA_CLASS_NAME}"
        },
        "version": 1,
        "identityGraph": {
            "type": "{IDENTITY_GRAPH_TYPE}"
        },
        "attributeMerge": {
            "type": "{ATTRIBUTE_MERGE_TYPE}"
        },
        "isActiveOnEdge": "{BOOLEAN}",
        "default": "{BOOLEAN}",
        "updateEpoch": "{UPDATE_TIME}"
    }

Exemplo de política de mesclagem

    {
        "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
        "name": "profile-default",
        "imsOrgId": "{ORG_ID}",
        "schema": {
            "name": "_xdm.context.profile"
        },
        "version": 1,
        "identityGraph": {
            "type": "none"
        },
        "attributeMerge": {
            "type": "timestampOrdered"
        },
        "isActiveOnEdge": false,
        "default": true,
        "updateEpoch": 1551660639
    }

Gráfico de identidade

Serviço de identidade da Adobe Experience Platform gerencia os gráficos de identidade usados globalmente e para cada organização em Experience Platform. A variável identityGraph o atributo da política de mesclagem define como determinar as identidades relacionadas de um usuário.

objeto identityGraph

    "identityGraph": {
        "type": "{IDENTITY_GRAPH_TYPE}"
    }

Onde {IDENTITY_GRAPH_TYPE} O é um dos seguintes:

• "none": Não executar a compilação de identidades.
• pdg: Execute a compilação de identidade com base no seu gráfico de identidade privado.

ExemploidentityGraph

    "identityGraph": {
        "type": "pdg"
    }

Mesclagem de atributos

Um fragmento de perfil são as informações de perfil de apenas uma identidade da lista de identidades existentes para um usuário específico. Quando o tipo de gráfico de identidade usado resulta em mais de uma identidade, há uma possibilidade de atributos de perfil conflitantes e a prioridade deve ser especificada. Usar attributeMerge, você pode especificar quais atributos de perfil priorizar no caso de um conflito de mesclagem entre conjuntos de dados do tipo Valor principal (dados de registro).

objeto attributeMerge

    "attributeMerge": {
        "type": "{ATTRIBUTE_MERGE_TYPE}"
    }

Onde {ATTRIBUTE_MERGE_TYPE} O é um dos seguintes:

• timestampOrdered: (padrão) dá prioridade ao perfil que foi atualizado por último. Usando esse tipo de mesclagem, a variável data atributo não é necessário.
• dataSetPrecedence: dê prioridade aos fragmentos de perfil com base no conjunto de dados de onde eles vieram. Isso pode ser usado quando as informações presentes em um conjunto de dados são preferenciais ou confiáveis em relação aos dados em outro conjunto de dados. Ao usar esse tipo de mesclagem, a variável order O atributo é necessário, pois lista os conjuntos de dados na ordem de prioridade.
  • order: quando "dataSetPrecedence" é usado, uma variável order A matriz deve ser fornecida com uma lista de conjuntos de dados. Quaisquer conjuntos de dados não incluídos na lista não serão mesclados. Em outras palavras, os conjuntos de dados devem ser listados explicitamente para serem mesclados em um perfil. A variável order A matriz lista as IDs dos conjuntos de dados em ordem de prioridade.

Exemplo attributeMerge objeto usando dataSetPrecedence type

    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "dataSetId_2",
            "dataSetId_3",
            "dataSetId_1",
            "dataSetId_4"
        ]
    }

Exemplo attributeMerge objeto usando timestampOrdered type

    "attributeMerge": {
        "type": "timestampOrdered"
    }

Esquema

O objeto de esquema especifica a classe de esquema do Experience Data Model (XDM) para a qual essa política de mesclagem é criada.

schemaobjeto

    "schema": {
        "name": "{SCHEMA_NAME}"
    }

Sempre que o valor de name é o nome da classe XDM na qual se baseia o esquema associado à política de mesclagem.

Exemploschema

    "schema": {
        "name": "_xdm.context.profile"
    }

Para saber mais sobre o XDM e trabalhar com esquemas no Experience Platform, comece lendo o Visão geral do sistema XDM.

Acessar políticas de mesclagem

Usar o Real-Time Customer Profile API, a variável /config/mergePolicies O endpoint permite executar uma solicitação de pesquisa para exibir uma política de mesclagem específica por sua ID ou acessar todas as políticas de mesclagem na organização, filtradas por critérios específicos. Você também pode usar a variável /config/mergePolicies/bulk-get endpoint para recuperar várias políticas de mesclagem por suas IDs. As etapas para executar cada uma dessas chamadas são descritas nas seções a seguir.

Acessar uma única política de mesclagem por ID

Você pode acessar uma única política de mesclagem por sua ID fazendo uma solicitação GET para o /config/mergePolicies e incluindo o mergePolicyId no caminho da solicitação.

Formato da API

GET /config/mergePolicies/{mergePolicyId}

Solicitação

curl -X GET \
  'https://platform.adobe.io/data/core/ups/config/mergePolicies/10648288-cda5-11e8-a8d5-f2801f1b9fd1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}

Resposta

Uma resposta bem-sucedida retorna os detalhes da política de mesclagem.

{
    "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
    "imsOrgId": "{ORG_ID}",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "pdg"
    },
    "attributeMerge": {
        "type": "timestampOrdered"
    },
    "isActiveOnEdge": "false",
    "default": false,
    "updateEpoch": 1551127597
}

Consulte a componentes de políticas de mesclagem no início deste documento para obter detalhes sobre cada um dos elementos individuais que compõem uma política de mesclagem.

Recuperar várias políticas de mesclagem por suas IDs

Você pode recuperar várias políticas de mesclagem fazendo uma solicitação POST para o /config/mergePolicies/bulk-get e incluindo as IDs das políticas de mesclagem que você deseja recuperar no corpo da solicitação.

Formato da API

POST /config/mergePolicies/bulk-get

Solicitação

O corpo da solicitação inclui uma matriz "ids" com objetos individuais contendo a "id" para cada política de mesclagem para a qual você deseja recuperar detalhes.

curl -X POST \
  'https://platform.adobe.io/data/core/ups/config/mergePolicies/bulk-get' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
        "ids": [
          {
            "id": "0bf16e61-90e9-4204-b8fa-ad250360957b"
          },
          {
            "id": "42d4a596-b1c6-46c0-994e-ca5ef1f85130"
          }
        ]
      }'

Resposta

Uma resposta bem-sucedida retorna o Status HTTP 207 (Vários status) e os detalhes das políticas de mesclagem cujas IDs foram fornecidas na solicitação POST.

{
    "results": {
        "0bf16e61-90e9-4204-b8fa-ad250360957b": {
            "id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
            "name": "Profile Default Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "none"
            },
            "attributeMerge": {
                "type": "timestampOrdered"
            },
            "isActiveOnEdge": true,
            "default": true,
            "updateEpoch": 1552086578
        },
        "42d4a596-b1c6-46c0-994e-ca5ef1f85130": {
            "id": "42d4a596-b1c6-46c0-994e-ca5ef1f85130",
            "name": "Dataset Precedence Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "pdg"
            },
            "attributeMerge": {
                "type": "dataSetPrecedence",
                "order": [
                    "5b76f86b85d0e00000be5c8b",
                    "5b76f8d787a6af01e2ceda18"
                ]
            },
            "isActiveOnEdge": false,
            "default": false,
            "updateEpoch": 1576099719
        }
    }
}

Consulte a componentes de políticas de mesclagem no início deste documento para obter detalhes sobre cada um dos elementos individuais que compõem uma política de mesclagem.

Listar várias políticas de mesclagem por critérios

Você pode listar várias políticas de mesclagem em sua organização emitindo uma solicitação GET para o /config/mergePolicies e usando parâmetros de consulta opcionais para filtrar, ordenar e paginar a resposta. Vários parâmetros podem ser incluídos, separados por "E" comercial (&). Fazer uma chamada para esse endpoint sem parâmetros recuperará todas as políticas de mesclagem disponíveis para sua organização.

Formato da API

GET /config/mergePolicies?{QUERY_PARAMS}

Para obter mais informações sobre schema.name, identityGraph.type, e attributeMerge.type, consulte o componentes de políticas de mesclagem seção fornecida anteriormente neste guia.

Solicitação

A solicitação a seguir lista todas as políticas de mesclagem para um determinado esquema:

curl -X GET \
  'https://platform.adobe.io/data/core/ups/config/mergePolicies?schema.name=_xdm.context.profile' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}

Resposta

Uma resposta bem-sucedida retorna uma lista paginada de políticas de mesclagem que atendem aos critérios especificados pelos parâmetros de consulta enviados na solicitação.

{
    "_page": {
        "totalCount": 2,
        "pageSize": 2
    },
    "children": [
        {
            "id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
            "name": "Profile Default Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "none"
            },
            "attributeMerge": {
                "type": "timestampOrdered"
            },
            "isActiveOnEdge": true,
            "default": true,
            "updateEpoch": 1552086578
        },
        {
            "id": "42d4a596-b1c6-46c0-994e-ca5ef1f85130",
            "name": "Dataset Precedence Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "pdg"
            },
            "attributeMerge": {
                "type": "dataSetPrecedence",
                "order": [
                    "5b76f86b85d0e00000be5c8b",
                    "5b76f8d787a6af01e2ceda18"
                ]
            },
            "isActiveOnEdge": false,
            "default": false,
            "updateEpoch": 1576099719
        }
    ],
    "_links": {
        "next": {
            "href": "@/mergePolicies?start=K1JJRDpFaWc5QUpZWHY1c2JBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQldBQkVBQVBnaFFQLzM4VUIvL2tKQi8rLysvMUpBLzMrMi8wRkFmLzR4UUwvL0VrRC85em4zRTBEcmNmYi92Kzh4UUwvL05rQVgzRi8rMStqNS80WHQwN2NhUUVzQUFBUUFleGpLQ1JnVXRVcEFCQUFFQVBBRA==&orderBy=&limit=2"
        }
    }
}

Criar uma política de mesclagem

Você pode criar uma nova política de mesclagem para sua organização fazendo uma solicitação POST para o /config/mergePolicies terminal.

Formato da API

POST /config/mergePolicies

Solicitação
A solicitação a seguir cria uma nova política de mesclagem, que é configurada pelos valores de atributo fornecidos na carga:

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/mergePolicies \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Loyalty members ordered by ID",
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type":"dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "schema": {
        "name":"_xdm.context.profile"
    },
    "isActiveOnEdge": true,
    "default": true
}'

Consulte a componentes de políticas de mesclagem para obter mais informações.

Resposta

Uma resposta bem-sucedida retorna os detalhes da política de mesclagem recém-criada.

{
    "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
    "name": "Loyalty members ordered by ID",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "isActiveOnEdge": true,
    "default": true,
    "updateEpoch": 1551898378
}

Consulte a componentes de políticas de mesclagem no início deste documento para obter detalhes sobre cada um dos elementos individuais que compõem uma política de mesclagem.

Atualizar uma política de mesclagem

Você pode modificar uma política de mesclagem existente editando atributos individuais (PATCH) ou substituindo a política de mesclagem inteira por novos atributos (PUT). Exemplos de cada um são mostrados abaixo.

Editar campos de política de mesclagem individuais

É possível editar campos individuais para uma política de mesclagem fazendo uma solicitação PATCH para a /config/mergePolicies/{mergePolicyId} endpoint:

Formato da API

PATCH /config/mergePolicies/{mergePolicyId}

Solicitação

A solicitação a seguir atualiza uma política de mesclagem especificada alterando o valor de sua default propriedade para true:

curl -X PATCH \
  https://platform.adobe.io/data/core/ups/config/mergePolicies/e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
    "op": "add",
    "path": "/default",
    "value": "true"
  }'

Consulte a componentes de políticas de mesclagem para obter mais informações.

Resposta

Uma resposta bem-sucedida retorna os detalhes da política de mesclagem recém-atualizada.

{
    "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
    "name": "Loyalty members ordered by ID",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "isActiveOnEdge": true,
    "default": true,
    "updateEpoch": 1551898378
}

Substituir uma política de mesclagem

Outra maneira de modificar uma política de mesclagem é usar uma solicitação PUT, que substitui toda a política de mesclagem.

Formato da API

PUT /config/mergePolicies/{mergePolicyId}

Solicitação

A solicitação a seguir substitui a política de mesclagem especificada, substituindo seus valores de atributo pelos fornecidos na carga. Como essa solicitação substitui completamente uma política de mesclagem existente, é necessário fornecer todos os mesmos campos que foram necessários ao definir originalmente a política de mesclagem. No entanto, desta vez você está fornecendo valores atualizados para os campos que deseja alterar.

curl -X PUT \
  https://platform.adobe.io/data/core/ups/config/mergePolicies/e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Loyalty members ordered by ID",
        "imsOrgId": "{ORG_ID}",
        "schema": {
            "name": "_xdm.context.profile"
        },
        "version": 1,
        "identityGraph": {
            "type": "none"
        },
        "attributeMerge": {
            "type": "dataSetPrecedence",
            "order": [
                "5b76f86b85d0e00000be5c8b",
                "5b76f8d787a6af01e2ceda18"
            ]
        },
        "isActiveOnEdge": true,
        "default": true,
        "updateEpoch": 1551898378
    }'

Consulte a componentes de políticas de mesclagem para obter mais informações.

Resposta

Uma resposta bem-sucedida retorna os detalhes da política de mesclagem atualizada.

{
    "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
    "name": "Loyalty members ordered by ID",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "isActiveOnEdge": true,
    "default": true,
    "updateEpoch": 1551898378
}

Excluir uma política de mesclagem

Uma política de mesclagem pode ser excluída fazendo uma solicitação DELETE para o /config/mergePolicies e incluindo a ID da política de mesclagem que você deseja excluir no caminho da solicitação.

Formato da API

DELETE /config/mergePolicies/{mergePolicyId}

Solicitação

A solicitação a seguir exclui uma política de mesclagem.

curl -X DELETE \
  https://platform.adobe.io/data/core/ups/config/mergePolicies/e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Resposta

Uma solicitação de exclusão bem-sucedida retorna o Status HTTP 200 (OK) e um corpo de resposta vazio. Para confirmar que a exclusão foi bem-sucedida, você pode executar uma solicitação do GET para visualizar a política de mesclagem pela ID. Se a política de mesclagem tiver sido excluída, você receberá um erro de Status HTTP 404 (Não encontrado).

Próximas etapas

Agora que você sabe como criar e configurar políticas de mesclagem para sua organização, é possível usá-las para ajustar a visualização de perfis de clientes na Platform e criar segmentos de público-alvo a partir do seu Real-Time Customer Profile dados.

Consulte a Documentação do Serviço de segmentação da Adobe Experience Platform para começar a definir e trabalhar com segmentos.

Recursos do Business.Adobe.com