API를 사용하여 프로필 업데이트에 대한 데이터 세트 활성화

이 튜토리얼에서는 실시간 고객 프로필 데이터를 업데이트하기 위해 "업데이트" 기능으로 데이터 세트를 활성화하는 프로세스에 대해 설명합니다. 여기에는 새 데이터 세트를 만들고 기존 데이터 세트를 구성하는 단계가 포함됩니다.

시작하기

이 자습서에서는 프로필 사용 데이터 세트 관리와 관련된 여러 Adobe Experience Platform 서비스에 대한 작업 이해가 필요합니다. 이 자습서를 시작하기 전에 다음 관련 Platform 서비스에 대한 설명서를 검토하십시오.

다음 섹션에서는 Platform API를 성공적으로 호출하기 위해 알아야 하는 추가 정보를 제공합니다.

샘플 API 호출 읽기

이 튜토리얼에서는 요청 형식을 지정하는 방법을 보여 주는 예제 API 호출을 제공합니다. 여기에는 경로, 필수 헤더 및 적절한 형식의 요청 페이로드가 포함됩니다. API 응답에서 반환되는 샘플 JSON도 제공됩니다. 샘플 API 호출에 대한 설명서에 사용된 규칙에 대한 자세한 내용은 Experience Platform 문제 해결 안내서의 예제 API 호출을 읽는 방법에 대한 섹션을 참조하십시오.

필수 헤더에 대한 값 수집

Platform API를 호출하려면 먼저 인증 자습서를 완료해야 합니다. 인증 튜토리얼을 완료하면 아래와 같이 모든 Experience Platform API 호출의 필수 헤더 각각에 대한 값이 제공됩니다.

페이로드(POST, PUT, PATCH)가 포함된 모든 요청에는 추가 Content-Type 헤더가 필요합니다. 이 헤더에 대한 정확한 값이 필요한 경우 샘플 요청에 표시됩니다.

Experience Platform의 모든 리소스는 특정 가상 샌드박스로 격리되어 있습니다. Platform API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 x-sandbox-name 헤더가 필요합니다. Platform의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서를 참조하십시오.

프로필 업데이트를 위해 활성화된 데이터 세트 만들기

새 데이터 세트를 만들 때 프로필에 대해 해당 데이터 세트를 활성화하고 생성 시 업데이트 기능을 활성화할 수 있습니다.

프로필 및 업데이트에 사용할 수 있는 데이터 집합을 만들려면 /dataSets 끝점에 대한 POST 요청을 사용하십시오.

API 형식

POST /dataSets

요청

tags의 unifiedIdentity 및 unifiedProfile을(를) 요청 본문에 포함하면 데이터 세트가 Profile에 대해 만들어질 때 활성화됩니다. unifiedProfile 배열 내에서 isUpsert:true을(를) 추가하면 데이터 집합에 대한 업데이트 지원 기능이 추가됩니다.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -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": "Sample dataset",
        "description: "A sample dataset with a sample description.",
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
            "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
        },
        "tags": {
            "unifiedIdentity": [
                "enabled: true"
            ],
            "unifiedProfile": [
                "enabled: true",
                "isUpsert: true"
            ]
        }
      }'

응답

성공한 응답은 새로 만든 데이터 세트의 ID가 포함된 배열을 "@/dataSets/{DATASET_ID}" 형식으로 표시합니다.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

기존 데이터 세트 구성 configure-an-existing-dataset

다음 단계에서는 업데이트(업데이트) 기능을 위해 기존 프로필 지원 데이터 세트를 구성하는 방법을 다룹니다.

프로필에 대해 데이터 세트가 활성화되어 있는지 확인

Catalog API를 사용하여 기존 데이터 세트를 검사하여 Real-Time Customer Profile에서 사용할 수 있는지 확인할 수 있습니다. 다음 호출은 ID별로 데이터 세트의 세부 정보를 검색합니다.

API 형식

GET /dataSets/{DATASET_ID}

요청

curl -X GET 'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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}'

응답

{
    "5b020a27e7040801dedbf46e": {
        "name": "{DATASET_NAME}",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ],
            "unifiedProfile": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "{VIEW_ID}",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "{SCHEMA}",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

tags 속성에서 unifiedProfile이(가) 값 enabled:true과(와) 함께 있음을 볼 수 있습니다. 따라서 이 데이터 세트에 대해 Real-Time Customer Profile을(를) 사용할 수 있습니다.

프로필에 대한 데이터 세트 비활성화

업데이트할 프로필 사용 데이터 집합을 구성하려면 먼저 unifiedProfile 및 unifiedIdentity 태그를 사용하지 않도록 설정한 다음 isUpsert 태그와 함께 다시 사용하도록 설정해야 합니다. 이 작업은 두 개의 PATCH 요청을 사용하여 수행되며, 한 번은 비활성화하고 한 번은 다시 활성화합니다.

API 형식

PATCH /dataSets/{DATASET_ID}

요청

첫 번째 PATCH 요청 본문에는 path에서 unifiedProfile까지, path에서 unifiedIdentity까지가 포함되어 있습니다. 태그를 사용하지 않도록 설정하려면 두 경로의 value을(를) enabled:false(으)로 설정합니다.

curl -X PATCH https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+json' \
  -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 '[
        {
            "op": "replace",
            "path": "/tags/unifiedProfile",
            "value": ["enabled:false"]
        },
        {
            "op": "replace",
            "path": "/tags/unifiedIdentity",
            "value": ["enabled:false"]
        }
      ]'

응답

성공적인 PATCH 요청은 HTTP 상태 200(OK)과 업데이트된 데이터 세트의 ID가 포함된 배열을 반환합니다. 이 ID는 PATCH 요청에서 전송된 ID와 일치해야 합니다. unifiedProfile 및 unifiedIdentity 태그가 이제 비활성화되었습니다.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

프로필 및 업데이트에 대한 데이터 세트 활성화 enable-the-dataset

단일 PATCH 요청을 사용하여 프로필 및 속성 업데이트에 대한 기존 데이터 세트를 활성화할 수 있습니다.

API 형식

PATCH /dataSets/{DATASET_ID}

요청

요청 본문에는 true(으)로 설정된 enabled 및 isUpsert 태그를 포함하도록 value을(를) 설정하는 path - unifiedProfile과(와) true(으)로 설정된 enabled 태그를 포함하도록 value을(를) 설정하는 path - unifiedIdentity이(가) 포함됩니다.

curl -X PATCH https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+json' \
  -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 '[
        {
            "op": "add",
            "path": "/tags/unifiedProfile",
            "value": [
                "enabled:true",
                "isUpsert:true"
            ]
        },
        {
            "op": "add",
            "path": "/tags/unifiedIdentity",
            "value": [
                "enabled:true"
            ]
        }
      ]'

응답

성공적인 PATCH 요청은 HTTP 상태 200(OK)과 업데이트된 데이터 세트의 ID가 포함된 배열을 반환합니다. 이 ID는 PATCH 요청에서 전송된 ID와 일치해야 합니다. unifiedProfile 태그 및 unifiedIdentity 태그가 이제 속성 업데이트에 대해 사용하도록 설정 및 구성되었습니다.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

다음 단계

이제 일괄 처리 수집 워크플로우에서 프로필 및 업데이트 활성화 데이터 세트를 사용하여 프로필 데이터를 업데이트할 수 있습니다. Adobe Experience Platform으로 데이터 수집에 대한 자세한 내용은 데이터 수집 개요를 읽는 것부터 시작해 보십시오.