Documentatie Experience Platform Gids voor Segmentation Service

Compatibiliteit met gegevensgebruik afdwingen voor een segmentdefinitie met behulp van API's

Last update: Wed May 29 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Segments

Gemaakt voor:

User

Deze zelfstudie behandelt de stappen voor het afdwingen van de naleving van gegevensgebruik voor segmentdefinities die API's gebruiken.

Aan de slag

Deze zelfstudie vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:

Real-Time Customer Profile: Real-Time Customer Profile is een generische opslag van de raadplegingsentiteit, en wordt gebruikt om te beheren Experience Data Model (XDM) gegevens binnen Platform. Het profiel voegt gegevens over diverse activa van ondernemingsgegevens samen en verleent toegang tot die gegevens in een verenigde presentatie.
- Beleid samenvoegen: Regels gebruikt door Real-Time Customer Profile om te bepalen welke gegevens onder bepaalde omstandigheden in één weergave kunnen worden samengevoegd. Het beleid van de fusie kan voor de doeleinden van het Beleid van Gegevens worden gevormd.
Segmentation: Hoe Real-Time Customer Profile verdeelt een grote groep individuen in de opslag van het Profiel in kleinere groepen die gelijkaardige eigenschappen delen en op gelijkaardige wijze aan marketing strategieën zullen antwoorden.
Gegevensbeheer: Gegevensbeheer biedt de infrastructuur voor de etikettering en handhaving van gegevensgebruik, met behulp van de volgende componenten:
- Labels voor gegevensgebruik: Etiketten die worden gebruikt om gegevenssets en velden te beschrijven in termen van het gevoeligheidsniveau waarmee hun respectieve gegevens worden verwerkt.
- Beleid voor gegevensgebruik: Configuraties die aangeven welke marketingacties zijn toegestaan voor gegevens die zijn gecategoriseerd door bepaalde labels voor gegevensgebruik.
- Beleidshandhaving: Hiermee kunt u beleid voor gegevensgebruik afdwingen en gegevensbewerkingen die beleidsovertredingen vormen, voorkomen.
Sandboxen: Experience Platform biedt virtuele sandboxen die één enkele partitie maken Platform in afzonderlijke virtuele omgevingen om toepassingen voor digitale ervaringen te ontwikkelen en te ontwikkelen.

De volgende secties verstrekken extra informatie die u zult moeten weten om met succes vraag aan te maken Platform API's.

API-voorbeeldaanroepen lezen

Deze zelfstudie biedt voorbeeld-API-aanroepen om aan te tonen hoe uw verzoeken moeten worden opgemaakt. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de conventies die worden gebruikt in documentatie voor voorbeeld-API-aanroepen raadpleegt u de sectie over voorbeeld-API-aanroepen lezen in de Experience Platform gids voor probleemoplossing.

Waarden verzamelen voor vereiste koppen

Om vraag te maken aan Platform API's, moet u eerst de verificatiezelfstudie. Het voltooien van de zelfstudie over verificatie biedt de waarden voor elk van de vereiste kopteksten in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:

Toestemming: houder {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Alle verzoeken aan Platform API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:

x-sandbox-name: {SANDBOX_NAME}

NOTE

Voor meer informatie over sandboxen in Platform, zie de overzichtsdocumentatie van sandbox.

Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra kopbal:

Inhoudstype: application/json

Een samenvoegingsbeleid voor een segmentdefinitie opzoeken merge-policy

Dit werkschema begint door tot een bekende segmentdefinitie toegang te hebben. Segmentdefinities die zijn ingeschakeld voor gebruik in Real-Time Customer Profile bevatten een identiteitskaart van het fusiebeleid binnen hun segmentdefinitie. Dit samenvoegbeleid bevat informatie over welke datasets in de segmentdefinitie moeten worden omvat, die beurtelings om het even welke toepasselijke etiketten van het gegevensgebruik bevatten.

Met de Segmentation API, kunt u omhoog een segmentdefinitie door zijn identiteitskaart kijken om zijn bijbehorend fusiebeleid te vinden.

API-indeling

GET /segment/definitions/{SEGMENT_DEFINITION_ID}

Eigenschap

Beschrijving

{SEGMENT_DEFINITION_ID}

De id van de segmentdefinitie die u wilt opzoeken.

Verzoek

curl -X GET \
  https://platform.adobe.io/data/core/ups/segment/definitions/24379cae-726a-4987-b7b9-79c32cddb5c1 \
  -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}'

Antwoord

Een succesvolle reactie keert de details van de segmentdefinitie terug.

