스트리밍 수집 API를 사용하여 레코드 데이터 스트리밍
이 자습서는 Adobe Experience Platform Data Ingestion Service API의 일부인 수집 API 스트리밍을 사용하는 데 도움이 됩니다.
시작하기
이 자습서에서는 다양한 Adobe Experience Platform 서비스에 대한 작업 지식이 필요합니다. 이 자습서를 시작하기 전에 다음 서비스에 대한 설명서를 검토하십시오.
- Experience Data Model (XDM): Platform에서 경험 데이터를 구성하는 표준화된 프레임워크입니다.
- 스키마 레지스트리 개발자 안내서: Schema Registry API의 사용 가능한 각 끝점과 해당 끝점을 호출하는 방법을 다루는 포괄적인 안내서입니다. 여기에는 이 자습서 전체의 호출에 표시되는
{TENANT_ID}
에 대해 알고, 수집을 위한 데이터 세트를 만드는 데 사용되는 스키마를 만드는 방법에 대해 아는 것이 포함됩니다.
- 스키마 레지스트리 개발자 안내서: Schema Registry API의 사용 가능한 각 끝점과 해당 끝점을 호출하는 방법을 다루는 포괄적인 안내서입니다. 여기에는 이 자습서 전체의 호출에 표시되는
- Real-Time Customer Profile: 여러 원본에서 집계한 데이터를 기반으로 통합 소비자 프로필을 실시간으로 제공합니다.
Platform API 사용
Platform API를 성공적으로 호출하는 방법에 대한 자세한 내용은 Platform API 시작에 대한 안내서를 참조하십시오.
XDM Individual Profile 클래스를 기반으로 스키마 구성
데이터 집합을 만들려면 먼저 XDM Individual Profile 클래스를 구현하는 새 스키마를 만들어야 합니다. 스키마를 만드는 방법에 대한 자세한 내용은 스키마 레지스트리 API 개발자 안내서를 참조하십시오.
API 형식
POST /schemaregistry/tenant/schemas
요청
curl -X POST https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"type": "object",
"title": "Sample schema",
"description": "Sample description",
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/context/profile"
},
{
"$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
},
{
"$ref": "https://ns.adobe.com/xdm/context/profile-work-details"
}
],
"meta:immutableTags": [
"union"
]
}'
title
description
meta:immutableTags
union
태그를 사용하여 데이터를 Real-Time Customer Profile(으)로 유지합니다.응답
성공적인 응답은 새로 생성된 스키마의 세부 정보와 함께 HTTP 상태 201을 반환합니다.
{
"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
"meta:altId": "_{TENANT_ID}.schemas.{SCHEMA_ID}",
"meta:resourceType": "schemas",
"version": "1.0",
"type": "object",
"title": "Sample schema",
"description": "Sample description",
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/context/profile"
},
{
"$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
},
{
"$ref": "https://ns.adobe.com/xdm/context/profile-work-details"
}
],
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:abstract": false,
"meta:extensible": false,
"meta:extends": [
"https://ns.adobe.com/xdm/context/profile",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/xdm/cpmtext/identitymap",
"https://ns.adobe.com/xdm/common/extensible",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/xdm/context/profile-person-details",
"https://ns.adobe.com/xdm/context/profile-work-details"
],
"meta:immutableTags": [
"union"
],
"meta:containerId": "tenant",
"imsOrg": "{ORG_ID}",
"meta:xdmType": "object",
"meta:registryMetadata": {
"repo:createDate": 1551376506996,
"repo:lastModifiedDate": 1551376506996,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:repositoryCreatedBy": "{CREATED_BY}"
}
}
{TENANT_ID}
데이터 집합을 만들 때 $id
과(와) version
특성을 모두 사용하므로 이 특성을 적어 두십시오.
스키마에 대한 기본 ID 설명자 설정
그런 다음 작업 전자 메일 주소 특성을 기본 식별자로 사용하여 위에서 만든 스키마에 ID 설명자를 추가합니다. 이렇게 하면 다음 두 가지 사항이 변경됩니다.
-
회사 이메일 주소는 필수 필드가 됩니다. 즉, 이 필드 없이 전송된 메시지는 유효성 검사에 실패하고 수집되지 않습니다.
-
Real-Time Customer Profile은(는) 회사 전자 메일 주소를 식별자로 사용하여 해당 개인에 대한 자세한 정보를 결합합니다.
요청
curl -X POST https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"@type":"xdm:descriptorIdentity",
"xdm:sourceProperty":"/workEmail/address",
"xdm:property":"xdm:code",
"xdm:isPrimary":true,
"xdm:namespace":"Email",
"xdm:sourceSchema":"{SCHEMA_REF_ID}",
"xdm:sourceVersion":1
}
{SCHEMA_REF_ID}
$id
입니다. 다음과 같은 모습이어야 합니다. "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}"
응답
성공적인 응답은 스키마에 대해 새로 생성된 기본 ID 설명자에 대한 정보와 함께 HTTP 상태 201을 반환합니다.
{
"xdm:property": "xdm:code",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
"xdm:namespace": "Email",
"@type": "xdm:descriptorIdentity",
"xdm:sourceVersion": 1,
"xdm:isPrimary": true,
"xdm:sourceProperty": "/workEmail/address",
"@id": "17aaebfa382ce8fc0a40d3e43870b6470aab894e1c368d16",
"meta:containerId": "tenant",
"version": "1",
"imsOrg": "{ORG_ID}"
}
레코드 데이터에 대한 데이터 세트 만들기
스키마를 만든 후에는 레코드 데이터를 수집하기 위한 데이터 세트를 만들어야 합니다.
API 형식
POST /catalog/dataSets
요청
curl -X POST https://platform.adobe.io/data/foundation/catalog/dataSets \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d ' {
"name": "Dataset name",
"description": "Dataset description",
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID},
"contentType": "application/vnd.adobe.xed-full+json;version=1"
},
"tags": {
"unifiedIdentity": ["enabled:true"],
"unifiedProfile": ["enabled:true"]
}
}'
응답
성공한 응답은 HTTP 상태 201과 새로 만든 데이터 세트의 ID가 포함된 배열을 @/dataSets/{DATASET_ID}
형식으로 반환합니다.
[
"@/dataSets/5e30d7986c0cc218a85cee65
]
스트리밍 연결 만들기
스키마와 데이터 세트를 만든 후 스트리밍 연결을 만들 수 있습니다
스트리밍 연결 만들기에 대한 자세한 내용은 스트리밍 연결 만들기 자습서를 참조하십시오.
스트리밍 연결로 레코드 데이터 수집 ingest-data
데이터 세트 및 스트리밍 연결을 통해 XDM 형식의 JSON 레코드를 수집하여 레코드 데이터를 Platform (으)로 수집할 수 있습니다.
API 형식
POST /collection/{CONNECTION_ID}?syncValidation=true
{CONNECTION_ID}
inletId
값이 이전에 만들어졌습니다.syncValidation
true
(으)로 설정된 경우 요청이 성공적으로 전송되었는지 확인하기 위해 즉각적인 피드백에 사용할 수 있습니다. 기본적으로 이 값은 false
(으)로 설정됩니다. 이 쿼리 매개 변수를 true
(으)로 설정하면 요청이 CONNECTION_ID
당 분당 60회로 제한됩니다.요청
레코드 데이터를 스트리밍 연결로 수집하는 작업은 소스 이름을 사용하거나 사용하지 않고 수행할 수 있습니다.
아래 예제 요청은 소스 이름이 누락된 레코드를 Platform으로 수집합니다. 레코드에 소스 이름이 없는 경우 스트리밍 연결 정의에서 소스 ID가 추가됩니다.
curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID}?syncValidation=true \
-H "Cache-Control: no-cache" \
-H "Content-Type: application/json" \
-d '{
"header": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
},
"imsOrgId": "{ORG_ID}",
"datasetId": "{DATASET_ID}",
"flowId": "{FLOW_ID}",
},
"body": {
"xdmMeta": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"xdmEntity": {
"person": {
"name": {
"firstName": "Jane",
"middleName": "F",
"lastName": "Doe"
},
"birthDate": "1969-03-14",
"gender": "female"
},
"workEmail": {
"primary": true,
"address": "janedoe@example.com",
"type": "work",
"status": "active"
}
}
}
}'
소스 이름을 포함하려면 다음 예제를 통해 소스 이름을 포함하는 방법을 보여 줍니다.
"header": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
},
"imsOrgId": "{ORG_ID}",
"datasetId": "{DATASET_ID}",
"source": {
"name": "Sample source name"
}
}
응답
성공한 응답은 새로 스트리밍된 Profile의 세부 정보와 함께 HTTP 상태 200을 반환합니다.
{
"inletId": "{CONNECTION_ID}",
"xactionId": "1584479347507:2153:240",
"receivedTimeMs": 1584479347507,
"syncValidation": {
"status": "pass"
}
}
{CONNECTION_ID}
xactionId
receivedTimeMs
syncValidation.status
syncValidation=true
이(가) 추가되었으므로 이 값이 표시됩니다. 유효성 검사가 성공하면 상태는 pass
이(가) 됩니다.새로 수집된 레코드 데이터 검색
이전에 수집된 레코드의 유효성을 검사하려면 Profile Access API을(를) 사용하여 레코드 데이터를 검색할 수 있습니다.
schema.name
또는 relatedSchema.name
이(가) _xdm.context.profile
인 경우 Profile Access에서 모두 개의 관련 ID를 가져옵니다.API 형식
GET /access/entities
GET /access/entities?{QUERY_PARAMETERS}
GET /access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email
schema.name
entityId
entityIdNS
요청
다음 GET 요청으로 이전에 수집된 레코드 데이터를 검토할 수 있습니다.
curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email'\
-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}'
응답
성공적인 응답은 요청된 엔터티의 세부 정보와 함께 HTTP 상태 200을 반환합니다. 보시다시피, 이것은 이전에 성공적으로 수집된 레코드와 동일합니다.
{
"BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
"entityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
"mergePolicy": {
"id": "e161dae9-52f0-4c7f-b264-dc43dd903d56"
},
"sources": [
"5e30d7986c0cc218a85cee65"
],
"tags": [
"1580346827274:2478:215"
],
"identityGraph": [
"BVrqzwVv7o2p3naHvnsWpqZXv3KJgA"
],
"entity": {
"person": {
"name": {
"lastName": "Doe",
"middleName": "F",
"firstName": "Jane"
},
"gender": "female",
"birthDate": "1969-03-14"
},
"workEmail": {
"type": "work",
"address": "janedoe@example.com",
"status": "active",
"primary": true
},
"identityMap": {
"email": [
{
"id": "janedoe@example.com"
}
]
}
},
"lastModifiedAt": "2020-01-30T01:13:59Z"
}
}
다음 단계
이 문서를 읽으면 스트리밍 연결을 사용하여 레코드 데이터를 Platform (으)로 수집하는 방법을 이해할 수 있습니다. 다른 값으로 더 많은 호출을 하고 업데이트된 값을 검색해 볼 수 있습니다. 또한 Platform UI를 통해 수집된 데이터를 모니터링할 수 있습니다. 자세한 내용은 데이터 수집 모니터링 안내서를 참조하십시오.
일반적인 스트리밍 수집에 대한 자세한 내용은 스트리밍 수집 개요를 참조하십시오.