Configuração de segredos no encaminhamento de eventos

No encaminhamento de eventos, um segredo é um recurso que representa uma credencial de autenticação para outro sistema, permitindo a troca segura de dados. Segredos só podem ser criados nas propriedades de encaminhamento de eventos.

Os seguintes tipos secretos são suportados no momento:

Tipo secreto
Descrição
Google OAuth 2
Contém vários atributos para oferecer suporte à especificação de autenticação do OAuth 2.0 para uso na API do Google Ads e na API Pub/Sub. O sistema solicita as informações necessárias e, em seguida, lida com a renovação desses tokens em um intervalo especificado.
HTTP
Contém dois atributos de string para um nome de usuário e senha, respectivamente.
LinkedIn OAuth 2
O sistema solicita as informações necessárias e, em seguida, lida com a renovação desses tokens em um intervalo especificado.
OAuth 2
Contém vários atributos para dar suporte ao tipo de concessão de credenciais do cliente para a especificação de autenticação do OAuth 2.0. O sistema solicita as informações necessárias e, em seguida, lida com a renovação desses tokens em um intervalo especificado.
JWT do OAuth 2
Contém vários atributos para oferecer suporte ao Perfil JSON Web Token (JWT) para autorizações OAuth 2.0. O sistema solicita as informações necessárias e, em seguida, lida com a renovação desses tokens em um intervalo especificado.
Token
Uma única cadeia de caracteres que representa um valor de token de autenticação conhecido e compreendido por ambos os sistemas.

Este guia fornece uma visão geral de alto nível sobre como configurar segredos para uma propriedade de encaminhamento de eventos (Edge) na interface do usuário do Experience Platform ou na interface da Coleção de Dados.

NOTE
Para obter orientação detalhada sobre como gerenciar segredos na API do Reator, incluindo o exemplo JSON da estrutura de um segredo, consulte o guia de API de segredos.

Pré-requisitos

Este guia pressupõe que você já esteja familiarizado com a forma de gerenciar recursos para tags e encaminhamento de eventos na interface do usuário, incluindo como criar um elemento de dados e uma regra de encaminhamento de eventos. Consulte o guia sobre gerenciamento de recursos se você precisar de uma introdução.

Você também deve ter uma compreensão funcional do fluxo de publicação de tags e do encaminhamento de eventos, incluindo como adicionar recursos a uma biblioteca e instalar uma build no site para teste. Consulte a visão geral da publicação para obter mais detalhes.

Criar um segredo create

Para criar um segredo, selecione Encaminhamento de Eventos na navegação à esquerda e abra a propriedade de encaminhamento de eventos em que deseja adicionar o segredo. Em seguida, selecione Segredos na navegação à esquerda, seguido por Criar novo segredo.

Criar novo segredo

A próxima tela permite configurar os detalhes do segredo. Para que um segredo possa ser usado pelo encaminhamento de eventos, ele deve ser atribuído a um ambiente existente. Se você não tiver nenhum ambiente criado para a propriedade de encaminhamento de eventos, consulte o manual em ambientes para obter orientação sobre como configurá-los antes de continuar.

NOTE
Se você ainda quiser criar e salvar o segredo antes de adicioná-lo a um ambiente, desative a opção Anexar segredo a ambientes antes de preencher o restante das informações. Observe que será necessário atribuí-lo a um ambiente posteriormente se desejar usar o segredo.
Desabilitar ambiente

Em Ambiente de destino, use o menu suspenso para selecionar o ambiente ao qual deseja atribuir o segredo. Em Nome do Segredo, forneça um nome para o segredo no contexto do ambiente. Esse nome deve ser exclusivo em todos os segredos na propriedade de encaminhamento de eventos.

Ambiente e nome

Um segredo só pode ser atribuído a um ambiente por vez, mas você pode atribuir as mesmas credenciais a vários segredos em ambientes diferentes, se desejar. Selecione Adicionar Ambiente para adicionar outra linha à lista.