{
    "id": "24379cae-726a-4987-b7b9-79c32cddb5c1",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 90,
    "imsOrgId": "{ORG_ID}",
    "name": "Cart abandons in CA",
    "description": "",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "homeAddress.countryISO = 'US'"
    },
    "mergePolicyId": "2b43d78d-0ad4-4c1e-ac2d-574c09b01119",
    "evaluationInfo": {
        "batch": {
            "enabled": true
        },
        "continuous": {
            "enabled": false
        },
        "synchronous": {
            "enabled": false
        }
    },
    "creationTime": 1556094486000,
    "updateEpoch": 1556094486000,
    "updateTime": 1556094486000
  }
}

Eigenschap

Beschrijving

mergePolicyId

De id van het samenvoegbeleid dat voor de segmentdefinitie wordt gebruikt. Dit wordt in de volgende stap gebruikt.

Vind de brondatasets van het fusiebeleid datasets

Het beleid van de fusie bevat informatie over hun brondatasets, die beurtelings de etiketten van het gegevensgebruik bevatten. U kunt de details van een fusiebeleid opzoeken door identiteitskaart van het fusiebeleid in een verzoek van de GET aan te verstrekken Profile API. Meer informatie over het samenvoegbeleid vindt u in het gedeelte eindhulplijn voor samenvoegbeleid.

API-indeling

GET /config/mergePolicies/{MERGE_POLICY_ID}

Eigenschap

Beschrijving

{MERGE_POLICY_ID}

De id van het samenvoegbeleid dat in het dialoogvenster vorige stap.

Verzoek

curl -X GET \
  https://platform.adobe.io/data/core/ups/config/mergePolicies/2b43d78d-0ad4-4c1e-ac2d-574c09b01119 \
  -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}'

Antwoord

Een succesvolle reactie retourneert de details van het samenvoegingsbeleid.

{
    "id": "2b43d78d-0ad4-4c1e-ac2d-574c09b01119",
    "imsOrgId": "{ORG_ID}",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type":"dataSetPrecedence",
        "data": {
            "order": ["5b95b155419ec801e6eee780", "5b7c86968f7b6501e21ba9df"]
        }
    },
    "default": false,
    "updateEpoch": 1551127597
}

Eigenschap

Beschrijving

schema.name

De naam van het schema verbonden aan het fusiebeleid.

attributeMerge.type

Het configuratietype van de gegevensbelangrijkheid voor het samenvoegbeleid. Als de waarde dataSetPrecedence, worden de datasets verbonden aan dit fusiebeleid vermeld onder attributeMerge > data > order. Als de waarde timestampOrdered, dan alle datasets verbonden aan het schema in van verwijzingen wordt voorzien schema.name worden gebruikt door het samenvoegbeleid.

attributeMerge.data.order

Als de attributeMerge.type is dataSetPrecedence, zal dit attribuut een serie die IDs van de datasets bevatten door dit fusiebeleid wordt gebruikt. Deze id's worden in de volgende stap gebruikt.

Gegevenssets evalueren voor beleidsovertredingen

NOTE

In deze stap wordt ervan uitgegaan dat u ten minste één actief beleid voor gegevensgebruik hebt dat voorkomt dat specifieke marketingacties worden uitgevoerd op gegevens die bepaalde labels bevatten. Als u geen van toepassing gebruiksbeleid voor de datasets hebt die worden geëvalueerd, gelieve te volgen zelfstudie over het maken van beleid om er een te maken voordat u doorgaat met deze stap.

Zodra u identiteitskaarts van de brondatasets van het fusiebeleid hebt verkregen, kunt u gebruiken Policy Service API deze gegevensreeksen te evalueren aan de hand van specifieke marketingacties om na te gaan of er sprake is van schendingen van het gegevensgebruiksbeleid.

Om de datasets te evalueren, moet u de naam van de marketing actie in de weg van een verzoek van de POST verstrekken, terwijl het verstrekken van dataset IDs binnen het verzoeklichaam, zoals aangetoond in het voorbeeld hieronder.

API-indeling

POST /marketingActions/core/{MARKETING_ACTION_NAME}/constraints
POST /marketingActions/custom/{MARKETING_ACTION_NAME}/constraints

Parameter

Beschrijving

{MARKETING_ACTION_NAME}

De naam van de marketing actie verbonden aan het beleid van het gegevensgebruik u de datasets door evalueert. Afhankelijk van of het beleid door Adobe of uw organisatie werd bepaald, moet u gebruiken /marketingActions/core of /marketingActions/custom, respectievelijk.

Verzoek

Het volgende verzoek test de exportToThirdParty het in de handel brengen van gegevens die in het kader van de vorige stap. De aanvraaglading is een serie die IDs van elke dataset bevat.

