Skapa en datastyrningsprincip i API:t

Med API:t för principtjänsten kan du skapa och hantera datastyrningsprinciper för att avgöra vilka marknadsföringsåtgärder som kan vidtas mot data som innehåller vissa dataanvändningsetiketter.

Det här dokumentet innehåller en stegvis självstudiekurs för att skapa en styrningsprincip med hjälp av Policy Service-API:t.

Komma igång

Den här självstudiekursen kräver en fungerande förståelse av följande viktiga begrepp när du skapar och utvärderar policyer:

Innan du startar den här självstudiekursen bör du läsa igenom utvecklarhandboken för att få viktig information som du behöver känna till för att kunna ringa anrop till Policy Service-API:t, inklusive obligatoriska rubriker och hur du läser exempel-API-anrop.

Definiera en marknadsföringsåtgärd define-action

I ramverket för datastyrning är en marknadsföringsåtgärd en Experience Platform-datakonsument vidtar, och där måste man kontrollera om dataanvändningsprinciper har överträtts.

Det första steget i att skapa en dataanvändningspolicy är att avgöra vilken marknadsföringsåtgärd som principen ska utvärdera. Detta kan du göra med något av följande alternativ:

Slå upp en befintlig marknadsföringsåtgärd look-up

Du kan söka efter befintliga marknadsföringsåtgärder som ska utvärderas av din policy genom att göra en GET-förfrågan till någon av /marketingActions-slutpunkterna.

API-format

Beroende på om du letar upp en marknadsföringsåtgärd från Experience Platform eller en anpassad marknadsföringsåtgärd som har skapats av din organisation använder du slutpunkterna marketingActions/core respektive marketingActions/custom.

GET /marketingActions/core
GET /marketingActions/custom

Begäran

Följande begäran använder slutpunkten marketingActions/custom, som hämtar en lista över alla marknadsföringsåtgärder som definierats av din organisation.

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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar det totala antalet marknadsföringsåtgärder som hittats (count) och visar information om själva marknadsföringsåtgärderna i children -arrayen.

{
    "_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": "{ORG_ID}",
            "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": "{ORG_ID}",
            "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"
                }
            }
        }
    ]
}

När du hittar den marknadsföringsåtgärd som du vill använda ska du registrera värdet för dess href-egenskap. Det här värdet används under nästa steg i skapa en princip.

Skapa en ny marknadsföringsåtgärd create-new

Du kan skapa en ny marknadsföringsåtgärd genom att göra en PUT-begäran till slutpunkten /marketingActions/custom/ och ange ett namn för marknadsföringsåtgärden i slutet av begärandesökvägen.

API-format

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}

Begäran

Följande begäran skapar en ny anpassad marknadsföringsåtgärd som kallas"exportToThirdParty". Observera att name i nyttolasten för begäran är samma som namnet som anges i sökvägen för begäran.

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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "exportToThirdParty",
      "description": "Export data to a third party"
    }'

Svar

Ett lyckat svar returnerar HTTP-status 201 (Skapad) och information om den nyligen skapade marknadsföringsåtgärden.

{
    "name": "exportToThirdParty",
    "description": "Export data to a third party",
    "imsOrg": "{ORG_ID}",
    "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"
        }
    }
}

Registrera URI-ID:t för den nyligen skapade marknadsföringsåtgärden, så som det kommer att användas i nästa steg i skapandet av en profil.

Skapa en profil create-policy

Om du skapar en ny princip måste du tillhandahålla URI-ID:t för en marknadsföringsåtgärd med ett uttryck för användningsetiketterna som förbjuder den marknadsföringsåtgärden.

Det här uttrycket kallas ett principuttryck och är ett objekt som innehåller antingen (A) en etikett eller (B) en operator och operander, men inte båda. I sin tur är varje operand också ett principuttrycksobjekt. En princip för export av data till en tredje part kan till exempel vara förbjuden om det finns C1 OR (C3 AND C7)-etiketter. Detta uttryck skulle anges som:

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

När du har konfigurerat ditt principuttryck kan du skapa en ny princip genom att göra en POST-förfrågan till slutpunkten /policies/custom.

API-format

POST /policies/custom

Begäran

I följande begäran skapas en princip som heter"Exportera data till tredje part" genom att en marknadsföringsåtgärd och ett policyuttryck tillhandahålls i nyttolasten för begäran.

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": [
      "../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"}
          ]
        }
      ]
    }
  }'

Svar

Ett lyckat svar returnerar HTTP-status 201 (Skapad) och information om den nya principen.

{
    "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": "{ORG_ID}",
    "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"
}

Registrera URI-ID:t för den nyligen skapade principen så som den används i nästa steg för att aktivera principen.

Aktivera profilen

Som standard deltar inte principer som har egenskapen status inställd på DRAFT i utvärderingen. Du kan aktivera din princip för utvärdering genom att göra en PATCH-begäran till slutpunkten /policies/custom/ och ange den unika identifieraren för principen i slutet av begärandesökvägen.

API-format

PATCH /policies/custom/{POLICY_ID}

Begäran

Följande begäran utför en PATCH-åtgärd på egenskapen status för principen och ändrar dess värde från DRAFT till 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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
    {
      "op": "replace",
      "path": "/status",
      "value": "ENABLED"
    }
  ]'

Svar

Ett lyckat svar returnerar HTTP-status 200 (OK) och information om den uppdaterade principen, med status inställt på 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": "{ORG_ID}",
    "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"
}

Nästa steg

Genom att följa den här självstudiekursen har du skapat en dataanvändningspolicy för en marknadsföringsåtgärd. Du kan nu fortsätta med självstudiekursen framtvinga dataanvändningspolicyer för att lära dig hur du söker efter policyöverträdelser och hanterar dem i ditt upplevelseprogram.

Mer information om de olika tillgängliga åtgärderna i API:t Policy Service finns i Utvecklarhandbok för principtjänst. Mer information om hur du tillämpar principer för Real-Time Customer Profile-data finns i självstudiekursen framtvingar efterlevnad av dataanvändning för målgruppssegment.

Mer information om hur du hanterar användarprofiler i användargränssnittet för Experience Platform finns i användarhandboken för principen.