스트리밍 수집 API를 사용한 스트림 시계열 데이터

이 자습서는 Adobe Experience Platform Data Ingestion Service API의 일부인 스트리밍 수집 API를 사용하는 데 도움이 됩니다.

시작하기

이 자습서에서는 다양한 Adobe Experience Platform 서비스에 대한 작업 지식이 필요합니다. 이 자습서를 시작하기 전에 다음 서비스에 대한 설명서를 검토하십시오.

  • Experience Data Model (XDM): 경험 데이터를 Platform 구성하는 표준화된 프레임워크입니다.
  • Real-time Customer Profile: 여러 소스에서 집계된 데이터를 기반으로 통합된 소비자 프로필을 실시간으로 제공합니다.
  • 스키마 레지스트리 개발자 안내서: API의 사용 가능한 각 종단점 및 Schema Registry API를 호출하는 방법을 다루는 포괄적인 안내서입니다. 여기에는 이 자습서 전체에서 호출에 표시되는 {TENANT_ID}을 알고 있을 뿐만 아니라 수집을 위한 데이터 세트를 만드는 데 사용되는 스키마를 만드는 방법을 아는 것도 포함됩니다.

또한 이 자습서에서는 스트리밍 연결을 이미 만들어야 합니다. 스트리밍 연결 만들기에 대한 자세한 내용은 스트리밍 연결 자습서 만들기를 참조하십시오.

다음 섹션에서는 스트리밍 수집 API를 성공적으로 호출하기 위해 알고 있어야 하는 추가 정보를 제공합니다.

샘플 API 호출 읽기

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

필수 헤더에 대한 값을 수집합니다

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

  • 권한 부여: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform의 모든 리소스는 특정 가상 샌드박스로 구분됩니다. Platform API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 헤더가 필요합니다.

  • x-sandbox-name: {SANDBOX_NAME}
노트

Platform의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서를 참조하십시오.

페이로드(POST, PUT, PATCH)이 포함된 모든 요청에는 추가 헤더가 필요합니다.

  • 컨텐츠 유형: application/json

XDM ExperienceEvent 클래스를 기반으로 스키마를 작성합니다

데이터 집합을 만들려면 먼저 XDM ExperienceEvent 클래스를 구현하는 새 스키마를 만들어야 합니다. 스키마를 만드는 방법에 대한 자세한 내용은 스키마 레지스트리 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "type": "object",
    "title": "{SCHEMA_NAME}",
    "description": "{SCHEMA_DESCRIPTION}",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce"
        },
        {  
         "$ref":"https://ns.adobe.com/experience/campaign/experienceevent-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",
    "type": "object",
    "title": "{SCHEMA_NAME}",
    "description": "{SCHEMA_DESCRIPTION}",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details",
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "refs": [
        "https://ns.adobe.com/xdm/context/experienceevent-commerce",
        "https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details",
        "https://ns.adobe.com/xdm/context/experienceevent-environment-details",
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "imsOrg": "{IMS_ORG}",
    "meta:immutableTags": [
        "union"
    ],
    "meta:class": "https://ns.adobe.com/xdm/context/experienceevent",
    "required": [
        "@id",
        "xdm:timestamp"
    ],
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/xdm/context/experienceevent",
        "https://ns.adobe.com/xdm/data/time-series",
        "https://ns.adobe.com/xdm/context/identitymap",
        "https://ns.adobe.com/xdm/context/experienceevent-environment-details",
        "https://ns.adobe.com/xdm/context/experienceevent-commerce",
        "https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{IMS_ORG}",
    "meta:xdmType": "object",
    "meta:class": "https://ns.adobe.com/xdm/context/experienceevent",
    "meta:registryMetadata": {
        "repo:createDate": 1551229957987,
        "repo:lastModifiedDate": 1551229957987,
        "xdm:createdClientId": "{CLIENT_ID}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    },
    "meta:tenantNamespace": "{NAMESPACE}"
}
속성 설명
{TENANT_ID} 이 ID는 사용자가 만드는 리소스가 제대로 식별되고 IMS 조직 내에 포함되어 있는지 확인하는 데 사용됩니다. 테넌트 ID에 대한 자세한 내용은 스키마 레지스트리 안내서를 참조하십시오.

데이터 세트를 만들 때 이 두 속성 모두 사용되므로 $idversion 속성을 적어 두십시오.

스키마에 대한 기본 ID 설명자 설정

그런 다음 작업 전자 메일 주소 속성을 기본 식별자로 사용하여 위에서 만든 스키마에 ID 설명자를 추가합니다. 이렇게 하면 두 가지 변경 사항이 발생합니다.

  1. 작업 이메일 주소는 필수 필드가 됩니다. 즉, 이 필드 없이 전송된 메시지는 유효성 검사에 실패하며 수집되지 않습니다.

  2. 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "@type":"xdm:descriptorIdentity",
    "xdm:sourceProperty":"/_experience/campaign/message/profileSnapshot/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 네임스페이스 코드

코드가 유효한지 확인하십시오. 위의 예에서는 표준 ID 네임스페이스인 "email"을 사용합니다. 일반적으로 사용되는 다른 표준 ID 네임스페이스는 ID 서비스 FAQ에서 찾을 수 있습니다.

사용자 지정 네임스페이스를 만들려면 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": "/_experience/campaign/message/profileSnapshot/workEmail/address",
    "@id": "ec31c09e0906561861be5a71fcd964e29ebe7923b8eb0d1e",
    "meta:containerId": "tenant",
    "version": "1",
    "imsOrg": "{IMS_ORG}"
}

시계열 데이터에 대한 데이터 세트 만들기

스키마를 만들면 레코드 데이터를 수집하기 위한 데이터 세트를 만들어야 합니다.

노트

이 데이터 집합은 적절한 태그를 설정하여 Real-time Customer ProfileIdentity​에 대해 활성화됩니다.

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "{DATASET_NAME}",
    "description": "{DATASET_DESCRIPTION}",
    "schemaRef": {
        "id": "{SCHEMA_REF_ID}",
        "contentType": "application/vnd.adobe.xed-full+json;version=1"
    },
    "tags": {
        "unifiedIdentity": ["enabled:true"],
        "unifiedProfile": ["enabled:true"]
    }
}'

