As políticas de uso de dados são regras adotadas por sua organização que descrevem os tipos de ações de marketing às quais você tem permissão ou é restrito para executar em dados na plataforma da experiência.
O /policies terminal é usado para todas as chamadas de API relacionadas à exibição, criação, atualização ou exclusão de políticas de uso de dados.
Lista de todas as políticas
Para visualização de uma lista de políticas, uma solicitação GET pode ser feita para /policies/core ou /policies/custom que retorna todas as políticas para o container especificado.
A resposta inclui uma "contagem" que mostra o número total de políticas dentro do container especificado, bem como os detalhes de cada política, incluindo sua política id . O id campo é usado para executar solicitações de pesquisa para visualização de políticas específicas, bem como para executar operações de atualização e exclusão.
Procurar política específica
Cada política contém um id campo que pode ser usado para solicitar os detalhes de uma política específica. Se o conteúdo id de uma política for desconhecido, poderá ser encontrado usando a solicitação de listagem (GET) para lista de todas as políticas dentro de um container específico ( core ou custom ), conforme mostrado na etapa anterior.
A resposta contém os detalhes da política, incluindo campos chave como id (esse campo deve corresponder ao id enviado na solicitação), name , status e description , bem como um link de referência para a ação de marketing em que a política se baseia ( marketingActionRefs ).
A criação de uma política requer a inclusão de uma ação de marketing com uma expressão dos rótulos DULE que proíbem essa ação de marketing. As definições de política devem incluir uma deny propriedade, que é uma expressão booleana em relação à presença de rótulos DULE.
Essa expressão é chamada de e é um objeto que contém PolicyExpression uma etiqueta ou __ um operador e operandos, mas não ambos. Por sua vez, cada operando também é um PolicyExpression objeto. Por exemplo, uma política relacionada à exportação de dados para terceiros pode ser proibida se C1 OR (C3 AND C7) houver etiquetas. Essa expressão seria especificada como:
Se criado com êxito, você receberá um Status HTTP 201 (Criado) e o corpo da resposta conterá os detalhes da política recém-criada, incluindo sua id . Esse valor é somente leitura e é atribuído automaticamente quando a política é criada.
Talvez seja necessário atualizar uma política de uso de dados após sua criação. Isso é feito por meio de uma solicitação PUT à política id com uma carga que inclui a forma atualizada da política, em sua totalidade. Por outras palavras, o pedido da PUT está essencialmente a reformular a política, pelo que o organismo deve incluir todas as informações necessárias, como se pode ver no exemplo seguinte.
Neste exemplo, as condições para exportar dados para terceiros foram alteradas e agora você precisa da política criada para negar essa ação de marketing se houver rótulos de C1 AND (C3 OR C7) dados. Você usaria a chamada a seguir para atualizar a política existente.
Uma solicitação de atualização bem-sucedida retorna um Status HTTP 200 (OK) e o corpo da resposta mostrará a política atualizada. A solicitação id deve corresponder à id enviada.
Atualizar uma parte de uma política
Uma parte específica de uma política pode ser atualizada usando uma solicitação PATCH. Diferentemente das solicitações PUT que reescrevem a política, as solicitações PATCH atualizam somente o caminho especificado no corpo da solicitação. Isso é especialmente útil quando você deseja ativar ou desativar uma política, pois é necessário enviar apenas o caminho específico que deseja atualizar ( /status ) e seu valor ( ENABLE ou DISABLE ).
A API do Serviço de Política suporta atualmente operações PATCH "add", "replace" e "remove" e permite combinar várias atualizações em uma única chamada adicionando cada uma como um objeto dentro da matriz, como mostrado nos exemplos a seguir.
Neste exemplo, estamos usando a operação "substituir" para alterar o status da política de "RASCUNHO" para "ATIVADO" e atualizar o campo de descrição com uma nova descrição. Também poderíamos ter atualizado o campo de descrição usando a operação "excluir" para remover a descrição da política e, em seguida, usando a operação "adicionar" para adicionar uma nova vez, assim:
Ao enviar várias operações PATCH em uma única solicitação, lembre-se de que elas serão processadas na ordem em que aparecem no storage, portanto, verifique se você está enviando as solicitações na ordem correta, onde necessário.
Uma solicitação de atualização bem-sucedida retornará um Status HTTP 200 (OK) e o corpo da resposta mostrará a política atualizada ("status" agora é "ENABLED" e "descrição" foi alterada). A política id deve corresponder à id enviada na solicitação.
Se for necessário remover uma política criada, você poderá fazê-lo emitindo uma solicitação DELETE para o nome id da política que deseja excluir. É a prática recomendada executar uma solicitação de pesquisa (GET) primeiro para visualização da política e confirmar se ela é a política correta que você deseja remover. Depois de excluídas, as políticas não podem ser recuperadas.
Se a política tiver sido excluída com êxito, o corpo da resposta ficará em branco com um Status HTTP 200 (OK).
Você pode confirmar a exclusão tentando pesquisar (GET) a política novamente. Você deve receber um Status HTTP 404 (Não encontrado) juntamente com uma mensagem de erro "Não encontrado" porque a política foi removida.