Flow Service API를 사용하여 LAVA 데이터를 스트리밍할 소스 연결 및 데이터 흐름을 만드십시오.
시작
이 안내서를 사용하려면 Experience Platform의 다음 구성 요소에 대해 이해하고 있어야 합니다.
TIP
이 자습서를 시작하기 전에 LAVA 소스 커넥터 개요를 검토하여 모든 필수 구성 요소를 충족하는지 확인하십시오.
LAVA 패키지 로드
LAVA은(는) Experience Platform에서 LAVA을(를) 사용하기 위한 권장 필드 그룹, 스키마, id 네임스페이스 및 데이터 세트를 포함하는 패키지를 제공합니다. 이러한 패키지의 사용이 권장되지만 필수는 아닙니다.
이 섹션을 참조하여 샌드박스로 가져오고 이후 단계에 필요한 ID를 가져오는 방법을 알아보십시오.
API 형식
POST /transfer/pullRequest
요청
다음 요청은 LAVA에 대한 패키지를 로드합니다.
curl -X POST \
'https://platform.adobe.io/data/foundation/exim/transfer/pullRequest' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"imsOrgId": "1EF71E43679AAD1E0A495C77@AdobeOrg",
"packageId": "416a0c2a32794092aa1a957cbe9a6698"
}'
속성
설명
유형
필수 여부
imsOrgId패키지의 소스 조직 ID입니다.
1EF71E43679AAD1E0A495C77@AdobeOrg이어야 합니다.문자열
예
packageId가져올 패키지의 ID입니다.
416a0c2a32794092aa1a957cbe9a6698이어야 합니다.문자열
예
응답
성공한 응답은 가져온 공개 패키지에 대한 세부 정보를 반환합니다.
{
"id": "{ID}",
"version": 0,
"createdDate": 1729658890425,
"modifiedDate": 1729658890425,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}",
"sourceIMSOrgId": "{ORG_ID}",
"targetIMSOrgId": "{TARGET_ID}",
"packageId": "{PACKAGE_ID}",
"status": "PENDING",
"initiatedBy": "{INITIATED_BY}",
"pipelineMessageId": "{MESSAGE_ID}",
"requestType": "PUBLIC"
}
스키마 검색
패키지를 가져온 후 LAVA Events 및 LAVA Profile 스키마를 검색하십시오.
요청
curl -X GET \
'https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas?name=LAVA*' \
-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}}' \
-H 'Accept: application/vnd.adobe.xed-id+json'
응답
성공적인 응답이 스키마 목록을 반환합니다. 이후 단계에서 이러한 ID를 대상 XDM 스키마로 사용합니다.
{
"results": [
...
{
"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/7ff102f217d394e8beff48dcc2c27baae14e28e210d36492",
"meta:altId": "_{TENANT_ID}.schemas.7ff102f217d394e8beff48dcc2c27baae14e28e210d36492",
"version": "1.4",
"title": "LAVA Events"
},
{
"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/991bed7f1d94ccf47bd392bc345ee51e7e0bd19b1de3dbff",
"meta:altId": "_{TENANT_ID}.schemas.991bed7f1d94ccf47bd392bc345ee51e7e0bd19b1de3dbff",
"version": "1.2",
"title": "LAVA Profile"
},
//...
]
}
데이터 세트 검색
그런 다음 다음 호출을 사용하여 데이터 세트 ID를 검색합니다.
요청
curl -X GET \
'https://platform.adobe.io/data/foundation/catalog/dataSets?name=LAVA*' \
-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}}' \
-H 'Accept: application/json'
응답
{
"6920eb494131bfcc10305302": {
"id": "6920eb494131bfcc10305302",
"name": "LAVA Member Profiles",
//...
},
"6920eb7565bd3ed93a35cd0e": {
"id": "6920eb7565bd3ed93a35cd0e",
"name": "LAVA Member Rewards",
//...
},
"6924aecd8d9c85e2d56261e3": {
"id": "6924aecd8d9c85e2d56261e3",
"name": "LAVA Events",
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/7ff102f217d394e8beff48dcc2c27baae14e28e210d36492",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
},
//...
}
}
Flow Service API를 사용하여 LAVA을(를) Experience Platform에 연결
다음 자습서에서는 Flow Service API를 사용하여 LAVA 데이터를 Experience Platform으로 가져오기 위해 LAVA 소스 연결을 만들고 데이터 흐름을 만드는 단계를 안내합니다.
소스 연결 만들기 source-connection
소스의 연결 사양 ID, 이름 및 설명과 같은 세부 정보 및 데이터 형식을 제공하면서 Flow Service API에 대한 POST 요청을 수행하여 소스 연결을 만듭니다.
API 형식
POST /sourceConnections
요청
다음 요청은 LAVA에 대한 소스 연결을 만듭니다.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Streaming Source Connection for a Streaming SDK source",
"description": "Streaming Source Connection for a Streaming SDK source",
"connectionSpec": {
"id": "232dfabe-27aa-41c0-a7cf-9961661dc68b",
"version": "1.0"
},
"data": {
"format": "json"
}
}'
속성
설명
name소스 연결의 이름입니다. 소스 연결에 대한 정보를 조회할 때 소스 연결의 이름이 설명적인지 확인합니다.
description소스 연결에 대한 자세한 정보를 제공하기 위해 포함할 수 있는 선택적 값입니다.
connectionSpec.id소스에 해당하는 연결 사양 ID. LAVA의 경우
232dfabe-27aa-41c0-a7cf-9961661dc68b이어야 합니다.data.format수집할 LAVA 데이터의 형식입니다. 현재 지원되는 데이터 형식은
json뿐입니다.응답
성공한 응답은 새로 만든 원본 연결의 고유 식별자(id)를 반환합니다. 이 ID는 데이터 흐름을 만들기 위해 이후 단계에서 필요합니다.
{
"id": "246d052c-da4a-494a-937f-a0d17b1c6cf5",
"etag": "\"712a8c08-fda7-41c2-984b-187f823293d8\""
}
대상 XDM 스키마 만들기 target-schema
IMPORTANT
대상 XDM 스키마가 포함되어 있으므로 LAVA 패키지를 가져온 경우 건너뜁니다.
소스 데이터를 Experience Platform에서 사용하려면 타겟 스키마를 만들어 필요에 따라 소스 데이터를 구조화해야 합니다. 그런 다음 대상 스키마를 사용하여 소스 데이터가 포함된 Experience Platform 데이터 세트를 만듭니다. 멤버 잔액과 티켓 스캔 이벤트와 같은 여러 LAVA 데이터 세트를 사용하는 경우 두 개 이상의 대상 XDM 스키마를 원하거나 필요로 할 수 있습니다.
스키마 레지스트리 API에 대한 POST 요청을 수행하여 대상 XDM 스키마를 만들 수 있습니다.
대상 XDM 스키마를 만드는 방법에 대한 자세한 단계는 API를 사용하여 스키마 만들기에 대한 자습서를 참조하십시오.
타겟 데이터 세트 만들기 target-dataset
IMPORTANT
이미 LAVA 패키지를 가져온 경우 패키지는 대상 XDM 데이터 세트를 제공하므로 이 단계를 건너뛸 수 있습니다. 그러나 LAVA개의 데이터 세트가 여러 개 필요한 경우(예: 멤버 잔액에 대한 데이터 세트 및 티켓 검색 이벤트에 대한 데이터 세트) 필요에 따라 추가 대상 데이터 세트를 만들어야 합니다.
카탈로그 서비스 API에 대한 POST 요청을 수행하여 페이로드 내에 대상 스키마의 ID를 제공하여 대상 데이터 집합을 만들 수 있습니다.
대상 데이터 집합을 만드는 방법에 대한 자세한 단계는 API를 사용하여 데이터 집합 만들기에 대한 자습서를 참조하십시오.
대상 연결 만들기 target-connection
대상 연결은 수집된 데이터를 저장할 대상에 대한 연결을 나타냅니다. 대상 연결을 만들려면 데이터 레이크에 해당하는 고정 연결 사양 ID를 제공해야 합니다. 이 ID: c604ff05-7f1a-43c0-8e18-33bf874cb11c.
이제 대상 스키마에 대한 고유 식별자, 대상 데이터 세트 및 데이터 레이크에 대한 연결 사양 ID가 있습니다. 이러한 식별자를 사용하여 Flow Service API를 사용하여 대상 연결을 만들어 인바운드 원본 데이터를 포함할 데이터 집합을 지정할 수 있습니다.
API 형식
POST /targetConnections
요청
다음 요청은 LAVA에 대한 대상 연결을 만듭니다.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Streaming Target Connection for a Streaming SDK source",
"description": "Streaming Target Connection for a Streaming SDK source",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "json",
"schema": {
"id": "{TARGET_XDM_SCHEMA}",
"version": "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "{TARGET_DATASET}"
}
}'
속성
설명
name대상 연결의 이름입니다. 대상 연결에 대한 정보를 찾을 때 사용할 수 있으므로 대상 연결의 이름이 설명적인지 확인하십시오.
description대상 연결에 대한 자세한 정보를 제공하기 위해 포함할 수 있는 선택적 값입니다.
connectionSpec.id데이터 레이크에 해당하는 연결 사양 ID입니다. 이 고정 ID는
c604ff05-7f1a-43c0-8e18-33bf874cb11c입니다.data.formatExperience Platform으로 가져올 LAVA 데이터의 형식입니다.
params.dataSetId이전 단계에서 검색된 대상 데이터 세트 ID입니다.
응답
응답이 성공하면 새 대상 연결의 고유 식별자(id)가 반환됩니다. 이 ID는 이후 단계에서 필수입니다.
{
"id": "7c96c827-3ffd-460c-a573-e9558f72f263",
"etag": "\"a196f685-f5e8-4c4c-bfbd-136141bb0c6d\""
}
매핑 만들기 mapping
소스 데이터를 타겟 데이터 세트에 수집하려면 먼저 타겟 데이터 세트가 준수하는 타겟 스키마에 매핑해야 합니다. 요청 페이로드 내에 정의된 데이터 매핑을 사용하여 Data Prep API에 대한 POST 요청을 수행하면 됩니다.
LAVA에서 제공한 스키마를 사용하는 경우 다음 매핑을 권장합니다.
구성원 프로필
| code language-json |
|---|
|
구성원 균형
| code language-json |
|---|
|
결합된 이벤트
| code language-json |
|---|
|
티켓 검사 이벤트
| code language-json |
|---|
|
트랜잭션 이벤트
| code language-json |
|---|
|
원장 이벤트
| code language-json |
|---|
|
API 형식
POST /conversion/mappingSets
요청
curl -X POST \
'https://platform.adobe.io/data/foundation/mappingSets' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"version": 0,
"xdmSchema": "{TARGET_XDM_SCHEMA}",
"xdmVersion": "1.0",
"mappings": [
{
"destinationXdmPath": "_{TENANT_ID}.lavaId",
"sourceAttribute": "lavaId",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_{TENANT_ID}.balances",
"sourceAttribute": "balances",
"identity": false,
"version": 0
}
]
}'
속성
설명
xdmSchema이전 단계에서 생성된 대상 XDM 스키마의 ID입니다.
mappings.destinationXdmPath소스 속성이 매핑되는 대상 XDM 경로.
mappings.sourceAttribute대상 XDM 경로에 매핑해야 하는 소스 속성입니다.
mappings.identity매핑 집합이 Identity Service에 대해 표시되는지 여부를 지정하는 부울 값입니다.
응답
성공한 응답은 고유 식별자(id)를 포함하여 새로 만든 매핑의 세부 정보를 반환합니다. 이 값은 데이터 흐름을 만들기 위해 이후 단계에서 필요합니다.
{
"id": "bf5286a9c1ad4266baca76ba3adc9366",
"version": 0,
"createdDate": 1597784069368,
"modifiedDate": 1597784069368,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
플로우 만들기 flow
LAVA에서 Experience Platform으로 데이터를 가져오는 마지막 단계는 데이터 흐름을 만드는 것입니다. 이제 다음 필수 값이 준비되었습니다.
데이터 흐름은 소스에서 데이터를 예약하고 수집합니다. 페이로드 내에 이전에 언급된 값을 제공하면서 POST 요청을 수행하여 데이터 흐름을 만들 수 있습니다.
API 형식
POST /flows
요청
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Streaming Dataflow for a Streaming SDK source",
"description": "Streaming Dataflow for a Streaming SDK source",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"sourceConnectionIds": [
"246d052c-da4a-494a-937f-a0d17b1c6cf5"
],
"targetConnectionIds": [
"7c96c827-3ffd-460c-a573-e9558f72f263"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "bf5286a9c1ad4266baca76ba3adc9366",
"mappingVersion": 0
}
}
]
}'
속성
설명
name데이터 흐름의 이름입니다. 이 옵션을 사용하여 데이터 흐름에서 정보를 조회할 수 있으므로 데이터 흐름의 이름이 설명적인지 확인하십시오.
description데이터 흐름에 대한 자세한 정보를 제공하기 위해 포함할 수 있는 선택적 값입니다.
flowSpec.id데이터 흐름을 만드는 데 필요한 흐름 사양 ID입니다. 이 고정 ID는
e77fde5a-22a8-11ed-861d-0242ac120002입니다.flowSpec.version흐름 사양 ID의 해당 버전. 이 값은 기본적으로
1.0입니다.sourceConnectionIds이전 단계에서 생성된 소스 연결 ID입니다.
targetConnectionIds이전 단계에서 생성된 대상 연결 ID입니다.
transformations이 속성에는 데이터에 적용해야 하는 다양한 변형이 포함되어 있습니다. 이 속성은 XDM 규격이 아닌 데이터를 Experience Platform으로 가져올 때 필요합니다.
transformations.name변환에 지정된 이름입니다.
transformations.params.mappingId이전 단계에서 생성된 매핑 ID입니다.
transformations.params.mappingVersion매핑 ID의 해당 버전. 이 값은 기본적으로
0입니다.응답
성공한 응답은 새로 만든 데이터 흐름의 ID(id)를 반환합니다. 이 ID를 사용하여 데이터 흐름을 모니터링, 업데이트 또는 삭제할 수 있습니다.
{
"id": "993f908f-3342-4d9c-9f3c-5aa9a189ca1a",
"etag": "\"510bb1d4-8453-4034-b991-ab942e11dd8a\""
}
스트리밍 끝점 URL 가져오기
데이터 흐름이 만들어지면 이제 스트리밍 끝점 URL을 검색할 수 있습니다. 이 끝점 URL을 사용하여 소스를 웹후크에 구독하므로 소스가 Experience Platform과 통신할 수 있습니다.
스트리밍 끝점 URL을 검색하려면 /flows 끝점에 대한 GET 요청을 만들고 데이터 흐름의 ID를 제공하십시오.
API 형식
GET /flows/{FLOW_ID}
요청
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/flows/993f908f-3342-4d9c-9f3c-5aa9a189ca1a' \
-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}'
응답
응답이 inletUrl(으)로 표시된 엔드포인트 URL을 포함하여 데이터 흐름에 대한 정보를 반환합니다.
{
"items": [
{
"id": "993f908f-3342-4d9c-9f3c-5aa9a189ca1a",
"createdAt": 1669238699119,
"updatedAt": 1669238699119,
"createdBy": "acme@AdobeID",
"updatedBy": "acme@AdobeID",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "{ORG_ID}",
"name": "Streaming Dataflow for a Streaming SDK source",
"description": "Streaming Dataflow for a Streaming SDK source",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"state": "enabled",
"version": "\"a1011225-0000-0200-0000-63c78ae60000\"",
"etag": "\"a1011225-0000-0200-0000-63c78ae60000\"",
"sourceConnectionIds": [
"246d052c-da4a-494a-937f-a0d17b1c6cf5"
],
"targetConnectionIds": [
"7c96c827-3ffd-460c-a573-e9558f72f263"
],
"inheritedAttributes": {
"properties": {
"isSourceFlow": true
},
"sourceConnections": [
{
"id": "246d052c-da4a-494a-937f-a0d17b1c6cf5",
"connectionSpec": {
"id": "bdb5b792-451b-42de-acf8-15f3195821de",
"version": "1.0"
}
}
],
"targetConnections": [
{
"id": "7c96c827-3ffd-460c-a573-e9558f72f263",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"options": {
"errorDiagnosticsEnabled": true,
"inletUrl": "https://dcs-int.adobedc.net/collection/ab65636c31778fb0455c439ffb48a5433a34d443f4c83c4b5beda9c5688797c5"
},
"transformations": [
{
"name": "Mapping",
"params": {
"mappingVersion": 0,
"mappingId": "bf5286a9c1ad4266baca76ba3adc9366"
}
}
],
"runs": "/runs?property=flowId==e1514b79-f031-43b4-aab5-381a42f86ad4",
"providerRefId": "c9809ab5-71e0-4c7f-887b-61c95e4e20b5",
"lastOperation": {
"started": 0,
"updated": 0,
"operation": "enable"
}
}
]
}
LAVA을(를) Webhook과 통합
LAVA 콘솔에서 Resources > Data Export로 이동합니다.
Create New Export를 선택합니다. Adobe Source Connector을(를) 대상 유형으로 선택하고 전송하려는 원본 데이터를 선택하십시오. 스트리밍 끝점 URL 및 데이터 흐름 ID를 사용합니다.
부록
다음 섹션에서는 데이터 흐름을 모니터링, 업데이트 및 삭제하는 데 사용할 수 있는 단계에 대한 정보를 제공합니다.
데이터 흐름 모니터링
데이터 흐름이 만들어지면 데이터 흐름을 통해 수집되는 데이터를 모니터링하여 흐름 실행, 완료 상태 및 오류에 대한 정보를 볼 수 있습니다. 전체 API 예제는 API를 사용하여 소스 데이터 흐름 모니터링에 대한 안내서를 참조하십시오.
데이터 흐름 업데이트
데이터 흐름의 ID를 제공하면서 Flow Service API의 /flows 끝점에 PATCH 요청을 수행하여 데이터 흐름의 이름, 설명, 실행 일정 및 관련 매핑 세트와 같은 데이터 흐름의 세부 정보를 업데이트합니다. PATCH 요청을 할 때는 If-Match 헤더에 데이터 흐름의 고유한 etag을(를) 제공해야 합니다. 전체 API 예제는 API를 사용하여 소스 데이터 흐름을 업데이트하는 방법에 대한 안내서를 참조하십시오.
계정 업데이트
기본 연결 ID를 쿼리 매개 변수로 제공하면서 Flow Service API에 대한 PATCH 요청을 수행하여 소스 계정의 이름, 설명 및 자격 증명을 업데이트합니다. PATCH을 요청할 때 If-Match 헤더에 소스 계정의 고유 etag을(를) 제공해야 합니다. 전체 API 예제는 API를 사용하여 소스 계정을 업데이트하는 방법에 대한 안내서를 참조하십시오.
데이터 흐름 삭제
쿼리 매개 변수의 일부로 삭제할 데이터 흐름의 ID를 제공하면서 Flow Service API에 대한 DELETE 요청을 수행하여 데이터 흐름을 삭제합니다. 전체 API 예제는 API를 사용하여 데이터 흐름 삭제에 대한 안내서를 참조하십시오.
계정 삭제
삭제할 계정의 기본 연결 ID를 제공하는 동안 Flow Service API에 대한 DELETE 요청을 수행하여 계정을 삭제합니다. 전체 API 예제는 API를 사용하여 소스 계정 삭제에 대한 안내서를 참조하십시오.
recommendation-more-help
experience-platform-help-sources