Finalità della valutazione politica
Una volta create le azioni di marketing e definite le policy, puoi utilizzare l'API Policy Service per valutare se alcune azioni violano i criteri. I vincoli restituiti assumono la forma di un insieme di criteri che verrebbero violati tentando di eseguire un'azione di marketing sui dati specificati contenenti etichette di utilizzo dei dati.
Per impostazione predefinita, solo i criteri il cui stato è impostato su ENABLED partecipano alla valutazione. Tuttavia, potete utilizzare il parametro di query ?includeDraft=true per includere i criteri DRAFT nella valutazione.
Le richieste di valutazione possono essere effettuate in uno dei tre modi seguenti:
- Considerate un'azione di marketing e un insieme di etichette di utilizzo dei dati, l'azione viola eventuali criteri?
- Data un'azione di marketing e uno o più set di dati, l'azione viola eventuali criteri?
- Considerata un'azione di marketing, uno o più set di dati e un sottoinsieme di uno o più campi all'interno di ciascuno di tali set di dati, l'azione viola eventuali criteri?
Introduzione
Gli endpoint API utilizzati in questa guida fanno parte dell' Policy Service API. Prima di continuare, consultare la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio in questo documento e informazioni importanti sulle intestazioni necessarie per eseguire correttamente chiamate a qualsiasi API Experience Platform.
Valutazione delle violazioni dei criteri utilizzando le etichette di utilizzo dei dati
È possibile valutare le violazioni dei criteri in base alla presenza di un set specifico di etichette di utilizzo dei dati utilizzando il parametro di query duleLabels in una richiesta di GET.
Formato API
GET /marketingActions/core/{MARKETING_ACTION_NAME}/constraints?duleLabels={LABELS_LIST}
GET /marketingActions/custom/{MARKETING_ACTION_NAME}/constraints?duleLabels={LABELS_LIST}
| Parametro | Descrizione |
|---|---|
{MARKETING_ACTION_NAME} |
Il nome dell'azione di marketing da sottoporre a test rispetto a un set di etichette di utilizzo dei dati. Puoi recuperare un elenco delle azioni di marketing disponibili effettuando una richiesta di GET all'endpoint delle azioni di marketing. |
{LABELS_LIST} |
Un elenco separato da virgole di nomi di etichette di utilizzo dei dati con cui verificare l'azione di marketing. Ad esempio: duleLabels=C1,C2,C3I nomi delle etichette sono sensibili alle maiuscole/minuscole. Accertatevi di utilizzare le maiuscole/minuscole corrette quando elencate nel parametro duleLabels. |
Richiesta
La richiesta di esempio riportata di seguito valuta un'azione di marketing rispetto alle etichette C1 e C3.
Nelle espressioni dei criteri, è importante conoscere gli operatori AND e OR. Nell'esempio seguente, se nella richiesta fosse stata visualizzata l'etichetta (C1 o C3) da sola, l'azione di marketing non avrebbe violato questo criterio. Sono necessarie entrambe le etichette (C1 e C3) per restituire il criterio violato. Assicurati di valutare attentamente i criteri e di definirne le espressioni con la stessa attenzione.
curl -X GET \
'https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/sampleMarketingAction/constraints?duleLabels=C1,C3' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
Una risposta corretta include un array violatedPolicies che contiene i dettagli dei criteri violati a seguito dell'esecuzione dell'azione di marketing sulle etichette fornite. Se non vengono violati i criteri, l'array violatedPolicies sarà vuoto.
{
"timestamp": 1551134846737,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"marketingActionRef": "https://platform.adobe.io/marketingActions/custom/sampleMarketingAction",
"duleLabels": [
"C1",
"C3"
],
"violatedPolicies": [
{
"name": "Export Data to Third Party",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/sampleMarketingAction"
],
"description": "NEW content for description.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"created": 1550703519823,
"createdClient": "{CREATED_CLIENT}",
"createdUser": "{CREATED_USER}",
"updated": 1550714340335,
"updatedClient": "{UPDATED_CLIENT}",
"updatedUser": "{UPDATED_USER}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb9f5c404513dc2dc454"
}
},
"id": "5c6ddb9f5c404513dc2dc454"
}
]
}
Valutazione delle violazioni dei criteri tramite set di dati
È possibile valutare le violazioni dei criteri in base a un set di uno o più set di dati da cui è possibile raccogliere le etichette di utilizzo dei dati. A questo scopo, esegui una richiesta di POST all'endpoint /constraints per una specifica azione di marketing e fornisci un elenco di ID di set di dati all'interno del corpo della richiesta.
Formato API
POST /marketingActions/core/{MARKETING_ACTION_NAME}/constraints
POST /marketingActions/custom/{MARKETING_ACTION_NAME}/constraints
| Parametro | Descrizione |
|---|---|
{MARKETING_ACTION_NAME} |
Il nome dell'azione di marketing da sottoporre a test in base a uno o più set di dati. Puoi recuperare un elenco delle azioni di marketing disponibili effettuando una richiesta di GET all'endpoint delle azioni di marketing. |
Richiesta
La seguente richiesta esegue l'azione di marketing crossSiteTargeting in base a un insieme di tre set di dati per valutare eventuali violazioni dei criteri.
curl -X POST \
https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting/constraints \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '[
{
"entityType": "dataSet",
"entityId": "5c423dc25f2f2e00005e2319"
},
{
"entityType": "dataSet",
"entityId": "5cc323e15410ef14b749481e"
},
{
"entityType": "dataSet",
"entityId": "5cc1fb685410ef14b748c55f"
}
]'
| Proprietà | Descrizione |
|---|---|
entityType |
Il tipo di entità il cui ID è indicato nella proprietà di pari livello entityId. Attualmente, l'unico valore accettato è dataSet. |
entityId |
ID di un set di dati con cui sottoporre a test l'azione di marketing. È possibile ottenere un elenco di set di dati e dei relativi ID effettuando una richiesta di GET all'endpoint /dataSets nell'API Catalog Service. Per ulteriori informazioni, vedere la guida sull' elenco Catalog oggetti. |
Risposta
Una risposta corretta include un array violatedPolicies che contiene i dettagli dei criteri violati a seguito dell'esecuzione dell'azione di marketing rispetto ai set di dati forniti. Se non vengono violati i criteri, l'array violatedPolicies sarà vuoto.
{
"timestamp": 1556324277895,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting",
"duleLabels": [
"C1",
"C2",
"C4",
"C5",
"C6"
],
"discoveredLabels": [
{
"entityType": "dataSet",
"entityId": "5c423dc25f2f2e00005e2319",
"dataSetLabels": {
"connection": {
"labels": []
},
"dataSet": {
"labels": [
"C6"
]
},
"fields": [
{
"labels": [
"C2",
"C5"
],
"path": "/properties/_customer"
},
{
"labels": [
"C4",
"C5"
],
"path": "/properties/geoUnit"
},
{
"labels": [
"C4"
],
"path": "/properties/identityMap"
},
{
"labels": [
"C4"
],
"path": "/properties/journeyAI"
},
{
"labels": [
"C5"
],
"path": "/properties/createdByBatchID"
},
{
"labels": [
"C5"
],
"path": "/properties/faxPhone"
}
]
}
},
{
"entityType": "dataSet",
"entityId": "5cc323e15410ef14b749481e",
"dataSetLabels": {
"connection": {
"labels": []
},
"dataSet": {
"labels": [
"C5"
]
},
"fields": [
{
"labels": [
"C2",
],
"path": "/properties/_customer"
},
{
"labels": [
"C5"
],
"path": "/properties/geoUnit"
},
{
"labels": [
"C1"
],
"path": "/properties/identityMap"
}
]
}
},
{
"entityType": "dataSet",
"entityId": "5cc1fb685410ef14b748c55f",
"dataSetLabels": {
"connection": {
"labels": []
},
"dataSet": {
"labels": [
"C5"
]
},
"fields": [
{
"labels": [
"C5"
],
"path": "/properties/createdByBatchID"
},
{
"labels": [
"C5"
],
"path": "/properties/faxPhone"
}
]
}
}
],
"violatedPolicies": [
{
"name": "Targeting Ads or Content",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting"
],
"description": "Data cannot be used for targeting any ads or content, either on-site or cross-site.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C4"
},
{
"label": "C6"
}
]
},
"imsOrg": "{IMS_ORG}",
"created": 1551141210463,
"createdClient": "{CREATED_CLIENT}",
"createdUser": "{CREATED_USER}",
"updated": 1551146178603,
"updatedClient": "{UPDATED_CLIENT}",
"updatedUser": "{UPDATED_USER}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/custom/5c74895a74744d13dc2d87cc"
}
},
"id": "5c74895a74744d13dc2d87cc"
}
]
}
| Proprietà | Descrizione |
|---|---|
duleLabels |
L'oggetto response include un array duleLabels che contiene un elenco consolidato di tutte le etichette trovate all'interno dei set di dati specificati. Questo elenco include etichette a livello di set di dati e di campi su tutti i campi all'interno del set di dati. |
discoveredLabels |
La risposta include anche un array discoveredLabels contenente oggetti per ogni dataset, che mostra datasetLabels suddivisi in etichette a livello di set di dati e di campo. Ogni etichetta a livello di campo mostra il percorso del campo specifico con tale etichetta. |
Valutazione delle violazioni dei criteri utilizzando campi dataset specifici
È possibile valutare le violazioni dei criteri in base a un sottoinsieme di campi all'interno di uno o più set di dati, in modo che vengano valutate solo le etichette di utilizzo dei dati applicate a tali campi.
Quando si valutano i criteri utilizzando i campi dataset, tenere presente quanto segue:
- I nomi dei campi sono con distinzione tra maiuscole e minuscole: Quando forniscono i campi, devono essere scritti esattamente come appaiono nel set di dati (ad esempio,
firstNamevsfirstname). - Ereditarietà dell'etichetta del set di dati: I singoli campi di un set di dati ereditano tutte le etichette applicate a livello di set di dati. Se le valutazioni dei criteri non restituiscono come previsto, verificare la presenza di eventuali etichette che potrebbero essere state ereditate dal livello del set di dati fino ai campi, oltre a quelli applicati a livello di campo.
Formato API
POST /marketingActions/core/{MARKETING_ACTION_NAME}/constraints
POST /marketingActions/custom/{MARKETING_ACTION_NAME}/constraints
| Parametro | Descrizione |
|---|---|
{MARKETING_ACTION_NAME} |
Il nome dell'azione di marketing da sottoporre a test rispetto a un sottoinsieme di campi di set di dati. Puoi recuperare un elenco delle azioni di marketing disponibili effettuando una richiesta di GET all'endpoint delle azioni di marketing. |
Richiesta
La richiesta seguente esegue il test dell'azione di marketing crossSiteTargeting su un set specifico di campi appartenenti a tre set di dati. Il payload è simile a una richiesta di valutazione che interessa solo i dataset, aggiungendo campi specifici per ogni dataset da cui raccogliere le etichette.
curl -X POST \
https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting/constraints \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '[
{
"entityType": "dataSet",
"entityId": "5c423dc25f2f2e00005e2319",
"entityMeta": {
"fields": [
"/properties/_customer",
"/properties/faxPhone"
]
}
},
{
"entityType": "dataSet",
"entityId": "5cc323e15410ef14b749481e",
"entityMeta": {
"fields": [
"/properties/_customer",
"/properties/geoUnit"
]
}
},
{
"entityType": "dataSet",
"entityId": "5cc1fb685410ef14b748c55f",
"entityMeta": {
"fields": [
"/properties/faxPhone"
]
}
}
]'
| Proprietà | Descrizione |
|---|---|
entityType |
Il tipo di entità il cui ID è indicato nella proprietà di pari livello entityId. Attualmente, l'unico valore accettato è dataSet. |
entityId |
ID di un set di dati i cui campi devono essere valutati in base all'azione di marketing. È possibile ottenere un elenco di set di dati e dei relativi ID effettuando una richiesta di GET all'endpoint /dataSets nell'API Catalog Service. Per ulteriori informazioni, vedere la guida sull' elenco Catalog oggetti. |
entityMeta.fields |
Un array di percorsi per campi specifici all'interno dello schema del set di dati, fornito sotto forma di stringhe JSON Pointer. Per informazioni dettagliate sulla sintassi accettata per queste stringhe, vedere la sezione relativa al puntatore JSON nella guida API di base. |
Risposta
Una risposta corretta include un array violatedPolicies che contiene i dettagli dei criteri violati a seguito dell'esecuzione dell'azione di marketing nei campi del set di dati forniti. Se non vengono violati i criteri, l'array violatedPolicies sarà vuoto.
Confrontando la risposta di esempio riportata di seguito con la risposta che interessa solo i set di dati, si noti che l'elenco delle etichette raccolte è più breve. Sono stati ridotti anche i discoveredLabels per ogni set di dati, in quanto includono solo i campi specificati nel corpo della richiesta. Inoltre, il criterio precedentemente violato Targeting Ads or Content richiede la presenza di entrambe le etichette C4 AND C6 e pertanto non viene più violato come indicato dalla matrice vuota violatedPolicies.
{
"timestamp": 1556325503038,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting",
"duleLabels": [
"C2",
"C5",
"C6"
],
"discoveredLabels": [
{
"entityType": "dataSet",
"entityId": "5c423dc25f2f2e00005e2319",
"dataSetLabels": {
"connection": {
"labels": []
},
"dataSet": {
"labels": [
"C6"
]
},
"fields": [
{
"labels": [
"C2",
"C5"
],
"path": "/properties/_customer"
},
{
"labels": [
"C5"
],
"path": "/properties/faxPhone"
}
]
}
},
{
"entityType": "dataSet",
"entityId": "5cc323e15410ef14b749481e",
"dataSetLabels": {
"connection": {
"labels": []
},
"dataSet": {
"labels": [
"C5"
]
},
"fields": [
{
"labels": [
"C2",
"C5"
],
"path": "/properties/_customer"
},
{
"labels": [
"C5"
],
"path": "/properties/geoUnit"
}
]
}
},
{
"entityType": "dataSet",
"entityId": "5cc1fb685410ef14b748c55f",
"dataSetLabels": {
"connection": {
"labels": []
},
"dataSet": {
"labels": [
"C5"
]
},
"fields": [
{
"labels": [
"C5"
],
"path": "/properties/faxPhone"
}
]
}
}
],
"violatedPolicies": []
}
Valutazione dei criteri in blocco
L'endpoint /bulk-eval consente di eseguire più processi di valutazione in una singola chiamata API.
Formato API
POST /bulk-eval
Richiesta
Il payload di una richiesta di valutazione di massa deve essere un array di oggetti; uno per ogni processo di valutazione da eseguire. Per i processi che valutano in base a insiemi di dati e campi, è necessario fornire un array entityList. Per i processi che valutano in base alle etichette di utilizzo dei dati, è necessario fornire un array labels.
Se un processo di valutazione elencato contiene sia un array entityList che un array labels, si verificherà un errore. Se desideri valutare la stessa azione di marketing in base a set di dati ed etichette, devi includere processi di valutazione separati per tale azione di marketing.
curl -X POST \
https://platform.adobe.io/data/foundation/dulepolicy/bulk-eval \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '[
{
"evalRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting/constraints",
"includeDraft": false,
"labels": [
"C1",
"C2",
"C3"
]
},
{
"evalRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting/constraints",
"includeDraft": false,
"entityList": [
{
"entityType": "dataSet",
"entityId": "5b67f4dd9f6e710000ea9da4",
"entityMeta": {
"fields": [
"address"
]
}
}
]
}
]'
| Proprietà | Descrizione |
|---|---|
evalRef |
URI dell'azione di marketing da sottoporre a test per etichette o set di dati per violazioni dei criteri. |
includeDraft |
Per impostazione predefinita, solo i criteri abilitati partecipano alla valutazione. Se includeDraft è impostato su true, parteciperanno anche i criteri che si trovano nello stato DRAFT. |
labels |
Un array di etichette di utilizzo dei dati con cui sottoporre a test l'azione di marketing. IMPORTANTE: Quando si utilizza questa proprietà, NON è necessario includere una entityList proprietà nello stesso oggetto. Per valutare la stessa azione di marketing utilizzando insiemi di dati e/o campi, è necessario includere un oggetto separato nel payload della richiesta che contenga un array entityList. |
entityList |
Un array di set di dati e (facoltativamente) campi specifici all'interno di tali set di dati per sottoporre a test l'azione di marketing. IMPORTANTE: Quando si utilizza questa proprietà, NON è necessario includere una labels proprietà nello stesso oggetto. Per valutare la stessa azione di marketing utilizzando etichette di utilizzo dati specifiche, è necessario includere un oggetto separato nel payload di richiesta che contenga un array labels. |
entityType |
Il tipo di entità con cui sottoporre a test l'azione di marketing. Attualmente, è supportato solo dataSet. |
entityId |
ID di un set di dati con cui sottoporre a test l'azione di marketing. |
entityMeta.fields |
(Facoltativo) Un elenco di campi specifici all'interno del dataset per verificare l'azione di marketing rispetto a. |
Risposta
Una risposta di successo restituisce un array di risultati di valutazione; uno per ogni processo di valutazione dei criteri inviato nella richiesta.
[
{
"status": 200,
"body": {
"timestamp": 1595866566165,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting",
"duleLabels": [
"C1",
"C2",
"C3"
],
"violatedPolicies": []
}
},
{
"status": 200,
"body": {
"timestamp": 1595866566165,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting",
"duleLabels": [
"C1",
"C2"
],
"discoveredLabels": [
{
"entityType": "dataset",
"entityId": "5b67f4dd9f6e710000ea9da4",
"dataSetLabels": {
"connection": {
"labels": [
]
},
"dataset": {
"labels": [
"C1",
"C2"
]
},
"fields": []
}
}
],
"violatedPolicies": [
{
"name": "Email Policy",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {
"label": "C1",
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"label": "C3"
}
]
},
"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"imsOrg": "{IMS_ORG}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "./76131228-7654-11e8-adc0-fa7ae01bbebc"
}
}
}
]
}
}
]
Valutazione criteri per Real-time Customer Profile
L'API Policy Service può essere utilizzata anche per verificare la presenza di violazioni dei criteri che implicano l'uso di segmenti Real-time Customer Profile. Per ulteriori informazioni, consulta l'esercitazione su imposizione della conformità per l'utilizzo dei dati per i segmenti di pubblico.
Risorse su adobe.com
In questa pagina