응답

성공적인 응답은 HTTP 상태 201을 반환하고 새로 생성된 데이터 세트의 ID를 @/dataSets/{DATASET_ID} 형식으로 포함하는 배열을 반환합니다.

[
    "@/dataSets/5e72608b10f6e318ad2dee0f"
]

스트리밍 연결 만들기

스키마 및 데이터 세트를 만든 후 데이터를 수집하려면 스트리밍 연결을 만들어야 합니다.

스트리밍 연결 만들기에 대한 자세한 내용은 스트리밍 연결 자습서 만들기를 참조하십시오.

스트리밍 연결에 시계열 데이터 수집

데이터 세트, 스트리밍 연결 및 데이터 흐름을 만들 때 XDM 형식 JSON 레코드를 수집하여 Platform 내에서 시계열 데이터를 수집할 수 있습니다.

API 형식

POST /collection/{CONNECTION_ID}?syncValidation=true
매개 변수 설명
{CONNECTION_ID} 새로 만든 스트리밍 연결의 id 값입니다.
syncValidation 개발을 목적으로 하는 선택적 쿼리 매개 변수입니다. true으로 설정하면, 즉시 피드백에 사용하여 요청이 성공적으로 전송되었는지 확인할 수 있습니다. 기본적으로 이 값은 false(으)로 설정됩니다. 이 쿼리 매개 변수를 true로 설정하면 CONNECTION_ID당 분당 60회로 제한됩니다.

요청

스트리밍 연결에 시계열 데이터를 섭취하는 작업은 소스 이름을 사용하거나 사용하지 않고 수행할 수 있습니다.

아래 예제 요청은 소스 이름이 누락된 시계열 데이터를 Platform에 수집합니다. 데이터에 소스 이름이 없으면 스트리밍 연결 정의에서 소스 ID를 추가합니다.

중요

고유한 xdmEntity._idxdmEntity.timestamp을(를) 생성해야 합니다. ID를 생성하는 좋은 방법은 데이터 준비에서 UUID 함수를 사용하는 것입니다. UUID 함수에 대한 자세한 내용은 데이터 준비 함수 안내서에서 확인할 수 있습니다. xdmEntity._id 속성은 레코드 자체에 대한 고유 식별자를 나타냅니다.이 아닌​레코드 자체의 고유 ID를 나타냅니다. 개인 또는 장치 ID는 스키마의 개인 또는 장치 식별자로 지정된 모든 속성에 한정됩니다.

xdmEntity._idxdmEntity.timestamp 모두 시계열 데이터에 필요한 유일한 필드입니다. 또한 다음 API 호출은 에 인증 헤더가 필요하지 않습니다.

curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID}?syncValidation=true \
  -H "Content-Type: application/json" \
  -d '{
    "header": {
        "schemaRef": {
            "id": "{SCHEMA_REF_ID}",
            "contentType": "application/vnd.adobe.xed-full+json;version=1"
        },
        "flowId": "{FLOW_ID}",
        "datasetId": "{DATASET_ID}"
    },
    "body": {
        "xdmMeta": {
            "schemaRef": {
                "id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
                "contentType": "application/vnd.adobe.xed-full+json;version=1"
            }
        },
        "xdmEntity":{
            "_id": "9af5adcc-db9c-4692-b826-65d3abe68c22",
            "timestamp": "2019-02-23T22:07:01Z",
            "environment": {
                "browserDetails": {
                    "userAgent": "Mozilla\/5.0 (Windows NT 5.1) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/29.0.1547.57 Safari\/537.36 OPR\/16.0.1196.62",
                    "acceptLanguage": "en-US",
                    "cookiesEnabled": true,
                    "javaScriptVersion": "1.6",
                    "javaEnabled": true
                },
                "colorDepth": 32,
                "viewportHeight": 799,
                "viewportWidth": 414
            },
            "productListItems": [
                {
                    "SKU": "CC",
                    "name": "Fernie Snow",
                    "quantity": 30,
                    "priceTotal": 7.8
                }
            ],
            "commerce": {
                "productViews": {
                    "value": 1
                }
            },
            "_experience": {
                "campaign": {
                    "message": {
                        "profileSnapshot": {
                            "workEmail":{
                                "address": "janedoe@example.com"
                            }
                        }
                    }
                }
            }
        }
    }
}'

