DokumentationExperience PlatformData Governance-Handbuch

Label-Endpunkt

Letzte Aktualisierung: 29. Oktober 2026

Erstellt für:

  • Entwicklerin/Entwickler

Mit Datennutzungs-Labels können Sie Datensätze anhand der für diese Daten geltenden Nutzungsrichtlinien kategorisieren. Mit dem /labels-Endpunkt in Policy Service API können Sie Datennutzungs-Labels in Ihrem Experience-Programm programmgesteuert verwalten.

NOTE
Der /labels-Endpunkt wird nur zum Abrufen, Erstellen und Aktualisieren von Datennutzungs-Labels verwendet. Kennzeichnungen können nicht gelöscht werden. Sie können jedoch mithilfe von API-Aufrufen Kennzeichnungen zu Datensätzen und Feldern hinzufügen oder entfernen. Anweisungen finden Sie im Handbuch unter Verwalten ​ Datensatzkennzeichnungen .

Erste Schritte

Der in diesem Handbuch verwendete API-Endpunkt ist Teil von Policy Service API. Bevor Sie fortfahren, schauen Sie bitte im Handbuch in Erste Schritte nach Links zu entsprechenden Dokumentationen, einem Leitfaden zum Lesen der Beispiel-API-Aufrufe in diesem Dokument und wichtigen Informationen zu erforderlichen Kopfzeilen, die für das Aufrufen einer Experience Platform-API erforderlich sind.

Abrufen einer Label-Liste list

Sie können alle core oder custom Labels durch eine GET-Anfrage an /labels/core bzw. /labels/custom auflisten.

API-Format

GET /labels/core
GET /labels/custom

Anfrage

Mit der folgenden Anfrage werden alle benutzerdefinierten Labels aufgelistet, die im Rahmen Ihres Unternehmens erstellt wurden.

curl -X GET \
  'https://platform.adobe.io/data/foundation/dulepolicy/labels/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}'

Antwort

Eine erfolgreiche Antwort gibt eine Liste von benutzerdefinierten Labels zurück, die vom System abgerufen werden. Da die obige Beispielanforderung an /labels/custom erfolgte, zeigt die unten stehende Antwort nur benutzerdefinierte Labels an.

{
    "_page": {
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "L1",
            "category": "Custom",
            "friendlyName": "Banking Information",
            "description": "Data containing banking information for a customer.",
            "imsOrg": "{ORG_ID}",
            "sandboxName": "{SANDBOX_NAME}",
            "created": 1594396718731,
            "createdClient": "{CLIENT_ID}",
            "createdUser": "{USER_ID}",
            "updated": 1594396718731,
            "updatedClient": "{CLIENT_ID}",
            "updatedUser": "{USER_ID}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L1"
                }
            }
        },
        {
            "name": "L2",
            "category": "Custom",
            "friendlyName": "Purchase History Data",
            "description": "Data containing information on past transactions",
            "imsOrg": "{ORG_ID}",
            "sandboxName": "{SANDBOX_NAME}",
            "created": 1594397415663,
            "createdClient": "{CLIENT_ID}",
            "createdUser": "{USER_ID}",
            "updated": 1594397728708,
            "updatedClient": "{CLIENT_ID}",
            "updatedUser": "{USER_ID}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
                }
            }
        }
    ]
}

Nachschlagen eines Labels look-up

Sie können ein bestimmtes Label nachschlagen, indem Sie die Eigenschaft name dieses Labels in den Pfad einer GET-Anfrage an die Policy Service-API aufnehmen.

API-Format

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
Parameter
Beschreibung
{LABEL_NAME}
Die Eigenschaft name des benutzerdefinierten Labels, die Sie nachschlagen möchten.

Anfrage

Die folgende Anfrage ruft das benutzerdefinierte Label L2 ab, wie im Pfad angegeben.

curl -X GET \
  'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L2' \
  -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}'

