API를 사용하여 데이터 세트의 데이터 사용 레이블 관리

다음 Dataset Service API 에서는 데이터 세트에 대한 사용 레이블을 적용하고 편집할 수 있습니다. Adobe Experience Platform의 데이터 카탈로그 기능의 일부이지만 과는 별개입니다 Catalog Service 데이터 세트 메타데이터를 관리하는 API.

이 문서에서는 다음을 사용하여 데이터 세트 및 필드의 레이블을 관리하는 방법을 다룹니다. Dataset Service API. API 호출을 사용하여 데이터 사용 레이블 자체를 관리하는 방법에 대한 단계는 labels endpoint 안내서 대상: Policy Service API.

시작하기

이 안내서를 읽기 전에 시작 섹션 를 호출하는 데 필요한 자격 증명을 수집하려면 카탈로그 개발자 안내서에서 를 참조하십시오. Platform API.

이 문서에 설명된 끝점을 호출하려면 고유한 id 특정 데이터 세트에 대한 값입니다. 이 값이 없는 경우 의 안내서를 참조하십시오. 카탈로그 개체 나열 기존 데이터 세트의 ID를 찾습니다.

데이터 세트에 대한 레이블 조회

에 GET 요청을 하여 기존 데이터 세트에 적용된 데이터 사용 레이블을 조회할 수 있습니다. Dataset Service API.

API 형식

GET /datasets/{DATASET_ID}/labels

요청

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}'

응답

성공적인 응답은 데이터 세트에 적용된 데이터 사용 레이블을 반환합니다.

{
  "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" ]
      }
    ]
  }
}

데이터 세트에 레이블 적용

POST 또는 PUT 요청의 페이로드에 제공하여 데이터 세트에 대한 레이블 집합을 생성할 수 있습니다. Dataset Service API. 이러한 방법 중 하나를 사용하면 기존 레이블을 덮어쓰고 페이로드에 제공된 레이블로 교체합니다.

API 형식

POST /datasets/{DATASET_ID}/labels
PUT /datasets/{DATASET_ID}/labels

요청

아래의 예제 PUT 요청은 데이터 세트에 대한 기존 레이블과 해당 데이터 세트 내의 특정 필드를 업데이트합니다. 페이로드에 제공된 필드는 POST 요청에 필요한 것과 동일합니다.

데이터 세트(PUT)의 기존 레이블을 업데이트하는 API 호출을 수행할 때 If-Match 데이터 세트 서비스에 있는 데이터 세트 레이블 엔티티의 현재 버전을 나타내는 헤더를 포함해야 합니다. 데이터 충돌을 방지하기 위해 서비스는 데이터 세트 엔티티가 포함된 경우에만 업데이트합니다 If-Match 문자열은 해당 데이터 세트에 대해 시스템에서 생성한 최신 버전 태그와 일치합니다.

데이터 세트 레이블 엔티티의 최신 버전을 검색하려면 GET 요청 (으)로 /datasets/{DATASET_ID}/labels 엔드포인트. 현재 값은 아래 응답에 반환됩니다. etag 머리글입니다. 기존 데이터 세트 레이블을 업데이트할 때 가장 좋은 방법은 최신 데이터를 가져오기 위해 먼저 데이터 세트에 대한 조회 요청을 수행하는 것입니다 etag 에서 해당 값을 사용하기 전의 값 If-Match 후속 PUT 요청의 헤더.

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

다음 단계

이 문서를 읽고 다음을 사용하여 데이터 세트 및 필드의 데이터 사용 레이블을 관리하는 방법을 배웠습니다. Dataset Service API. 이제 다음을 정의할 수 있습니다. 데이터 사용 정책 및 액세스 제어 정책 적용한 레이블을 기반으로 합니다.

에서 데이터 세트 관리에 대한 자세한 내용 Experience Platform, 다음을 참조하십시오. 데이터 세트 개요.

Business.Adobe.com 리소스