Adicionar ambiente

Para cada ambiente adicionado, é necessário fornecer outro nome exclusivo para o segredo associado. Se você esgotar todos os ambientes disponíveis, o botão Adicionar ambiente não estará disponível.

Adicionar ambiente indisponível

Aqui, as etapas para criar o segredo diferem dependendo do tipo de segredo que está sendo criado. Consulte as subseções abaixo para obter detalhes:

Token token

Para criar um segredo de token, selecione Token na lista suspensa Tipo. No campo Token exibido, forneça a cadeia de caracteres de credencial reconhecida pelo sistema no qual você está autenticando. Selecione Criar Segredo para salvar o segredo.

Segredo do token

HTTP http

Para criar um segredo HTTP, selecione HTTP Simples na lista suspensa Tipo. Nos campos que aparecem abaixo, forneça um nome de usuário e senha para a credencial antes de selecionar Criar segredo para salvar o segredo.

NOTE
Após ser salva, a credencial é codificada usando o esquema de autenticação HTTP "Básico".

Segredo HTTP

OAuth 2 oauth2

Para criar um segredo do OAuth 2, selecione OAuth 2 na lista suspensa Tipo. Nos campos que aparecem abaixo, forneça sua ID do Cliente e o Segredo do Cliente, bem como sua URL do Token para a integração com o OAuth. O campo URL do token na interface é uma concatenação entre o host do servidor de autorização e o caminho do token.

Segredo do OAuth 2

Em Opções de Credencial, você pode fornecer outras opções de credencial, como scope e audience, na forma de pares de valores chave. Para adicionar mais pares de valor-chave, selecione Adicionar outro.

Opções de credencial

Finalmente, você pode configurar o valor Atualizar Deslocamento para o segredo. Representa o número de segundos antes da expiração do token em que o sistema executará uma atualização automática. O tempo equivalente em horas e minutos é exibido à direita do campo e é atualizado automaticamente à medida que você digita.

Atualizar Deslocamento

Por exemplo, se o deslocamento de atualização estiver definido com o valor padrão de 14400 (quatro horas) e o token de acesso tiver um valor de expires_in de 86400 (24 horas), o sistema atualizará automaticamente o segredo em 20 horas.

IMPORTANT
Um segredo OAuth requer pelo menos quatro horas entre as atualizações e também deve ser válido por no mínimo oito horas. Essa restrição oferece um mínimo de quatro horas para você intervir se surgirem problemas com o token gerado.
Por exemplo, se o deslocamento estiver definido como 28800 (oito horas) e o token de acesso tiver um expires_in de 36000 (dez horas), a troca falhará devido à diferença resultante ser inferior a quatro horas.

Quando terminar, selecione Criar Segredo para salvar o segredo.

Salvar deslocamento do OAuth 2

JWT do OAuth 2 oauth2jwt

Para criar um segredo JWT do OAuth 2, selecione JWT do OAuth 2 na lista suspensa Tipo.

A guia Criar Segredo com o segredo JWT do OAuth 2 destacado na lista suspensa Tipo.

NOTE
O único algoritmo atualmente aceito para assinar o JWT é RS256.

Nos campos que aparecem abaixo, forneça seu Emissor, Assunto, Público-alvo, Declarações personalizadas, TTL e selecione o Algoritmo na lista suspensa. Em seguida, insira a ID da Chave privada, bem como a URL do token para a integração com o OAuth. O campo URL do token não é um campo obrigatório. Se um valor for fornecido, o JWT será trocado com um token de acesso. O segredo será atualizado de acordo com o atributo expires_in da resposta e o valor Deslocamento de Atualização. Se um valor não for fornecido, o segredo enviado para a borda será o JWT. O JWT será atualizado de acordo com os valores TTL e Atualizar Deslocamento.

A guia Criar Segredo com uma seleção de campos de entrada destacados.

