Creare un criterio di utilizzo dei dati nell'API

Policy Service API consente di creare e gestire i criteri di utilizzo dei dati per determinare quali azioni di marketing possono essere eseguite rispetto ai dati che contengono determinate etichette di utilizzo dei dati.

Questo documento fornisce un'esercitazione dettagliata per la creazione di un criterio tramite l'API Policy Service. Per una guida più completa alle diverse operazioni disponibili nell'API, vedete la Guida per gli sviluppatori di Servizi criteri.

Introduzione

Questa esercitazione richiede una conoscenza approfondita dei seguenti concetti chiave relativi alla creazione e alla valutazione dei criteri:

  • Governance dei dati Adobe Experience Platform: Il framework in base al quale Platform viene applicata la conformità all'utilizzo dei dati.
    • Etichette di utilizzo dati: Le etichette di utilizzo dei dati vengono applicate ai campi di dati XDM, specificando le restrizioni relative alle modalità di accesso ai dati.
  • Experience Data Model (XDM): Il framework standard con cui Platform organizzare i dati relativi all'esperienza dei clienti.
  • Sandbox: Experience Platform fornisce sandbox virtuali che dividono una singola Platform istanza in ambienti virtuali separati per sviluppare e sviluppare applicazioni per esperienze digitali.

Prima di avviare questa esercitazione, consultare la guida allo sviluppo per informazioni importanti che è necessario conoscere per effettuare correttamente chiamate all'API Policy Service, incluse le intestazioni richieste e come leggere le chiamate API di esempio.

Definire un'azione di marketing

Nel framework Data Governance, un'azione di marketing è un'azione eseguita da un consumatore di dati Experience Platform per la quale è necessario verificare la presenza di violazioni dei criteri di utilizzo dei dati.

Il primo passaggio nella creazione di un criterio di utilizzo dei dati consiste nel determinare quale azione di marketing verrà valutata dal criterio. Questa operazione può essere eseguita utilizzando una delle seguenti opzioni:

Cerca un'azione di marketing esistente

Puoi cercare le azioni di marketing esistenti da valutare in base al criterio effettuando una richiesta di GET a uno degli endpoint /marketingActions.

Formato API

A seconda che tu stia cercando un'azione di marketing fornita da Experience Platform o un'azione di marketing personalizzata creata dalla tua organizzazione, utilizza rispettivamente gli endpoint marketingActions/core o marketingActions/custom.

GET /marketingActions/core
GET /marketingActions/custom

Richiesta

La richiesta seguente utilizza l'endpoint marketingActions/custom, che raccoglie un elenco di tutte le azioni di marketing definite dall'organizzazione IMS.

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom \
  -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 restituisce il numero totale di azioni di marketing trovate (count) ed elenca i dettagli delle azioni di marketing stesse all'interno dell'array children.

{
    "_page": {
        "start": "sampleMarketingAction",
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io/marketingActions/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "sampleMarketingAction",
            "description": "Marketing Action description.",
            "imsOrg": "{IMS_ORG}",
            "created": 1550714012088,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER}",
            "updated": 1550714012088,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/sampleMarketingAction"
                }
            }
        },
        {
            "name": "newMarketingAction",
            "description": "Another marketing action.",
            "imsOrg": "{IMS_ORG}",
            "created": 1550793833224,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER}",
            "updated": 1550793833224,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/newMarketingAction"
                }
            }
        }
    ]
}
Proprietà Descrizione
_links.self.href Ogni elemento all'interno dell'array children contiene un ID URI per l'azione di marketing elencata.

Quando trovi l'azione di marketing da utilizzare, registra il valore della relativa proprietà href. Questo valore viene utilizzato durante il passaggio successivo di creazione di un criterio.

Crea una nuova azione di marketing

Puoi creare una nuova azione di marketing eseguendo una richiesta PUT all'endpoint /marketingActions/custom/ e fornendo un nome per l'azione di marketing alla fine del percorso della richiesta.

Formato API

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}
Parametro Descrizione
{MARKETING_ACTION_NAME} Il nome della nuova azione di marketing da creare. Questo nome funge da identificatore principale dell'azione di marketing e deve pertanto essere univoco. La best practice consiste nel assegnare all’azione di marketing un nome descrittivo ma conciso.

Richiesta

La richiesta seguente crea una nuova azione di marketing personalizzata denominata "exportToThirdParty". Tenere presente che il name nel payload della richiesta è uguale al nome fornito nel percorso della richiesta.

curl -X PUT \  
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty \
  -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 '{
      "name": "exportToThirdParty",
      "description": "Export data to a third party"
    }'
Proprietà Descrizione
name Nome dell’azione di marketing da creare. Questo nome deve corrispondere al nome fornito nel percorso della richiesta, altrimenti si verificherà un errore 400 (Richiesta non valida).
description Una descrizione leggibile dell'azione di marketing.

Risposta

Una risposta corretta restituisce lo stato HTTP 201 (Creato) e i dettagli dell’azione di marketing appena creata.

{
    "name": "exportToThirdParty",
    "description": "Export data to a third party",
    "imsOrg": "{IMS_ORG}",
    "created": 1550713341915,
    "createdClient": "{CREATED_CLIENT}",
    "createdUser": "{CREATED_USER",
    "updated": 1550713856390,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
        }
    }
}
Proprietà Descrizione
_links.self.href ID URI dell’azione di marketing.

Registra l'ID URI dell'azione di marketing appena creata, che verrà utilizzata nella fase successiva della creazione di un criterio.

Creare un criterio

