Gegevensgebruikslabels voor gegevenssets beheren met behulp van API’s

Met Dataset Service API ​ kunt u gebruikslabels voor gegevenssets toepassen en bewerken. De klasse maakt deel uit van de mogelijkheden van de Adobe Experience Platform-gegevenscatalogus, maar staat los van de API van Catalog Service die metagegevens van gegevenssets beheert.

In dit document wordt beschreven hoe u labels voor gegevenssets en velden kunt beheren met de Dataset Service API . Voor stappen op hoe te om de etiketten van het gegevensgebruik zelf te beheren die API vraag gebruiken, zie de ​ gids van het etiketteneindpunt ​ voor Policy Service API.

Aan de slag

Alvorens u deze gids leest, volg de stappen die in ​ worden geschetst begonnen sectie ​ in de de ontwikkelaarsgids van de Catalogus worden geschetst om de vereiste geloofsbrieven te verzamelen om vraag aan Experience Platform APIs te maken.

Als u aanroepen wilt uitvoeren naar de eindpunten die in dit document worden beschreven, moet u de unieke id -waarde voor een specifieke gegevensset hebben. Als u deze waarde niet hebt, zie de gids op ​ het van lijstCatalogusvoorwerpen ​ om IDs van uw bestaande datasets te vinden.

De etiketten van de raadpleging voor een dataset look-up

U kunt de labels voor gegevensgebruik opzoeken die zijn toegepast op een bestaande gegevensset door een GET-aanvraag in te dienen op de Dataset Service API.

API formaat

GET /datasets/{DATASET_ID}/labels

Verzoek

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

Reactie

Een succesvolle reactie keert de etiketten van het gegevensgebruik terug die op de dataset zijn toegepast.

{
  "AEP:dataset:5abd49645591445e1ba04f87": {
    "imsOrg": "{ORG_ID}",
    "labels": [ "C1", "C2", "C3", "I1", "I2" ],
    "optionalLabels": [
      {
        "option": {
          "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
          "contentType": "application/vnd.adobe.xed-full+json;version=1",
          "schemaPath": "/properties/repositoryCreatedBy"
        },
        "labels": [ "S1", "S2" ]
      }
    ]
  }
}

Labels toepassen op een gegevensset apply

U kunt een reeks etiketten voor een volledige dataset toepassen door hen in de nuttige lading van een PPUT- verzoek op Dataset Service API te verstrekken. U kunt geen labels toevoegen aan afzonderlijke gegevenssetvelden.

API formaat

PUT /datasets/{DATASET_ID}/labels

Verzoek

In het onderstaande voorbeeld wordt de gehele gegevensset bijgewerkt met een label C1 .

Bij het maken van API-aanroepen waarmee de bestaande labels van een dataset worden bijgewerkt, moet een If-Match -header worden opgenomen die de huidige versie van de entiteit met de tag dataset in Dataset Service aangeeft. Om gegevensbotsingen te verhinderen, zal de dienst slechts de datasetentiteit bijwerken als inbegrepen If-Match koord de recentste versiemarkering aanpast die door het systeem voor die dataset wordt geproduceerd.

Om de meest recente versie van de dataset-etiket entiteit terug te winnen, doe a ​ verzoek ​ aan het /datasets/{DATASET_ID}/labels eindpunt. De huidige waarde wordt geretourneerd in de reactie onder een etag -header. Wanneer u bestaande gegevenssetlabels bijwerkt, kunt u het beste eerst een opzoekverzoek voor de gegevensset uitvoeren om de laatste etag -waarde op te halen voordat u die waarde in de If-Match -koptekst van uw volgende PUT-verzoek gebruikt.

curl -X PUT \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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 '{
        "entityId": {
          "namespace": "AEP",
          "id": "test-ds-id",
          "type": "dataset"
        },
        "labels": [
          "C1"
        ],
        "parents": []
      } '