Em Opções de Credencial, você pode fornecer outras opções de credencial, como jwt_param, na forma de pares de valores chave. Para adicionar mais pares de valor-chave, selecione Adicionar outro.

A guia Criar Segredo destacando os campos Opções de Credencial.

Finalmente, você pode configurar o valor Atualizar Deslocamento para o segredo. Representa o número de segundos antes da expiração do token em que o sistema executará uma atualização automática. O tempo equivalente em horas e minutos é exibido à direita do campo e é atualizado automaticamente à medida que você digita.

A guia Criar Segredo destacando o campo Atualizar Deslocamento.

Por exemplo, se o deslocamento de atualização estiver definido com o valor padrão de 1800 (30 minutos) e o token de acesso tiver um valor de expires_in de 3600 (uma hora), o sistema atualizará automaticamente o segredo em uma hora.

IMPORTANT
Um segredo JWT do OAuth 2 requer pelo menos 30 minutos entre as atualizações e também deve ser válido por no mínimo uma hora. Essa restrição oferece um mínimo de 30 minutos para você intervir se surgirem problemas com o token gerado.
Por exemplo, se o deslocamento estiver definido como 1800 (30 minutos) e o token de acesso tiver um expires_in de 2700 (45 minutos), a troca falhará devido à diferença resultante ser inferior a 30 minutos.

Quando terminar, selecione Criar Segredo para salvar o segredo.

A guia Criar Segredo destacando Criar Segredo

Google OAuth 2 google-oauth2

Para criar um segredo do Google OAuth 2, selecione Google OAuth 2 na lista suspensa Tipo. Em Escopos, selecione as APIs do Google às quais você deseja usar este segredo para conceder acesso. Os seguintes produtos são suportados no momento:

Quando terminar, selecione Criar Segredo.

Segredo do Google OAuth 2

Um popover é exibido informando que o segredo precisa ser autorizado manualmente por meio do Google. Selecione Criar e autorizar para continuar.

popover de autorização do Google

Uma caixa de diálogo é exibida, permitindo inserir as credenciais da conta da Google. Siga as instruções para conceder acesso ao encaminhamento de eventos para seus dados no escopo selecionado. Quando o processo de autorização estiver concluído, o segredo será criado.

IMPORTANT
Se sua organização tiver uma política de reautenticação definida para aplicativos da Google Cloud, os segredos criados não serão atualizados com êxito após a autenticação expirar (entre 1 e 24 horas, dependendo da configuração da política).
Para resolver esse problema, entre no Admin Console do Google e navegue até a página App access control para poder marcar o aplicativo de encaminhamento de eventos (Encaminhamento de Eventos do Adobe Real-Time CDP) como Trusted. Consulte a documentação do Google em definindo a duração da sessão dos serviços da Google Cloud para obter mais informações.

LinkedIn OAuth 2 linkedin-oauth2

Para criar um segredo do OAuth 2 LinkedIn, selecione LinkedInOAuth 2 na lista suspensa Tipo. Em seguida, selecione Criar Segredo.

A guia Criar Segredo com o campo Tipo realçado.

Um popover é exibido informando que o segredo precisa ser autorizado manualmente por meio do LinkedIn. Selecione Criar e autorizar segredo comLinkedIn para continuar.

Popover de autorização LinkedIn destacando Criar e autorizar segredo com LinkedIn.

Uma caixa de diálogo é exibida solicitando que você insira suas credenciais do LinkedIn. Siga as instruções para conceder acesso ao encaminhamento de eventos para seus dados.

Quando o processo de autorização for concluído, você retornará à guia Segredos, na qual poderá ver o segredo recém-criado. Aqui você pode ver o status do segredo e a data de expiração.

A guia Segredo destacando o segredo recém-criado.

Reautorizar um segredo LinkedIn do OAuth 2

IMPORTANTE

Você precisa reautorizar usando suas credenciais do LinkedIn a cada 365 dias. Se você não reautorizar em tempo hábil, seu segredo não será atualizado e as solicitações de conversão do LinkedIn falharão.

