API를 사용하여 Profile 및 Identity Service에 대한 데이터 세트 활성화

이 튜토리얼에서는 Real-Time Customer Profile 및 Identity Service에서 사용할 데이터 집합을 활성화하는 프로세스를 다음 단계로 분류합니다.

시작하기

이 자습서에서는 프로필 사용 데이터 세트 관리와 관련된 여러 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의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서를 참조하십시오.

프로필 및 ID에 대해 활성화된 데이터 세트 만들기 create-a-dataset-enabled-for-profile-and-identity

데이터 세트를 만든 직후 또는 데이터 세트가 만들어진 후 언제든지 실시간 고객 프로필 및 ID 서비스에 대한 데이터 세트를 활성화할 수 있습니다. 이미 만들어진 데이터 집합을 사용하려면 이 문서의 뒷부분에 있는 기존 데이터 집합을 구성하는 단계를 수행합니다.

프로필에 대해 활성화된 데이터 세트를 만들려면 /dataSets 끝점에 대한 POST 요청을 사용할 수 있습니다.

API 형식

POST /dataSets

요청

tags 아래의 unifiedProfile 및 unifiedIdentity을(를) 요청 본문에 포함하면 Profile 및 Identity Service에 대해 데이터 세트가 즉시 활성화됩니다. 이러한 태그의 값은 문자열 "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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "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"]
    }
  }'

응답

성공한 응답은 새로 만든 데이터 세트의 ID가 포함된 배열을 "@/dataSets/{DATASET_ID}" 형식으로 표시합니다. 데이터 세트를 만들고 활성화했으면 데이터 업로드 단계를 진행하십시오.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

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

다음 단계에서는 Real-Time Customer Profile 및 Identity Service에 대해 이전에 만든 데이터 세트를 활성화하는 방법을 다룹니다. 이미 프로필이 활성화된 데이터 세트를 만든 경우 데이터 수집을 위한 단계를 진행하십시오.

데이터 세트가 활성화되어 있는지 확인 check-if-the-dataset-is-enabled

Catalog API를 사용하여 기존 데이터 세트를 검사하여 Real-Time Customer Profile 및 Identity Service에서 사용하도록 설정되었는지 확인할 수 있습니다. 다음 호출은 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": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "@/xdms/context/experienceevent",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

tags 속성에서 unifiedProfile과(와) unifiedIdentity이(가) 모두 값 enabled:true과(와) 함께 있음을 볼 수 있습니다. 따라서 이 데이터 세트에 대해 각각 Real-Time Customer Profile 및 Identity Service이(가) 활성화됩니다.

데이터 세트 활성화 enable-the-dataset

기존 데이터 세트가 Profile 또는 Identity Service에 대해 활성화되지 않은 경우 데이터 세트 ID를 사용하여 PATCH 요청을 수행하면 활성화할 수 있습니다.

API 형식

PATCH /dataSets/{DATASET_ID}

요청

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"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] }
      ]'

요청 본문에는 path - 두 가지 유형의 태그 unifiedProfile 및 unifiedIdentity이(가) 포함됩니다. 각 value은(는) 문자열 enabled:true을(를) 포함하는 배열입니다.

응답

성공적인 PATCH 요청은 HTTP 상태 200(OK)과 업데이트된 데이터 세트의 ID가 포함된 배열을 반환합니다. 이 ID는 PATCH 요청에서 전송된 ID와 일치해야 합니다. 이제 unifiedProfile 및 unifiedIdentity 태그가 추가되었으며 프로필 및 ID 서비스에서 데이터 세트를 사용할 수 있습니다.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

데이터 세트에 데이터 수집 ingest-data-into-the-dataset

Real-Time Customer Profile과(와) Identity Service은(는) 모두 XDM 데이터를 데이터 집합에 수집할 때 사용합니다. 데이터를 데이터 집합에 업로드하는 방법에 대한 지침은 API를 사용하여 데이터 집합 만들기에 대한 자습서를 참조하십시오. Profile이(가) 활성화된 데이터 세트에 보낼 데이터를 계획할 때 다음 모범 사례를 고려하십시오.

Real-Time Customer Profile의 데이터 수집 확인 confirm-data-ingest-by-real-time-customer-profile

데이터를 새 데이터 세트에 처음 업로드할 때, 또는 새 ETL 또는 데이터 소스를 포함하는 프로세스의 일부로 데이터를 예상대로 업로드했는지 주의 깊게 확인하는 것이 좋습니다. Real-Time Customer Profile Access API를 사용하면 일괄 처리 데이터를 데이터 세트로 로드할 때 검색할 수 있습니다. 예상한 엔터티를 검색할 수 없는 경우 Real-Time Customer Profile에 대해 데이터 집합을 사용할 수 없습니다. 데이터 세트가 활성화되었는지 확인한 후 소스 데이터 형식 및 식별자가 기대를 지원하는지 확인합니다. Real-Time Customer Profile API를 사용하여 Profile 데이터에 액세스하는 방법에 대한 자세한 지침은 "Profile Access" API라고도 하는 entities 끝점 안내서을(를) 참조하십시오.

ID 서비스에서 데이터 수집 확인 confirm-data-ingest-by-identity-service

두 개 이상의 ID를 포함하는 수집된 각 데이터 조각은 개인 ID 그래프에 링크를 만듭니다. ID 그래프와 ID 데이터 액세스에 대한 자세한 내용은 ID 서비스 개요를 읽는 것부터 시작하십시오.