Política de agregação

Última atualização em 2023-11-07
  • Tópicos
  • Destinations
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader

Para garantir a máxima eficiência ao exportar dados para o endpoint da API, você pode usar várias configurações para agregar perfis exportados em lotes maiores ou menores, agrupá-los por identidade e outros casos de uso. Isso também permite personalizar as exportações de dados para qualquer limitação downstream no endpoint da API (limitação de taxa, número de identidades por chamada de API etc.).

Use a agregação configurável para mergulhar nas configurações fornecidas pelo Destination SDK ou use a agregação de melhor esforço para informar ao Destination SDK para agrupar as chamadas de API da melhor maneira possível.

Ao criar um destino em tempo real (transmissão) com o Destination SDK, você pode configurar como os perfis exportados devem ser combinados nas exportações resultantes. Esse comportamento é determinado pelas configurações de política de agregação.

Para entender onde esse componente se encaixa em uma integração criada com o Destination SDK, consulte o diagrama no opções de configuração ou consulte o guia sobre como usar o Destination SDK para configurar um destino de transmissão.

É possível definir as configurações da política de agregação por meio do /authoring/destinations terminal. Consulte as seguintes páginas de referência de API para obter exemplos detalhados de chamadas de API, onde é possível configurar os componentes mostrados nesta página.

Este artigo descreve todas as configurações de política de agregação compatíveis que você pode usar para o seu destino.

Depois de ler este documento, consulte a documentação em uso de modelos e a variável exemplos de chave de agregação para entender como incluir a política de agregação no seu template de transformação de mensagem com base na sua política de agregação selecionada.

IMPORTANTE

Todos os nomes e valores de parâmetros compatíveis com o Destination SDK são diferencia maiúsculas de minúsculas. Para evitar erros de diferenciação entre maiúsculas e minúsculas, use os nomes e valores dos parâmetros exatamente como mostrado na documentação.

Tipos de integração compatíveis

Consulte a tabela abaixo para obter detalhes sobre quais tipos de integrações suportam a funcionalidade descrita nesta página.

Tipo de integração Suporte à funcionalidade
Integrações em tempo real (streaming) Sim
Integrações baseadas em arquivo (lote) Não

Agregação de melhor esforço

A melhor agregação de esforço funciona melhor para destinos que preferem menos perfis por solicitação e que prefeririam receber mais solicitações com menos dados do que menos solicitações com mais dados.

O exemplo de configuração abaixo mostra uma configuração de agregação de melhor esforço. Para obter um exemplo de agregação configurável, consulte agregação configurável seção. Os parâmetros aplicáveis à agregação do melhor esforço estão documentados no quadro abaixo.

"aggregation":{
   "aggregationType":"BEST_EFFORT",
   "bestEffortAggregation":{
      "maxUsersPerRequest":10,
      "splitUserById":false
   }
}
Parâmetro Tipo Descrição
aggregationType String Indica o tipo de política de agregação que seu destino deve usar. Tipos de agregação compatíveis:
  • BEST_EFFORT
  • CONFIGURABLE_AGGREGATION
bestEffortAggregation.maxUsersPerRequest Número inteiro O Experience Platform pode agregar vários perfis exportados em uma única chamada HTTP.

Esse valor indica o número máximo de perfis que seu ponto de extremidade deve receber em uma única chamada HTTP. Observe que esta é uma agregação de melhor esforço. Por exemplo, se você especificar o valor 100, a Platform poderá enviar qualquer número de perfis menor que 100 em uma chamada.

Se o servidor não aceitar vários usuários por solicitação, defina esse valor como 1.
bestEffortAggregation.splitUserById Booleano Use esse sinalizador se a chamada para o destino precisar ser dividida pela identidade. Defina esse sinalizador como true se o servidor aceitar apenas uma identidade por chamada, para um determinado namespace de identidade.
DICA

Use a agregação de esforço se o endpoint da API aceitar menos de 100 perfis por chamada de API.

Agregação configurável