Três meses antes do segredo que requer reautorização, um pop-up começará a ser exibido quando você estiver navegando em qualquer página da propriedade. Selecione Clique aqui para acessar seus segredos.

A guia Visão Geral da Propriedade destacando o pop-up secreto de reautorização.

Você será redirecionado para a guia Segredos. Os segredos listados nesta página são filtrados para mostrar apenas os segredos que precisam ser reautorizados. Selecione Autenticação Necessária para o segredo que você precisa reautorizar.

A guia Segredo destacando a Autenticação Necessáriapara o segredo LinkedIn.

Uma caixa de diálogo é exibida solicitando que você insira suas credenciais do LinkedIn. Siga as instruções para reautorizar o segredo.

Editar um segredo

Após criar segredos para uma propriedade, você pode encontrá-los listados no espaço de trabalho Segredos. Para editar os detalhes de um segredo existente, selecione o nome na lista.

Selecionar segredo para editar

A próxima tela permite alterar o nome e as credenciais do segredo.

Editar segredo

NOTE
Se o segredo estiver associado a um ambiente existente, não será possível reatribuir o segredo a outro ambiente. Se quiser usar as mesmas credenciais em um ambiente diferente, você deve criar um novo segredo. A única maneira de reatribuir o ambiente a partir dessa tela é se você nunca atribuiu o segredo a um ambiente antecipadamente ou se excluiu o ambiente ao qual o segredo estava anexado.

Tentar novamente uma troca secreta

Você pode tentar novamente ou atualizar uma troca de segredo na tela de edição. Esse processo varia dependendo do tipo de segredo que está sendo editado:

Tipo secreto
Tentar protocolo novamente
Token
Selecione Segredo do Exchange para repetir a troca secreta. Esse controle só está disponível quando há um ambiente anexado ao segredo.
HTTP
Se não houver um ambiente anexado ao segredo, selecione Segredo do Exchange para trocar a credencial para base64. Se um ambiente estiver anexado, selecione Exchange e Implantar Segredo para o exchange em base64 e implante o segredo.
OAuth 2
Selecione Gerar token para trocar as credenciais e retornar um token de acesso do provedor de autenticação.

Excluir um segredo

Para excluir um segredo existente no espaço de trabalho Segredos, marque a caixa de seleção ao lado do respectivo nome antes de marcar Excluir.

Excluir segredo

Uso de segredos no encaminhamento de eventos

Para usar um segredo no encaminhamento de eventos, primeiro você deve criar um elemento de dados que faça referência ao próprio segredo. Depois de salvar o elemento de dados, você pode incluí-lo no encaminhamento de eventos regras e adicionar essas regras a uma biblioteca, que, por sua vez, pode ser implantada nos servidores de Adobe como uma compilação.

Ao criar o elemento de dados, selecione a extensão Core e Secret para o tipo de elemento de dados. O painel direito atualiza e fornece controles suspensos para atribuir até três segredos ao elemento de dados: um para Desenvolvimento, Preparo e Produção, respectivamente.

Elemento de dados

NOTE
Somente os segredos anexados aos ambientes de desenvolvimento, preparo e produção são exibidos para seus respectivos detalhamentos.

Atribuindo vários segredos a um único elemento de dados e incluindo uma regra, você pode fazer com que o valor do elemento de dados seja alterado, dependendo de onde a biblioteca que contém está no fluxo de publicação.

Elemento de dados com vários segredos

NOTE
Ao criar o elemento de dados, um ambiente de desenvolvimento deve ser atribuído. Segredos para os ambientes de preparo e produção não são necessários, mas compilações que tentarem fazer a transição para esses ambientes falharão se seus elementos de dados do tipo secreto não tiverem um segredo selecionado para o ambiente em questão.

Próximas etapas

Este guia aborda como gerenciar segredos na interface do usuário do. Para obter informações sobre como interagir com segredos usando a API do Reator, consulte o manual de endpoint de segredos.

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743