Show Menu
화제×

API를 사용하여 프로필 및 ID 서비스에 대한 데이터 집합 구성

이 자습서에서는 실시간 고객 프로필 및 ID 서비스에서 사용할 데이터 세트를 활성화하는 과정을 다루고 있으며, 다음 단계로 분류됩니다.
  1. 다음 두 가지 옵션 중 하나를 사용하여 실시간 고객 프로파일에서 사용할 데이터 세트를 활성화합니다.

시작하기

이 자습서에서는 프로필 사용 데이터 집합 관리와 관련된 다양한 Adobe Experience Platform 서비스에 대해 제대로 이해해야 합니다. 이 자습서를 시작하기 전에 관련 플랫폼 서비스에 대한 설명서를 참조하십시오.
  • 실시간 고객 프로필 :다양한 소스의 데이터를 집계하여 통합된 실시간 고객 프로파일을 제공합니다.
  • ID 서비스 :인제스트되는 다양한 데이터 소스의 ID를 플랫폼에 통합하여 실시간 고객 프로파일을 구축할 수 있습니다.
  • 카탈로그 서비스 :데이터 집합을 만들고 실시간 고객 프로필 및 ID 서비스에 대해 구성할 수 있는 RESTful API입니다.
  • XDM(Experience Data Model) :플랫폼이 고객 경험 데이터를 구성하는 표준화된 프레임워크입니다.
다음 섹션에서는 플랫폼 API를 성공적으로 호출하기 위해 알아야 할 추가 정보를 제공합니다.

샘플 API 호출 읽기

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

필수 헤더에 대한 값 수집

플랫폼 API를 호출하려면 먼저 인증 자습서를 완료해야 합니다. 인증 튜토리얼을 완료하면 다음과 같이 모든 Experience Platform API 호출에서 각 필수 헤더에 대한 값이 제공됩니다.
  • 인증:베어러 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
페이로드(POST, PUT, PATCH)가 포함된 모든 요청에는 추가 헤더가 필요합니다.
  • 컨텐츠 유형:application/json
경험 플랫폼의 모든 리소스는 특정 가상 샌드박스로 분리됩니다. 플랫폼 API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 헤더가 필요합니다. 플랫폼의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서를 참조하십시오.
  • x-sandbox-name: {SANDBOX_NAME}

프로필 및 ID에 대해 활성화된 데이터 집합 만들기

실시간 고객 프로파일 및 ID 서비스를 위한 데이터 세트를 생성 즉시 또는 데이터 세트를 만든 후 언제든지 활성화할 수 있습니다. 이미 생성된 데이터 세트를 활성화하려면 이 문서의 후반부에 있는 기존 데이터 세트를 구성하는 절차를 따르십시오. 새 데이터 집합을 만들려면 실시간 고객 프로필에 대해 활성화된 기존 XDM 스키마의 ID를 알고 있어야 합니다. 프로필 사용 스키마를 찾거나 만드는 방법에 대한 자세한 내용은 스키마 레지스트리 API를 사용하여 스키마 만들기에 대한 자습서를 참조하십시오 . 카탈로그 API에 대한 다음 호출은 프로필 및 ID 서비스에 대한 데이터 세트를 활성화합니다.
API 형식
POST /dataSets

요청
요청 본문에 unifiedProfile 포함하거나 unifiedIdentity tags 포함함으로써 데이터 세트는 각각 프로필 및 ID 서비스에 대해 즉시 활성화됩니다. 이러한 태그의 값은 문자열을 포함하는 배열이어야 합니다 "enabled: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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "fileDescription" : {
    "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    },
    "fields":[],
    "schemaRef" : {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags" : {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled:true"]
    }
  }'