Antwort

Eine erfolgreiche Antwort gibt die Details des benutzerdefinierten Labels zurück.

{
    "name": "L2",
    "category": "Custom",
    "friendlyName": "Purchase History Data",
    "description": "Data containing information on past transactions",
    "imsOrg": "{ORG_ID}",
    "sandboxName": "{SANDBOX_NAME}",
    "created": 1594397415663,
    "createdClient": "{CLIENT_ID}",
    "createdUser": "{USER_ID}",
    "updated": 1594397728708,
    "updatedClient": "{CLIENT_ID}",
    "updatedUser": "{USER_ID}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
        }
    }
}

Erstellen oder Aktualisieren eines benutzerdefinierten Labels create-update

Um ein benutzerdefiniertes Label zu erstellen oder zu aktualisieren, müssen Sie eine PUT-Anfrage an die Policy Service-API richten.

NOTE
Wenn Sie Kennzeichnungen aus einem Datensatz entfernen möchten, können Sie eine PUT-Anfrage über die Dataset Service- oder die Datasets-Benutzeroberfläche“ ​.

API-Format

PUT /labels/custom/{LABEL_NAME}
Parameter
Beschreibung
{LABEL_NAME}
Die Eigenschaft name eines benutzerdefinierten Labels. Wenn kein benutzerdefiniertes Label mit diesem Namen vorhanden ist, wird ein neues Label erstellt. Wenn eine vorhanden ist, wird dieses Label aktualisiert.

Anfrage

Mit der folgenden Anfrage wird ein neues Label (L3) erstellt, die Daten beschreiben soll, die Informationen zu den ausgewählten Zahlungsplänen der Kunden enthalten.

curl -X PUT \
  'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L3' \
  -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}' \
  -d '{
        "name": "L3",
        "category": "Custom",
        "friendlyName": "Payment Plan",
        "description": "Data containing information on selected payment plans."
      }'
Eigenschaft
Beschreibung
name
Eine eindeutige Zeichenfolgenkennung für das Label. Dieser Wert wird für Nachschlagezwecke und zum Anwenden des Labels auf Datensätze und Felder verwendet. Es wird daher empfohlen, einen kurzen und knappen Wert zu wählen.
category
Die Kategorie des Labels. Sie können zwar eigene Kategorien für benutzerdefinierte Labels erstellen, es wird jedoch dringend empfohlen, Custom zu verwenden, wenn die Kennzeichnung in der Benutzeroberfläche angezeigt werden soll.
friendlyName
Ein benutzerfreundlicher Name für das Label, der zu Anzeigezwecken verwendet wird.
description
(Optional) Eine Beschreibung des Labels, um mehr Kontext bereitzustellen.

Antwort

Eine erfolgreiche Antwort gibt die Details des benutzerdefinierten Labels zurück, wobei HTTP-Code 200 (OK) bei einer Aktualisierung eines bestehenden Labels oder 201 (Erstellt) bei einem neuen Label angezeigt wird.

{
  "name": "L3",
  "category": "Custom",
  "friendlyName": "Payment Plan",
  "description": "Data containing information on selected payment plans.",
  "imsOrg": "{ORG_ID}",
  "sandboxName": "{SANDBOX_NAME}",
  "created": 1529696681413,
  "createdClient": "{CLIENT_ID}",
  "createdUser": "{USER_ID}",
  "updated": 1529697651972,
  "updatedClient": "{CLIENT_ID}",
  "updatedUser": "{USER_ID}",
  "_links": {
    "self": {
      "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L3"
    }
  }
}

Nächste Schritte

In diesem Handbuch wurde die Verwendung des Endpunkts /labels in der Richtlinien-Service-API behandelt. Anleitungen zum Anwenden von Labels auf Datensätze und Felder finden Sie im Handbuch zur Datensatz-Label-API.

recommendation-more-help
experience-platform-help-data-governance