소스 이름을 포함하려는 경우 다음 예에서는 소스 이름을 포함하는 방법을 보여줍니다.

    "header": {
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
            "contentType": "application/vnd.adobe.xed-full+json;version=1"
        },
        "imsOrgId": "{IMS_ORG}",
        "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} 이전에 만든 스트리밍 연결의 inletId.
xactionId 방금 보낸 레코드에 대해 서버 측에서 생성된 고유 식별자입니다. 이 ID는 Adobe이 다양한 시스템과 디버깅을 통해 이 레코드의 라이프사이클을 추적하는 데 도움이 됩니다.
receivedTimeMs: 요청을 받은 시간을 보여주는 타임스탬프(밀리초 단위)입니다.
syncValidation.status 쿼리 매개 변수 syncValidation=true이 추가되었으므로 이 값이 나타납니다. 유효성 검사에 성공하면 상태는 pass입니다.

새로 수집된 시계열 데이터 검색

이전에 수집된 레코드의 유효성을 검사하려면 Profile Access API 을 사용하여 시계열 데이터를 검색할 수 있습니다. 이 작업은 /access/entities 종단점에 대한 GET 요청을 사용하고 선택적 쿼리 매개 변수를 사용하여 수행할 수 있습니다. 여러 매개 변수를 앰퍼샌드(&)로 구분하여 사용할 수 있습니다."

노트

병합 정책 ID가 정의되지 않고 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.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=janedoe@example.com&relatedEntityIdNS=email
매개 변수 설명
schema.name 필수 여부. 액세스하는 스키마의 이름입니다.
relatedSchema.name 필수 여부. 에 액세스할 수 있으므로 _xdm.context.experienceevent이 값은 시계열 이벤트와 관련된 프로필 엔티티의 스키마를 지정합니다.
relatedEntityId 관련 엔티티의 ID입니다. 제공된 경우 엔티티 네임스페이스도 제공해야 합니다.
relatedEntityIdNS 검색하려는 ID의 네임스페이스입니다.

요청

curl -X GET \
  https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=janedoe@example.com&relatedEntityIdNS=email \
  -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}"

응답

성공한 응답은 요청한 엔티티의 세부 정보와 함께 HTTP 상태 200을 반환합니다. 보시다시피 이전에 수집된 시간과 시리즈 데이터가 동일합니다.

{
    "_page": {
        "orderby": "timestamp",
        "start": "9af5adcc-db9c-4692-b826-65d3abe68c22",
        "count": 1,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
            "entityId": "9af5adcc-db9c-4692-b826-65d3abe68c22",
            "timestamp": 1582495621000,
            "entity": {
                "environment": {
                    "browserDetails": {
                        "javaScriptVersion": "1.6",
                        "cookiesEnabled": true,
                        "userAgent": "Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/29.0.1547.57 Safari/537.36 OPR/16.0.1196.62",
                        "acceptLanguage": "en-US",
                        "javaEnabled": true
                    },
                    "colorDepth": 32,
                    "viewportHeight": 799,
                    "viewportWidth": 414
                },
                "_id": "9af5adcc-db9c-4692-b826-65d3abe68c22",
                "commerce": {
                    "productViews": {
                        "value": 1
                    }
                },
                "productListItems": [
                    {
                        "name": "Fernie Snow",
                        "quantity": 30,
                        "SKU": "CC",
                        "priceTotal": 7.8
                    }
                ],
                "_experience": {
                    "campaign": {
                        "message": {
                            "profileSnapshot": {
                                "workEmail": {
                                    "address": "janedoe@example.com"
                                }
                            }
                        }
                    }
                },
                "timestamp": "2020-02-23T22:07:01Z"
            },
            "lastModifiedAt": "2020-03-18T18:51:19Z"
        }
    ],
    "_links": {
        "next": {
            "href": ""
        }
    }
}

다음 단계

이 문서를 읽은 후에는 스트리밍 연결을 사용하여 레코드 데이터를 Platform에 수집하는 방법을 이해할 수 있습니다. 다른 값으로 더 많은 호출을 수행하고 업데이트된 값을 검색해 볼 수 있습니다. 또한 Platform UI를 통해 수집된 데이터 모니터링을 시작할 수 있습니다. 자세한 내용은 데이터 수집 모니터링 안내서를 참조하십시오.

일반적으로 스트리밍 수집에 대한 자세한 내용은 스트리밍 수집 개요를 참조하십시오.

이 페이지에서는