Reactie

Een succesvolle reactie keert de bijgewerkte reeks etiketten voor de dataset terug.

{
  "parents": [
      {
        "id": "_ddgduleint.schemas.4a95cdba7d560e3bca7d8c5c7b58f00ca543e2bb1e4137d6",
        "type": "schema",
        "namespace": "AEP"
      }
  ],
  "optionalLabels": [],
  "labels": [
      "C1"
  ],
  "code": "PES-201",
  "message": "PUT Successful"
}

Labels uit een gegevensset verwijderen remove

U kunt eerder toegepaste veldlabels verwijderen door de bestaande optionalLabels -waarde(n) bij te werken met een subset van de bestaande veldlabels of door een lege lijst om deze volledig te verwijderen. Een PUT-verzoek indienen bij de Dataset Service API om eerder toegepaste labels bij te werken of te verwijderen.

API formaat

PUT /datasets/{DATASET_ID}/labels

Verzoek

De hieronder dataset waarop de verrichting van de LINGING wordt toegepast had C1 optionalLabel op eigenschappen/person/properties/adresgebied en C1, C2 optionalLabels op /properties/person/properties/name/properties/fullName gebied. Na de putoptie heeft het eerste veld geen label (label C1 verwijderd) en het tweede veld heeft alleen het label C1 (label C2 verwijderd)

In het onderstaande voorbeeldscenario wordt een PUT-aanvraag gebruikt om labels te verwijderen die aan afzonderlijke velden zijn toegevoegd. Voordat de aanvraag werd uitgevoerd, waren in het veld fullName de labels C1 en C2 toegepast en in het veld address was al een label C1 toegepast. De PUT-aanvraag negeert bestaande labels C1, C2 uit het fullName -veld met een C1 -label met behulp van de optionalLabels.labels -parameter. De aanvraag negeert ook het label C1 uit het veld address met een lege set veldlabels.

curl -X PUT \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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' \
  -H 'If-Match: 8f00d38e-0000-0200-0000-5ef4fc6d0000' \
  -d '{
        "entityId": {
          "namespace": "AEP",
          "id": "646b814d52e1691c07b41032",
          "type": "dataset"
        },
        "labels": [
          "C1"
        ],
        "parents": [
          {
            "id": "_xdm.context.identity-graph-flattened-export",
            "type": "schema",
            "namespace": "AEP"
          }
        ],
        "optionalLabels": [
          {
            "option": {
              "id": "https://ns.adobe.com/xdm/context/identity-graph-flattened-export",
              "contentType": "application/vnd.adobe.xed-full+json;version=1",
              "schemaPath": "/properties/person/properties/name/properties/fullName"
            },
            "labels": [
              "C1"
            ]
          },
          {
            "option": {
              "id": "https://ns.adobe.com/xdm/context/identity-graph-flattened-export",
              "contentType": "application/vnd.adobe.xed-full+json;version=1",
              "schemaPath": "/properties/person/properties/address"
            },
            "labels": []
          }
        ]
      }'

Reactie

Een succesvolle reactie keert de bijgewerkte reeks etiketten voor de dataset terug.

{
  "parents": [
      {
        "id": "_xdm.context.identity-graph-flattened-export",
        "type": "schema",
        "namespace": "AEP"
      }
  ],
  "optionalLabels": [],
  "labels": [
      "C1"
  ],
  "code": "PES-200",
  "message": "PUT Successful"
}

Volgende stappen

Door dit document te lezen, hebt u geleerd hoe u labels voor gegevensgebruik voor gegevenssets en velden kunt beheren met de API Dataset Service . U kunt ​ beleid van het gegevensgebruik ​ en ​ toegangsbeheerbeleid ​ nu bepalen dat op de etiketten wordt gebaseerd u hebt toegepast.

Voor meer informatie bij het beheren van datasets in Experience Platform, zie het ​ overzicht van datasets ​.