설명서 Experience Platform Data Governance 안내서

레이블 끝점

Last update: Thu Aug 01 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
데이터 거버넌스

작성 대상:

개발자

데이터 사용 레이블을 사용하면 해당 데이터에 적용할 수 있는 사용 정책에 따라 데이터를 분류할 수 있습니다. Policy Service API의 /labels 끝점을 사용하면 경험 응용 프로그램 내에서 데이터 사용 레이블을 프로그래밍 방식으로 관리할 수 있습니다.

NOTE

/labels 끝점은 데이터 사용 레이블을 검색, 생성 및 업데이트하는 데만 사용됩니다. 레이블을 삭제할 수 없습니다. 그러나 API 호출을 사용하여 데이터 세트 및 필드에 레이블을 추가하거나 제거할 수 있습니다. 지침은 데이터 세트 레이블 관리 문서에 대한 안내서를 참조하십시오.

시작하기

이 가이드에 사용된 API 끝점은 Policy Service API의 일부입니다. 계속하기 전에 시작 안내서를 검토하여 관련 문서에 대한 링크, 이 문서의 샘플 API 호출 읽기 지침 및 Experience Platform API를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보를 확인하십시오.

레이블 목록 검색 list

/labels/core 또는 /labels/custom에 각각 GET 요청을 하여 core 또는 custom 레이블을 모두 나열할 수 있습니다.

API 형식

GET /labels/core
GET /labels/custom

요청

다음 요청은 조직에서 만든 모든 사용자 지정 레이블을 나열합니다.

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

응답

성공적인 응답은 시스템에서 검색된 사용자 지정 레이블 목록을 반환합니다. 위의 예제 요청이 /labels/custom에 대해 수행되었으므로 아래 응답에는 사용자 지정 레이블만 표시됩니다.

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

레이블 조회 look-up

Policy Service API에 대한 GET 요청 경로에 해당 레이블의 name 속성을 포함하여 특정 레이블을 조회할 수 있습니다.

API 형식

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}

매개변수

설명

{LABEL_NAME}

조회할 사용자 지정 레이블의 name 속성입니다.

요청

다음 요청은 경로에 표시된 대로 사용자 지정 레이블 L2을(를) 검색합니다.

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

응답

성공적인 응답은 사용자 지정 레이블의 세부 정보를 반환합니다.

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

사용자 지정 레이블 만들기 또는 업데이트 create-update

사용자 지정 레이블을 만들거나 업데이트하려면 Policy Service API에 대한 PUT 요청을 수행해야 합니다.

NOTE

데이터 집합에서 레이블을 제거하려면 데이터 집합 서비스 API에서 PUT 요청을 수행하거나 데이터 집합 UI를 사용할 수 있습니다.

API 형식

PUT /labels/custom/{LABEL_NAME}

매개변수

설명

{LABEL_NAME}

사용자 지정 레이블의 name 속성입니다. 이 이름을 가진 사용자 지정 레이블이 없으면 새 레이블이 만들어집니다. 레이블이 있으면 해당 레이블이 업데이트됩니다.

요청

다음 요청은 고객이 선택한 결제 플랜과 관련된 정보가 포함된 데이터를 설명하는 것을 목적으로 하는 새 레이블 L3을(를) 만듭니다.

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

속성

설명

name

레이블에 대한 고유 문자열 식별자. 이 값은 조회 목적으로 사용되고 데이터 세트 및 필드에 레이블을 적용하므로 짧고 간결한 것이 좋습니다.

category

레이블의 카테고리입니다. 사용자 지정 레이블에 대해 고유한 범주를 만들 수 있지만, 레이블을 UI에 표시하려면 Custom을(를) 사용하는 것이 좋습니다.

friendlyName

표시용으로 사용되는 레이블의 이름입니다.

description

(선택 사항) 추가 컨텍스트를 제공하기 위한 레이블에 대한 설명입니다.

응답

성공적인 응답은 기존 레이블이 업데이트된 경우 HTTP 코드 200(OK), 새 레이블이 만들어진 경우 201(Created)과 함께 사용자 지정 레이블의 세부 사항을 반환합니다.

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

다음 단계

이 안내서에서는 정책 서비스 API에서 /labels 끝점을 사용하는 방법에 대해 다룹니다. 데이터 세트 및 필드에 레이블을 적용하는 방법에 대한 단계는 데이터 세트 레이블 API 안내서를 참조하십시오.

recommendation-more-help

834e0cae-2761-454a-be4d-62f0fd4b4456