Atributos da interface

Última atualização em 2024-01-10
  • Tópicos
  • Destinations
    Exibir mais informações sobre este tópico
  • Criado para:
  • Admin
    User

Os atributos da interface definem os elementos visuais que o Adobe deve exibir para o cartão de destino na interface do usuário do Adobe Experience Platform, como um logotipo, um link para a página de documentação, uma descrição do destino e sua categoria e tipo.

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 as seguintes páginas de visão geral da configuração de destino:

Quando criação de um destino por meio do Destination SDK, o uiAttributes define as seguintes propriedades visuais do cartão de destino:

  • O URL da página de documentação de destino no catálogo de destino.
  • A categoria em que o destino estará visível na interface do usuário da Platform.
  • A frequência de exportação de dados para seu destino.
  • O tipo de conexão de destino, como Amazon S3, Azure Blob etc.
  • O URL no qual você hospedou o ícone a ser exibido no cartão do catálogo de destinos.

É possível configurar atributos de interface do usuário por meio da /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 todos os atributos de interface do usuário compatíveis que você pode usar para o seu destino e mostra o que os clientes verão na interface do usuário do Experience Platform.

Captura de tela da interface do usuário mostrando os atributos da interface na interface do Experience Platform

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) Sim

Parâmetros compatíveis

"uiAttributes":{
      "documentationLink":"http://www.adobe.com/go/YOURDESTINATION-en",
      "category":"cloudStorage",
      "connectionType":"S3",
      "frequency":"batch",
      "isBeta":"true"
   }

documentationLink é um parâmetro de string que se refere à página da documentação no Catálogo de destinos para o seu destino. Cada destino do produto no Adobe Experience Platform deve ter uma página de documentação correspondente. Saiba como criar uma página de documentação de destino para o seu destino. Observe que isso não é necessário para destinos privados/personalizados.

Usar o seguinte formato: http://www.adobe.com/go/destinations-YOURDESTINATION-en, onde YOURDESTINATION é o nome do seu destino. Para um destino chamado Moviestar, você usaria http://www.adobe.com/go/destinations-moviestar-en.

Os usuários podem ver e visitar o link da documentação na página do catálogo de destinos na interface do. Eles precisam navegar até o cartão de destino e selecionar Mais ações e depois Exibir documentação, conforme mostrado na imagem abaixo.

Imagem da interface mostrando o local do link da documentação.

OBSERVAÇÃO

Esse link funciona somente depois que o Adobe definir seu destino como ativo e a documentação for publicada.

category

category é um parâmetro de string que se refere à categoria atribuída ao destino no Adobe Experience Platform. Para obter mais informações, leia Categorias de destino. Use um dos seguintes valores: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.

Os usuários podem ver a lista de categorias de destino no lado esquerdo da tela no catálogo de destino, como mostrado na imagem abaixo.

Imagem da interface do usuário mostrando o local da categoria de destino.

connectionType

connectionType é um parâmetro de string que se refere ao tipo de conexão, dependendo do destino. Valores compatíveis:

  • Server-to-server
  • Cloud storage
  • Azure Blob
  • Azure Data Lake Storage
  • S3
  • SFTP
  • DLZ

Os usuários podem ver o tipo de conexão de destino no Procurar do espaço de trabalho de destinos.

Imagem da interface mostrando o local do tipo de conexão na interface do usuário.

frequency

frequency é um parâmetro de string que se refere ao tipo de exportação de dados aceito pelo seu destino. Defina como Streaming para integrações baseadas em API, ou Batch ao exportar arquivos para seus destinos.

Os usuários podem ver o tipo de frequência no O fluxo de dados é executado de cada conexão de destino.

Imagem da interface mostrando o local do tipo de frequência na interface do usuário.

isBeta

Se o destino que você está criando com o Destination SDK estiver disponível para um número limitado de clientes, talvez você queira marcar o cartão de destino do catálogo de destino como beta.

Para fazer isso, você pode usar o isBeta: "true" na seção Atributos da interface da configuração de destino para marcar o cartão de destino adequadamente.

Imagem da interface do usuário mostrando um cartão de destino marcado como beta.

icon

Você pode adicionar um ícone de logotipo ao seu destino, conforme mostrado na imagem abaixo.

Imagem da interface mostrando o local do ícone.

Para adicionar um logotipo ao cartão de destino, é necessário compartilhar a imagem desejada com a equipe do Adobe ao enviar o destino para revisão.

Próximas etapas

Depois de ler este artigo, você deve entender melhor quais atributos de interface do usuário você pode configurar para seu destino e onde os usuários os verão na interface do usuário da Platform.

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

Nesta página