Creare un criterio di utilizzo dei dati nell’API

La API del servizio criteri consente di creare e gestire i criteri di utilizzo dei dati per determinare quali azioni di marketing possono essere intraprese rispetto ai dati che contengono determinate etichette di utilizzo dei dati.

Questo documento fornisce un'esercitazione dettagliata per la creazione di un criterio utilizzando Policy Service API. Per una guida più completa alle diverse operazioni disponibili nell’API, vedi Guida per gli sviluppatori di Policy Service.

Introduzione

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

  • Governance dei dati di Adobe Experience Platform: Il quadro Platform applica la conformità per l’utilizzo dei dati.
    • Etichette di utilizzo dati: Le etichette per l’utilizzo dei dati vengono applicate ai campi di dati XDM, specificando le restrizioni per l’accesso a tali dati.
  • Experience Data Model (XDM): Il quadro standardizzato Platform organizza i dati sulla customer experience.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono un singolo Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Prima di avviare questa esercitazione, controlla la guida per sviluppatori per informazioni importanti che devi conoscere al fine di effettuare correttamente le chiamate al Policy Service API, incluse le intestazioni richieste e come leggere le chiamate API di esempio.

Definire un’azione di marketing

Nel framework per la governance dei dati, un’azione di marketing è un’azione che Experience Platform prende i dati del consumatore, per i quali è 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 dei /marketingActions endpoint.

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 marketingActions/core o marketingActions/custom endpoint, rispettivamente.

GET /marketingActions/core
GET /marketingActions/custom

Richiesta

La richiesta seguente utilizza il marketingActions/custom endpoint , che recupera 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 della children array.

{
    "_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 della children contiene un ID URI per l’azione di marketing elencata.

Quando trovi l’azione di marketing da utilizzare, registra il valore della relativa href proprietà. 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 effettuando una richiesta di PUT al /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} Nome della nuova azione di marketing che desideri creare. Questo nome agisce come identificatore principale dell’azione di marketing e deve quindi essere univoco. Si consiglia di assegnare all’azione di marketing un nome descrittivo ma conciso.

Richiesta

La richiesta seguente crea una nuova azione di marketing personalizzata denominata "exportToThirdParty". Tieni presente che name nel payload della richiesta è lo stesso 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 che desideri creare. Questo nome deve corrispondere al nome fornito nel percorso della richiesta, altrimenti si verificherà un errore 400 (Richiesta non valida).
description Descrizione dell’azione di marketing leggibile dall’utente.

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, in modo che venga utilizzato nel passaggio successivo della creazione di un criterio.

Creare un criterio

La creazione di un nuovo criterio richiede di fornire l’ID URI di un’azione di marketing con un’espressione delle etichette di utilizzo che ne vietano l’azione di marketing.

Questa espressione è denominata espressione di criterio e è un oggetto contenente (A) un'etichetta o (B) un operatore e operandi, ma non entrambi. A sua volta, ogni operando è anche un oggetto espressione di criterio. Ad esempio, una politica relativa all’esportazione di dati verso terzi potrebbe essere vietata se C1 OR (C3 AND C7) le etichette sono presenti. 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, puoi creare un nuovo criterio effettuando una richiesta di POST al /policies/custom punto finale.

Formato API

POST /policies/custom

Richiesta

La seguente richiesta crea un criterio denominato "Esporta dati a terze parti" fornendo un’azione di marketing e un’espressione di policy 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 Una matrice contenente href valore di un’azione di marketing, ottenuta passaggio precedente. Anche se nell’esempio precedente è elencata una sola azione di marketing, è possibile fornire più azioni.
deny L'oggetto espressione policy. Definisce le etichette di utilizzo e le condizioni che causerebbero 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 modo che venga utilizzato nel passaggio successivo per abilitare il criterio.

Abilitare il criterio

NOTA

Anche se questo passaggio è facoltativo se desideri lasciare il criterio in DRAFT stato: per impostazione predefinita, lo stato di un criterio deve essere impostato su ENABLED per partecipare alla valutazione. Consulta la guida su applicazione delle norme per informazioni su come fare eccezioni per i criteri in DRAFT stato.

Per impostazione predefinita, i criteri con le relative status proprietà impostata su DRAFT non partecipare alla valutazione. Puoi abilitare il criterio per la valutazione effettuando una richiesta PATCH al /policies/custom/ e fornisce l'identificatore univoco per il criterio alla fine del percorso della richiesta.

Formato API

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

Richiesta

La seguente richiesta esegue un’operazione PATCH sul status proprietà del criterio, modifica del 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 il status su "ENABLED".

Risposta

Una risposta corretta restituisce lo stato HTTP 200 (OK) e i dettagli del criterio aggiornato, con i relativi status ora impostato 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 correttamente un criterio di utilizzo dei dati per un’azione di marketing. Ora puoi continuare l’esercitazione su applicazione dei criteri di utilizzo dei dati per scoprire come verificare le violazioni dei criteri e gestirle nell'applicazione di esperienza.

Per ulteriori informazioni sulle diverse operazioni disponibili nella Policy Service API, vedi Guida per gli sviluppatori di Policy Service. Per informazioni su come applicare i criteri per Real-time Customer Profile data, consulta l’esercitazione su applicazione della conformità in materia di utilizzo dei dati per i segmenti di pubblico.

Per scoprire come gestire i criteri di utilizzo in Experience Platform interfaccia utente, vedi guida utente di policy.

In questa pagina