속성
설명
schemaRef.id
데이터 세트를 기반으로 할 프로필 사용 스키마의 ID입니다.
{TENANT_ID}
IMS 조직에 속하는 리소스를 포함하는 스키마 레지스트리 내의 네임스페이스입니다. 자세한 내용은 스키마 레지스트리 개발자 안내서의 TENANT_ID 섹션을 참조하십시오.
응답
성공적인 응답은 새로 만든 데이터 세트의 ID가 들어 있는 배열을 "@/dataSets/{DATASET_ID}" 표시합니다. 데이터 세트를 만들고 활성화했으면 데이터 업로드 단계를 진행하십시오 .
[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

기존 데이터 세트 구성

다음 단계에서는 실시간 고객 프로필 및 ID 서비스에 대해 이전에 만든 데이터 세트를 활성화하는 방법을 설명합니다. 프로필 사용 데이터 세트를 이미 만든 경우 데이터 인제스트 단계를 진행하십시오.

데이터 세트가 활성화되어 있는지 확인

Catalog API를 사용하여 기존 데이터 세트를 검사하여 실시간 고객 프로필 및 ID 서비스에서 사용할 수 있는지 여부를 확인할 수 있습니다. 다음 호출은 ID로 데이터 세트에 대한 세부 사항을 검색합니다.
API 형식
GET /dataSets/{DATASET_ID}

매개 변수
설명
{DATASET_ID}
검사하려는 데이터 집합의 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

응답
{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{IMS_ORG}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "lastBatchId": "6dcd9128a1c84e6aa5177641165e18e4",
        "lastBatchStatus": "success",
        "dule": {},
        "statsCache": {
            "startDate": null,
            "endDate": null
        },
        "namespace": "ACP",
        "state": "DRAFT",
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "status": "enabled",
        "fileDescription": {
            "persisted": true,
            "containerFormat": "parquet",
            "format": "parquet"
        },
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "@/xdms/context/experienceevent",
        "schemaMetadata": {
            "primaryKey": [],
            "delta": [],
            "dule": [],
            "gdpr": []
        },
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

tags 속성 아래에서 이 unifiedProfile 값을 볼 수 있으며 이 두 값 unifiedIdentity 모두 이 값과 함께 표시됩니다 enabled:true . 따라서 실시간 고객 프로필 및 ID 서비스는 각각 이 데이터 세트에 대해 활성화됩니다.

데이터 세트 활성화

기존 데이터 세트에 프로필 또는 ID 서비스가 활성화되지 않은 경우 데이터 세트 ID를 사용하여 패치 요청을 수행하여 활성화할 수 있습니다.
API 형식
PATCH /dataSets/{DATASET_ID}

매개 변수
설명
{DATASET_ID}
업데이트할 데이터 집합의 ID입니다.
요청
curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "tags" : {
        "unifiedProfile": ["enabled:true"],
        "unifiedIdentity": ["enabled:true"]
    }
  }'

요청 본문에는 두 개의 하위 속성이 포함된 tags 속성이 포함되어 있습니다. "unifiedProfile" "unifiedIdentity" Adobe 이러한 하위 속성의 값은 문자열을 포함하는 배열입니다 "enabled:true" .
응답 ​성공적인 PATCH 요청은 HTTP Status 200(OK) 및 업데이트된 데이터 세트의 ID가 포함된 배열을 반환합니다. 이 ID는 PATCH 요청에서 전송된 ID와 일치해야 합니다. 이제 "unifiedProfile" "unifiedIdentity" 태그가 추가되었으며 프로필 및 ID 서비스에서 데이터 세트를 사용할 수 있습니다.
[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

데이터를 데이터 세트에 인제스트

실시간 고객 프로파일과 ID 서비스 모두 데이터 세트에 수집되는 XDM 데이터를 사용합니다. 데이터 세트에 데이터를 업로드하는 방법에 대한 지침은 API를 사용하여 데이터 세트 만들기에 대한 자습서를 참조하십시오 . 프로필 사용 데이터 세트에 전송할 데이터를 계획할 때는 다음 우수 사례를 고려하십시오.
  • 대상 세그먼트 기준으로 사용할 데이터를 모두 포함합니다.
  • 프로파일 데이터에서 확인할 수 있는 만큼의 식별자를 포함하여 ID 그래프를 최대화합니다. 이를 통해 ID 서비스는 데이터 세트 간의 ID를 보다 효과적으로 연결할 수 있습니다.

실시간 고객 프로필별 데이터 인제스트 확인

새 데이터 세트에 처음 데이터를 업로드하거나 새 ETL 또는 데이터 소스를 포함하는 프로세스의 일부로 데이터를 업로드하는 경우 데이터가 예상대로 업로드되었는지 신중하게 확인하는 것이 좋습니다. 실시간 고객 프로필 액세스 API를 사용하여 일괄 데이터가 데이터 세트에 로드될 때 이를 검색할 수 있습니다. 원하는 엔티티를 검색할 수 없는 경우 데이터 세트에 실시간 고객 프로필이 활성화되지 않을 수 있습니다. 데이터 세트가 활성화되었는지 확인한 후 소스 데이터 형식 및 식별자가 사용자의 기대를 지원하는지 확인하십시오. 실시간 고객 프로필 API를 사용하여 프로필 데이터에 액세스하는 방법에 대한 자세한 지침은 "프로필 액세스 API"라고도 하는 엔티티의 하위 안내서를 따르십시오 .

ID 서비스별 데이터 인제스트 확인

둘 이상의 ID를 포함하는 인제스트된 각 데이터 조각은 개인 ID 그래프에 링크를 만듭니다. ID 그래프 및 ID 데이터에 대한 자세한 내용은 ID 서비스 개요를 읽으십시오.