Per creare un nuovo criterio è necessario fornire l'ID URI di un'azione di marketing con un'espressione delle etichette di utilizzo che ne impediscono l'esecuzione.

Questa espressione è denominata espressione policy ed è un oggetto contenente (A) un'etichetta, (B) un operatore e gli operandi, ma non entrambi. A sua volta, ogni operando è anche un oggetto con espressione di criterio. Ad esempio, un criterio relativo all'esportazione di dati a terzi potrebbe essere vietato se sono presenti etichette C1 OR (C3 AND C7). Questa espressione viene specificata come:

"deny": {
  "operator": "OR",
  "operands": [
    {
      "label": "C1"
    },
    {
      "operator": "AND",
      "operands": [
        {
          "label": "C3"
        },
        {
          "label": "C7"
        }
      ]
    }
  ]
}
NOTA

Sono supportati solo gli operatori OR e AND.

Dopo aver configurato l'espressione del criterio, potete creare un nuovo criterio effettuando una richiesta POST all'endpoint /policies/custom.

Formato API

POST /policies/custom

Richiesta

La richiesta seguente crea un criterio denominato "Esporta dati a terze parti" fornendo un'azione di marketing e un'espressione di criterio nel payload della richiesta.

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: {IMS_ORG}' \
  -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": "OR",
      "operands": [
        {"label": "C1"},
        {
          "operator": "AND",
          "operands": [
            {"label": "C3"},
            {"label": "C7"}
          ]
        }
      ]
    }
  }'
Proprietà Descrizione
marketingActionRefs Un array contenente il valore href di un'azione di marketing, ottenuto nel passaggio precedente. Anche se l'esempio precedente elenca una sola azione di marketing, è possibile fornire più azioni.
deny L'oggetto policy espressione. Definisce le etichette e le condizioni di utilizzo che potrebbero causare il rifiuto dell'azione di marketing a cui si fa riferimento in marketingActionRefs.

Risposta

Una risposta corretta restituisce lo stato HTTP 201 (Creato) e i dettagli del criterio appena creato.

{
    "name": "Export Data to Third Party",
    "status": "DRAFT",
    "marketingActionRefs": [
        "https://platform-stage.adobe.io:443/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": "{IMS_ORG}",
    "created": 1565651746693,
    "createdClient": "{CREATED_CLIENT}",
    "createdUser": "{CREATED_USER",
    "updated": 1565651746693,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform-stage.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3"
        }
    },
    "id": "5d51f322e553c814e67af1a3"
}
Proprietà Descrizione
id Valore generato dal sistema di sola lettura che identifica il criterio in modo univoco.

Registra l'ID URI del criterio appena creato, in quanto viene utilizzato nel passaggio successivo per abilitare il criterio.

Abilitare il criterio

NOTA

Anche se questo passaggio è facoltativo se desiderate lasciare il criterio in stato DRAFT, tenete presente che per impostazione predefinita il criterio deve avere lo stato impostato su ENABLED per poter partecipare alla valutazione. Per informazioni su come fare eccezioni per i criteri nello stato DRAFT, vedere la guida relativa all'applicazione dei criteri .

Per impostazione predefinita, i criteri con la proprietà status impostata su DRAFT non partecipano alla valutazione. Potete abilitare il criterio per la valutazione eseguendo una richiesta di PATCH all'endpoint /policies/custom/ e fornendo l'identificatore univoco per il criterio alla fine del percorso della richiesta.

Formato API

PATCH /policies/custom/{POLICY_ID}
Parametro Descrizione
{POLICY_ID} Il valore id del criterio che si desidera abilitare.

Richiesta

La richiesta seguente esegue un'operazione PATCH sulla proprietà status del criterio, modificando il valore da DRAFT a ENABLED.

curl -X PATCH \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3
  -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 '[
    {
      "op": "replace",
      "path": "/status",
      "value": "ENABLED"
    }
  ]'
Proprietà Descrizione
op Tipo di operazione PATCH da eseguire. Questa richiesta esegue un'operazione di sostituzione.
path Percorso del campo da aggiornare. Quando si abilita un criterio, il valore deve essere impostato su "/status".
value Il nuovo valore da assegnare alla proprietà specificata in path. Questa richiesta imposta la proprietà status del criterio su "ENABLED".

Risposta

Una risposta di successo restituisce lo stato HTTP 200 (OK) e i dettagli del criterio aggiornato, con la status ora impostata su ENABLED.

{
    "name": "Export Data to Third Party",
    "status": "ENABLED",
    "marketingActionRefs": [
        "https://platform-stage.adobe.io:443/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": "{IMS_ORG}",
    "created": 1565651746693,
    "createdClient": "{CREATED_CLIENT}",
    "createdUser": "{CREATED_USER}",
    "updated": 1565723012139,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform-stage.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3"
        }
    },
    "id": "5d51f322e553c814e67af1a3"
}

Passaggi successivi

Seguendo questa esercitazione hai creato con successo un criterio di utilizzo dei dati per un'azione di marketing. È ora possibile continuare l'esercitazione su imposizione dei criteri di utilizzo dei dati per apprendere come verificare la presenza di violazioni dei criteri e gestirle nell'applicazione di esperienza.

Per ulteriori informazioni sulle diverse operazioni disponibili nell'API Policy Service, vedere la Guida per gli sviluppatori di servizi di policy. Per informazioni su come applicare criteri per i dati Real-time Customer Profile, consulta l'esercitazione su come applicare la conformità all'utilizzo dei dati per i segmenti di pubblico.

Per informazioni su come gestire i criteri di utilizzo nell'interfaccia utente Experience Platform, vedere la guida utente dei criteri.

In questa pagina