curl -X POST \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty/constraints
  -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 '[
    {
      "entityType": "dataSet",
      "entityId": "5b95b155419ec801e6eee780"
    },
    {
      "entityType": "dataSet",
      "entityId": "5b7c86968f7b6501e21ba9df"
    }
  ]'

Eigenschap

Beschrijving

entityType

Elk item in de payload-array moet het type entiteit aangeven dat wordt gedefinieerd. Voor dit gebruik is de waarde altijd "dataSet".

entityID

Elk punt in de ladingsserie moet unieke identiteitskaart voor een dataset verstrekken.

Antwoord

Een succesvolle reactie keert URI voor de marketing actie, de etiketten van het gegevensgebruik terug die uit de verstrekte datasets werden verzameld, en een lijst van om het even welk beleid van het gegevensgebruik dat als resultaat van het testen van de actie tegen die etiketten werd geschonden. In dit voorbeeld wordt het beleid Gegevens exporteren naar derde partij weergegeven in het dialoogvenster violatedPolicies array, die aangeeft dat de marketingactie een beleidsovertreding heeft veroorzaakt.

{
  "timestamp": 1556324277895,
  "clientId": "{CLIENT_ID}",
  "userId": "{USER_ID}",
  "imsOrg": "{ORG_ID}",
  "marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty",
  "duleLabels": [
    "C1",
    "C2",
    "C4",
    "C5"
  ],
  "discoveredLabels": [
    {
      "entityType": "dataSet",
      "entityId": "5b95b155419ec801e6eee780",
      "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": "5b7c86968f7b6501e21ba9df",
      "dataSetLabels": {
        "connection": {
          "labels": []
        },
        "dataSet": {
          "labels": [
            "C5"
          ]
        },
        "fields": [
          {
            "labels": [
              "C5"
            ],
            "path": "/properties/createdByBatchID"
          },
          {
            "labels": [
              "C5"
            ],
            "path": "/properties/faxPhone"
          }
        ]
      }
    }
  ],
  "violatedPolicies": [
    {
      "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"
    }
  ]
}

Eigenschap

Beschrijving

duleLabels

Een lijst met gegevensgebruikslabels die uit de verstrekte datasets zijn geëxtraheerd.

discoveredLabels

Een lijst van de datasets die in de verzoeklading werden verstrekt, tonend de datasetniveau en gebied-vlakke etiketten die in elk werden gevonden.

violatedPolicies

Een array met voorbeelden van beleidsregels voor gegevensgebruik die zijn overtreden door het testen van de marketingactie (opgegeven in marketingActionRef) tegen de verstrekte duleLabels.

Met de gegevens die in de API-reactie worden geretourneerd, kunt u protocollen in uw ervaringstoepassing instellen om beleidsovertredingen op de juiste wijze af te dwingen.

Gegevensvelden filteren

Als uw segmentdefinitie geen evaluatie overgaat, kunt u de gegevens aanpassen inbegrepen in de segmentdefinitie door één van de twee hieronder geschetste methodes.

Het samenvoegbeleid van de segmentdefinitie bijwerken

Het bijwerken van het samenvoegbeleid van een segmentdefinitie zal de datasets en de gebieden aanpassen die zullen worden omvat wanneer de segmentbaan in werking wordt gesteld. Zie de sectie over bijwerken van een bestaand samenvoegingsbeleid in de zelfstudie over het samenvoegbeleid van de API voor meer informatie.

Specifieke gegevensvelden beperken bij het exporteren van de segmentdefinitie

Wanneer het uitvoeren van een segmentdefinitie aan een dataset die gebruikt Segmentation API, kunt u de gegevens filtreren die in de uitvoer door te gebruiken fields parameter. Alle gegevensvelden die aan deze parameter worden toegevoegd, worden in de exportbewerking opgenomen, terwijl alle andere gegevensvelden worden uitgesloten.

Overweeg een segmentdefinitie die gegevensvelden met de naam "A", "B" en "C" heeft. Als u alleen veld "C" wilt exporteren, fields parameter zou veld "C" alleen bevatten. Op deze manier worden de velden A en B uitgesloten bij het exporteren van de segmentdefinitie.

Zie de sectie over segmentdefinitie exporteren in de segmentatiezelfstudie voor meer informatie.

Volgende stappen

Door deze zelfstudie te volgen, hebt u de etiketten van het gegevensgebruik verbonden aan een segmentdefinitie opgezocht en hen getest op beleidsschendingen tegen specifieke marketing acties. Voor meer informatie over gegevensbeheer in Experience Platform, lees het overzicht voor Gegevensbeheer.

recommendation-more-help

770bc05d-534a-48a7-9f07-017ec1e14871