스트리밍 수집 유효성 검사

스트리밍 수집을 사용하면 스트리밍 끝점을 사용하여 실시간으로 Adobe Experience Platform에 데이터를 업로드할 수 있습니다. 스트리밍 수집 API는 동기 및 비동기 두 가지 유효성 검사 모드를 지원합니다.

시작하기

이 안내서를 사용하려면 Adobe Experience Platform의 다음 구성 요소에 대해 이해하고 있어야 합니다.

샘플 API 호출 읽기

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

필수 헤더에 대한 값 수집

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

  • 인증: 전달자 {ACCESS_TOKEN}
  • x-api 키: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

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

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Platform의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서를 참조하십시오.

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

  • Content-Type: application/json

유효성 검사 범위

Streaming Validation Service은(는) 다음 영역에서 유효성 검사를 다룹니다.

  • 범위
  • 현재 상태
  • 열거형
  • 패턴
  • 유형
  • 형식

동기 유효성 검사

동기 유효성 검사는 수집이 실패한 이유에 대한 즉각적인 피드백을 제공하는 유효성 검사 방법입니다. 그러나 실패 시 유효성 검사에 실패한 레코드는 삭제되고 다운스트림으로 전송되지 않습니다. 따라서 동기 유효성 검사는 개발 프로세스 중에만 사용해야 합니다. 동기 유효성 검사를 수행할 때 호출자에게 XDM 유효성 검사 결과와 실패한 경우 실패 이유를 모두 알려 줍니다.

기본적으로 동기 유효성 검사는 설정되어 있지 않습니다. 활성화하려면 API를 호출할 때 선택적 쿼리 매개 변수 syncValidation=true을(를) 전달해야 합니다. 또한 현재 스트림 종단점이 VA7 데이터 센터에 있는 경우에만 동기 유효성 검사를 사용할 수 있습니다.

NOTE
syncValidation 쿼리 매개 변수는 단일 메시지 끝점에만 사용할 수 있으며 일괄 처리 끝점에는 사용할 수 없습니다.

동기 유효성 검사 중에 메시지가 실패하면 출력 큐에 메시지가 기록되지 않고 사용자에게 즉시 피드백을 제공합니다.

NOTE
변경 사항이 캐시되므로 스키마 변경 사항을 즉시 사용할 수 없습니다. 캐시를 새로 고치는 데 최대 15분이 소요됩니다.

API 형식

POST /collection/{CONNECTION_ID}?syncValidation=true
매개변수
설명
{CONNECTION_ID}
스트리밍 연결의 id 값이 이전에 만들어졌습니다.

요청

동기 유효성 검사를 사용하여 데이터 인렛으로 데이터를 수집하려면 다음 요청을 제출하십시오.

curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID}?syncValidation=true \
  -H "Content-Type: application/json" \
  -d '{JSON_PAYLOAD}'
매개변수
설명
{JSON_PAYLOAD}
수집하려는 데이터의 JSON 본문.

응답

동기 유효성 검사가 활성화된 경우 성공적인 응답에는 페이로드에 발생한 유효성 검사 오류가 포함됩니다.

{
    "type": "http://ns.adobe.com/adobecloud/problem/data-collection-service/inlet",
    "status": 400,
    "title": "Invalid XDM Message Format",
    "report": {
        "message": "inletId: [6aca7aa2d87ebd6b2780ca5724d94324a14475f140a2b69373dd5c714430dfd4] imsOrgId: [7BF122A65C5B3FE40A494026@AdobeOrg] Message is invalid",
        "cause": {
            "_streamingValidation": [
                {
                    "schemaLocation": "#",
                    "pointerToViolation": "#",
                    "causingExceptions": [
                        {
                            "schemaLocation": "#",
                            "pointerToViolation": "#",
                            "causingExceptions": [],
                            "keyword": "additionalProperties",
                            "message": "extraneous key [workEmail] is not permitted"
                        },
                        {
                            "schemaLocation": "#",
                            "pointerToViolation": "#",
                            "causingExceptions": [],
                            "keyword": "additionalProperties",
                            "message": "extraneous key [person] is not permitted"
                        },
                        {
                            "schemaLocation": "#/properties/_id",
                            "pointerToViolation": "#/_id",
                            "causingExceptions": [],
                            "keyword": "type",
                            "message": "expected type: String, found: Long"
                        }
                    ],
                    "message": "3 schema violations found"
                }
            ]
        }
    }
}

