I criteri di utilizzo dei dati sono regole che descrivono i tipi di azioni di marketing che ti sono consentite o a cui ti è impedito di eseguire sui dati all’interno di Experience Platform. La /policies
punto finale Policy Service API consente di gestire in modo programmatico i criteri di utilizzo dei dati per l’organizzazione.
L’endpoint API utilizzato in questa guida fa parte del Policy Service API. Prima di continuare, controlla la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio presenti in questo documento e informazioni importanti sulle intestazioni richieste necessarie per effettuare correttamente le chiamate a qualsiasi Experience Platform API.
È possibile elencare tutti core
o custom
, richiedendo la GET a /policies/core
o /policies/custom
, rispettivamente.
Formato API
GET /policies/core
GET /policies/custom
Richiesta
La richiesta seguente recupera un elenco di criteri personalizzati definiti dall'organizzazione.
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
-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}'
Risposta
Una risposta corretta include un children
array in cui sono elencati i dettagli di ciascun criterio recuperato, inclusi i relativi id
valori. È possibile utilizzare id
campo di una particolare politica da eseguire ricerca, updatee delete richieste di tale politica.
{
"_page": {
"start": "5c6dacdf685a4913dc48937c",
"count": 2
},
"_links": {
"page": {
"href": "https://platform.adobe.io/policies/custom?{?limit,start,property}",
"templated": true
}
},
"children": [
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550701472910,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
},
{
"name": "Combine Data",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/combineData"
],
"description": "Data that meets these conditions cannot be combined.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C3"
},
{
"label": "I1"
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550714340335,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb9f5c404513dc2dc454"
}
},
"id": "5c6ddb9f5c404513dc2dc454"
}
]
}
Proprietà | Descrizione |
---|---|
_page.count |
Numero totale di criteri recuperati. |
name |
Nome visualizzato di un criterio. |
status |
Lo stato corrente di un criterio. Sono disponibili tre stati possibili: DRAFT , ENABLED oppure DISABLED . Per impostazione predefinita, solo ENABLED Le politiche partecipano alla valutazione. Vedi la panoramica su valutazione politica per ulteriori informazioni. |
marketingActionRefs |
Matrice che elenca gli URI di tutte le azioni di marketing applicabili per un criterio. |
description |
Una descrizione facoltativa che fornisce ulteriore contesto al caso d’uso del criterio. |
deny |
Un oggetto che descrive le etichette di utilizzo dati specifiche per le quali è stata limitata l'esecuzione dell'azione di marketing associata a un criterio. Vedi la sezione su creazione di un criterio per ulteriori informazioni su questa proprietà. |
Puoi cercare una politica specifica includendo quella id
nel percorso di una richiesta GET.
Formato API
GET /policies/core/{POLICY_ID}
GET /policies/custom/{POLICY_ID}
Parametro | Descrizione |
---|---|
{POLICY_ID} |
La id della politica che si desidera cercare. |
Richiesta
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-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}'
Risposta
Una risposta corretta restituisce i dettagli del criterio.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550714340335,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
Proprietà | Descrizione |
---|---|
name |
Nome visualizzato del criterio. |
status |
Stato corrente del criterio. Sono disponibili tre stati possibili: DRAFT , ENABLED oppure DISABLED . Per impostazione predefinita, solo ENABLED Le politiche partecipano alla valutazione. Vedi la panoramica su valutazione politica per ulteriori informazioni. |
marketingActionRefs |
Matrice che elenca gli URI di tutte le azioni di marketing applicabili al criterio. |
description |
Una descrizione facoltativa che fornisce ulteriore contesto al caso d’uso del criterio. |
deny |
Un oggetto che descrive le etichette di utilizzo dei dati specifiche sulle quali l'azione di marketing associata al criterio non viene eseguita. Vedi la sezione su creazione di un criterio per ulteriori informazioni su questa proprietà. |
In Policy Service API, un criterio è definito dai seguenti elementi:
Per soddisfare quest’ultimo requisito, le definizioni dei criteri devono includere un’espressione booleana relativa alla presenza di etichette di utilizzo dei dati. Questa espressione è denominata espressione di criterio.
Le espressioni di criterio vengono fornite sotto forma di deny
all'interno di ogni definizione di criterio. Esempio di un semplice deny
un oggetto che controlla solo la presenza di una singola etichetta avrà un aspetto simile al seguente:
"deny": {
"label": "C1"
}
Tuttavia, molti criteri specificano condizioni più complesse relative alla presenza di etichette per l’utilizzo dei dati. Per supportare questi casi d’uso, puoi anche includere le operazioni booleane per descrivere le espressioni dei criteri. L'oggetto espressione policy deve contenere un'etichetta o un operatore e operandi, ma non entrambi. A sua volta, ogni operando è anche un oggetto espressione di criterio.
Ad esempio, per definire un criterio che vieta l’esecuzione di un’azione di marketing sui dati in cui C1 OR (C3 AND C7)
le etichette sono presenti, le deny
viene specificata come:
"deny": {
"operator": "OR",
"operands": [
{"label": "C1"},
{
"operator": "AND",
"operands": [
{"label": "C3"},
{"label": "C7"}
]
}
]
}
Proprietà | Descrizione |
---|---|
operator |
Indica la relazione condizionale tra le etichette fornite nel pari livello operands array. I valori accettati sono:
|
operands |
Matrice di oggetti, con ogni oggetto che rappresenta una singola etichetta o una coppia aggiuntiva operator e operands proprietà. Presenza delle etichette e/o delle operazioni in un operands viene risolto in true o false in base al valore del relativo elemento di pari livello operator proprietà. |
label |
Nome di un'etichetta di utilizzo dati singola applicata al criterio. |
Puoi creare un nuovo criterio personalizzato effettuando una richiesta di POST al /policies/custom
punto finale.
Formato API
POST /policies/custom
Richiesta
La seguente richiesta crea un nuovo criterio che limita l’azione di marketing exportToThirdParty
da eseguire su dati contenenti etichette C1 OR (C3 AND C7)
.
curl -X POST \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "OR",
"operands": [
{"label": "C1"},
{
"operator": "AND",
"operands": [
{"label": "C3"},
{"label": "C7"}
]
}
]
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome visualizzato del criterio. |
status |
Stato corrente del criterio. Sono disponibili tre stati possibili: DRAFT , ENABLED oppure DISABLED . Per impostazione predefinita, solo ENABLED Le politiche partecipano alla valutazione. Vedi la panoramica su valutazione politica per ulteriori informazioni. |
marketingActionRefs |
Matrice che elenca gli URI di tutte le azioni di marketing applicabili al criterio. L’URI per un’azione di marketing viene fornito in _links.self.href nella risposta per ricerca di un’azione di marketing. |
description |
Una descrizione facoltativa che fornisce ulteriore contesto al caso d’uso del criterio. |
deny |
L'espressione di criterio che descrive le etichette di utilizzo dati specifiche per le azioni di marketing associate al criterio non viene eseguita. |
Risposta
Una risposta corretta restituisce i dettagli del criterio appena creato, incluso il relativo id
. Questo valore è di sola lettura e viene assegnato automaticamente alla creazione del criterio.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "OR",
"operands": [
{
"label": "C1"
},
{
"operator": "AND",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550691551888,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
È possibile aggiornare solo i criteri personalizzati. Per abilitare o disabilitare i criteri di base, consulta la sezione aggiornamento dell'elenco dei criteri di base abilitati.
Puoi aggiornare un criterio personalizzato esistente fornendo il relativo ID nel percorso di una richiesta di PUT con un payload che include la versione aggiornata del criterio nella sua interezza. In altre parole, la richiesta di PUT sostanzialmente riscrive il criterio.
Vedi la sezione su aggiornamento di una parte di un criterio personalizzato se si desidera aggiornare solo uno o più campi per un criterio, anziché sovrascriverlo.
Formato API
PUT /policies/custom/{POLICY_ID}
Parametro | Descrizione |
---|---|
{POLICY_ID} |
La id del criterio da aggiornare. |
Richiesta
In questo esempio, le condizioni per l’esportazione di dati in una terza parte sono cambiate e ora è necessario richiedere il criterio creato per negare questa azione di marketing se C1 AND C5
sono presenti etichette per i dati.
La richiesta seguente aggiorna il criterio esistente in modo da includere la nuova espressione di criterio. Tieni presente che, poiché questa richiesta essenzialmente riscrive il criterio, tutti i campi devono essere inclusi nel payload, anche se alcuni dei relativi valori non vengono aggiornati.
curl -X PUT \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"../marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{"label": "C1"},
{"label": "C5"}
]
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome visualizzato del criterio. |
status |
Stato corrente del criterio. Sono disponibili tre stati possibili: DRAFT , ENABLED oppure DISABLED . Per impostazione predefinita, solo ENABLED Le politiche partecipano alla valutazione. Vedi la panoramica su valutazione politica per ulteriori informazioni. |
marketingActionRefs |
Matrice che elenca gli URI di tutte le azioni di marketing applicabili al criterio. L’URI per un’azione di marketing viene fornito in _links.self.href nella risposta per ricerca di un’azione di marketing. |
description |
Una descrizione facoltativa che fornisce ulteriore contesto al caso d’uso del criterio. |
deny |
L'espressione di criterio che descrive le etichette di utilizzo dati specifiche per le azioni di marketing associate al criterio non viene eseguita. Vedi la sezione su creazione di un criterio per ulteriori informazioni su questa proprietà. |
Risposta
Una risposta corretta restituisce i dettagli del criterio aggiornato.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/core/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"label": "C5"
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550701472910,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
È possibile aggiornare solo i criteri personalizzati. Per abilitare o disabilitare i criteri di base, consulta la sezione aggiornamento dell'elenco dei criteri di base abilitati.
Una parte specifica di un criterio può essere aggiornata utilizzando una richiesta di PATCH. A differenza delle richieste PUT che riscrivono il criterio, le richieste PATCH aggiornano solo le proprietà specificate nel corpo della richiesta. Questa opzione è particolarmente utile quando desideri abilitare o disabilitare un criterio, in quanto devi fornire solo il percorso della proprietà appropriata (/status
) e il relativo valore (ENABLED
o DISABLED
).
I payload per le richieste PATCH seguono la formattazione della patch JSON. Consulta la sezione Guida di base sulle API per ulteriori informazioni sulla sintassi accettata.
La Policy Service API supporta le operazioni di patch JSON add
, remove
e replace
, e ti consente di combinare diversi aggiornamenti insieme in una singola chiamata, come mostrato nell’esempio di seguito.
Formato API
PATCH /policies/custom/{POLICY_ID}
Parametro | Descrizione |
---|---|
{POLICY_ID} |
La id del criterio di cui si desidera aggiornare le proprietà. |
Richiesta
La richiesta seguente utilizza due replace
operazioni per modificare lo stato del criterio da DRAFT
a ENABLED
e per aggiornare description
campo con una nuova descrizione.
Quando si inviano più operazioni PATCH in una singola richiesta, queste vengono elaborate nell’ordine in cui compaiono nell’array. Se necessario, assicurati di inviare le richieste nell’ordine corretto.
curl -X PATCH \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d ' [
{
"op": "replace",
"path": "/status",
"value": "ENABLED"
},
{
"op": "replace",
"path": "/description",
"value": "New policy description."
}
]'
Risposta
Una risposta corretta restituisce i dettagli del criterio aggiornato.
{
"name": "Export Data to Third Party",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "New policy description.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550712163182,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
È possibile eliminare un criterio personalizzato includendo i relativi id
nel percorso di una richiesta DELETE.
Una volta eliminate, le politiche non possono essere recuperate. Si consiglia di eseguire una richiesta di ricerca (GET) per visualizzare il criterio e confermare che si tratta del criterio corretto da rimuovere.
Formato API
DELETE /policies/custom/{POLICY_ID}
Parametro | Descrizione |
---|---|
{POLICY_ID} |
ID del criterio da eliminare. |
Richiesta
curl -X DELETE \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb56eb60ca13dbf8b9a8 \
-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}'
Risposta
Una risposta corretta restituisce lo stato HTTP 200 (OK) con un corpo vuoto.
Puoi confermare l’eliminazione tentando di cercare nuovamente (GET) il criterio. Se il criterio è stato eliminato correttamente, riceverai un errore HTTP 404 (Non trovato).
Per impostazione predefinita, solo i criteri di utilizzo dei dati abilitati partecipano alla valutazione. Puoi recuperare un elenco dei criteri di base attualmente abilitati dalla tua organizzazione effettuando una richiesta di GET al /enabledCorePolicies
punto finale.
Formato API
GET /enabledCorePolicies
Richiesta
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
-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}'
Risposta
Una risposta corretta restituisce l'elenco dei criteri di base abilitati in un policyIds
array.
{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0003",
"corepolicy_0004",
"corepolicy_0005",
"corepolicy_0006",
"corepolicy_0007",
"corepolicy_0008"
],
"imsOrg": "{ORG_ID}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}
Per impostazione predefinita, solo i criteri di utilizzo dei dati abilitati partecipano alla valutazione. Effettuando una richiesta PUT al /enabledCorePolicies
endpoint, puoi aggiornare l’elenco dei criteri di base abilitati per l’organizzazione utilizzando una singola chiamata .
Solo i criteri principali possono essere abilitati o disabilitati da questo endpoint. Per abilitare o disabilitare i criteri personalizzati, consulta la sezione aggiornamento di una parte di un criterio.
Formato API
PUT /enabledCorePolicies
Richiesta
La richiesta seguente aggiorna l’elenco dei criteri di base abilitati in base agli ID forniti nel payload.
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
-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}' \
-d '{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0007",
"corepolicy_0008"
]
}'
Proprietà | Descrizione |
---|---|
policyIds |
Elenco degli ID dei criteri di base da abilitare. I criteri di base non inclusi sono impostati su DISABLED status e non parteciperà alla valutazione. |
Risposta
Una risposta corretta restituisce l'elenco aggiornato dei criteri di base abilitati in un policyIds
array.
{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0007",
"corepolicy_0008"
],
"imsOrg": "{ORG_ID}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1595876052649,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}
Una volta definiti nuovi criteri o aggiornati quelli esistenti, puoi utilizzare Policy Service API per testare le azioni di marketing rispetto a specifiche etichette o set di dati e vedere se le tue politiche stanno generando violazioni come previsto. Consulta la guida endpoint per la valutazione delle politiche per ulteriori informazioni.