A agregação configurável funciona melhor se você preferir receber grandes lotes, com milhares de perfis na mesma chamada. Essa opção também permite agregar os perfis exportados com base em regras de agregação complexas.

O exemplo de configuração abaixo mostra uma configuração de agregação configurável. Para obter um exemplo de agregação de melhor esforço, consulte agregação de melhor esforço seção. Os parâmetros aplicáveis à agregação configurável estão documentados na tabela abaixo.

"aggregation":{
   "aggregationType":"CONFIGURABLE_AGGREGATION",
   "configurableAggregation":{
      "splitUserById":true,
      "maxBatchAgeInSecs":2400,
      "maxNumEventsInBatch":5000,
      "aggregationKey":{
         "includeSegmentId":true,
         "includeSegmentStatus":true,
         "includeIdentity":true,
         "oneIdentityPerGroup":true,
         "groups":[
            {
               "namespaces":[
                  "IDFA",
                  "GAID"
               ]
            },
            {
               "namespaces":[
                  "EMAIL"
               ]
            }
         ]
      }
   }
}
Parâmetro Tipo Descrição
aggregationType String Indica o tipo de política de agregação que seu destino deve usar. Tipos de agregação compatíveis:
  • BEST_EFFORT
  • CONFIGURABLE_AGGREGATION
configurableAggregation.splitUserById Booleano Use esse sinalizador se a chamada para o destino precisar ser dividida pela identidade. Defina esse sinalizador como true se o servidor aceitar apenas uma identidade por chamada, para um determinado namespace de identidade.
configurableAggregation.maxBatchAgeInSecs Número inteiro Usado em conjunto com maxNumEventsInBatch, esse parâmetro determina quanto tempo o Experience Platform deve esperar até enviar uma chamada de API para o endpoint.
  • Valor mínimo (segundos): 1800
  • Valor máximo (segundos): 3600
Por exemplo, se você usar o valor máximo para ambos os parâmetros, o Experience Platform aguardará 3600 segundos OU até que haja 10.000 perfis qualificados antes de fazer a chamada de API, o que acontecer primeiro.
configurableAggregation.maxNumEventsInBatch Número inteiro Usado em conjunto com maxBatchAgeInSecs, esse parâmetro determina quantos perfis qualificados devem ser agregados em uma chamada de API.
  • Valor mínimo: 1000
  • Valor máximo: 10000
Por exemplo, se você usar o valor máximo para ambos os parâmetros, o Experience Platform aguardará 3600 segundos OU até que haja 10.000 perfis qualificados antes de fazer a chamada de API, o que acontecer primeiro.
configurableAggregation.aggregationKey - Permite agregar os perfis exportados mapeados para o destino com base nos parâmetros descritos abaixo.
configurableAggregation.aggregationKey.includeSegmentId Booleano Defina esse parâmetro como true se quiser agrupar perfis exportados para o seu destino pela ID de público-alvo.
configurableAggregation.aggregationKey.includeSegmentStatus Booleano Defina esse parâmetro e includeSegmentId para true, se quiser agrupar perfis exportados para o seu destino pela ID de público-alvo e pelo status do público-alvo.
configurableAggregation.aggregationKey.includeIdentity Booleano Defina esse parâmetro como true se quiser agrupar perfis exportados para o seu destino pelo namespace de identidade.
configurableAggregation.aggregationKey.oneIdentityPerGroup Booleano Defina esse parâmetro como true se desejar que os perfis exportados sejam agregados em grupos com base em uma única identidade (GAID, IDFA, números de telefone, email, etc.).
configurableAggregation.aggregationKey.groups Matriz Crie listas de grupos de identidade se quiser agrupar perfis exportados para o seu destino por grupos de namespaces de identidade. Por exemplo, você pode combinar perfis que contêm os identificadores móveis IDFA e GAID em uma chamada para o seu destino e enviar emails para outra usando a configuração mostrada no exemplo acima.

Próximas etapas

Depois de ler este artigo, você deverá entender melhor como configurar as políticas de agregação para seu destino.

Para saber mais sobre os outros componentes de destino, consulte os seguintes artigos:

Nesta página