위의 응답에는 발견된 스키마 위반 수와 위반 내용이 나열됩니다. 예를 들어, 이 응답은 키 workEmailperson이(가) 스키마에 정의되어 있지 않으므로 허용되지 않음을 나타냅니다. 스키마에 string이(가) 필요하지만 대신 long이(가) 삽입되었으므로 _id에 대한 값에 잘못된 플래그를 지정합니다. 5개의 오류가 발생하면 유효성 검사 서비스가 해당 메시지를 중지 ​합니다. 그러나 다른 메시지는 계속 구문 분석됩니다.

비동기 유효성 검사

비동기 유효성 검사는 즉각적인 피드백을 제공하지 않는 유효성 검사 방법입니다. 대신 데이터가 손실되지 않도록 Data Lake의 실패한 일괄 처리로 데이터가 전송됩니다. 이 실패한 데이터는 나중에 추가 분석 및 재생을 위해 검색할 수 있습니다. 이 메서드는 프로덕션에서 사용해야 합니다. 달리 요청되지 않는 한, 스트리밍 수집은 비동기 유효성 검사 모드에서 작동합니다.

API 형식

POST /collection/{CONNECTION_ID}
매개변수
설명
{CONNECTION_ID}
스트리밍 연결의 id 값이 이전에 만들어졌습니다.

요청

비동기 유효성 검사를 사용하여 데이터 인렛으로 데이터를 수집하려면 다음 요청을 제출하십시오.

curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID} \
  -H "Content-Type: application/json" \
  -d '{JSON_PAYLOAD}'
매개변수
설명
{JSON_PAYLOAD}
수집하려는 데이터의 JSON 본문.
NOTE
비동기 유효성 검사는 기본적으로 활성화되어 있으므로 추가 쿼리 매개 변수는 필요하지 않습니다.

응답

비동기 유효성 검사가 활성화된 경우 성공적인 응답은 다음을 반환합니다.

{
    "inletId": "f6ca9706d61de3b78be69e2673ad68ab9fb2cece0c1e1afc071718a0033e6877",
    "xactionId": "1555445493896:8600:8",
    "receivedTimeMs": 1555445493932,
    "syncValidation": {
        "skipped": true
    }
}

동기 유효성 검사가 명시적으로 요청되지 않았으므로 응답이 생략되었음을 어떻게 표시하는지 확인하십시오.

부록

이 섹션에는 데이터 수집에 대한 응답에 대한 다양한 상태 코드가 무엇을 의미하는지에 대한 정보가 포함되어 있습니다.

상태 코드

상태 코드
의미
200
성공. 동기 유효성 검사의 경우 유효성 검사를 통과했음을 의미합니다. 비동기 유효성 검사의 경우 메시지를 성공적으로 수신했다는 의미입니다. 사용자는 데이터 세트를 관찰하여 최종 메시지 상태를 확인할 수 있습니다.
400
오류. 귀하의 요청에 문제가 있습니다. 스트리밍 유효성 검사 서비스에서 자세한 내용을 포함하는 오류 메시지를 받습니다.
401
오류. 요청이 승인되지 않았습니다. 전달자 토큰을 사용하여 요청해야 합니다. 액세스 요청 방법에 대한 자세한 내용은 이 자습서 또는 이 블로그 게시물을 확인하세요.
500
오류. 내부 시스템 오류가 있습니다.
501
오류. 이 위치에 대해 동기 유효성 검사가 지원되지 않음 ​을 의미합니다.
503
오류. 서비스를 현재 사용할 수 없습니다. 클라이언트는 지수 백오프 전략을 사용하여 최소 세 번 다시 시도해야 합니다.
recommendation-more-help
2ee14710-6ba4-4feb-9f79-0aad73102a9a