설명서 Experience Platform Data Governance 안내서

레이블 끝점

Last update: Wed Feb 28 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
Data Governance

작성 대상:

Developer

데이터 사용 레이블을 사용하면 해당 데이터에 적용할 수 있는 사용 정책에 따라 데이터를 분류할 수 있습니다. 다음 /labels 의 엔드포인트 Policy Service API experience 애플리케이션 내에서 데이터 사용 레이블을 프로그래밍 방식으로 관리할 수 있습니다.

NOTE

다음 /labels 끝점은 데이터 사용 레이블을 검색, 생성 및 업데이트하는 데만 사용됩니다. API 호출을 사용하여 데이터 세트 및 필드에 레이블을 추가하는 방법에 대한 단계는 의 안내서를 참조하십시오. 데이터 세트 레이블 관리.

시작하기

이 안내서에 사용된 API 끝점은 Policy Service API. 계속하기 전에 다음을 검토하십시오. 시작 안내서 관련 설명서에 대한 링크, 이 문서에서 샘플 API 호출 읽기에 대한 안내서 및 를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보 Experience Platform API.

레이블 목록 검색 list

모두 나열할 수 있습니다. core 또는 custom 에 GET 요청을 하여 레이블 지정 /labels/core 또는 /labels/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

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

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

PUT 사용자 지정 레이블을 만들거나 업데이트하려면 Policy Service API.

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

레이블의 카테고리입니다. 사용자 지정 레이블에 대해 고유한 범주를 만들 수 있지만, Custom UI에 레이블을 표시하려면 다음을 수행하십시오.

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

다음 단계

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

recommendation-more-help

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