스트리밍 세분화를 통해 거의 실시간으로 이벤트 평가

Adobe Experience Platform에서 스트리밍 세분화를 통해 고객은 데이터 풍부성에 집중하면서 거의 실시간으로 세분화를 수행할 수 있습니다. 스트리밍 세분화를 사용하면 스트리밍 데이터가 Platform (으)로 들어오는 동안 세그먼트 자격이 발생하여 세분화 작업을 예약하고 실행할 필요가 줄어듭니다. 이 기능을 사용하면 데이터가 Platform (으)로 전달될 때 대부분의 세그먼트 규칙을 평가할 수 있습니다. 즉, 예약된 세그먼테이션 작업을 실행하지 않고 세그먼트 멤버십을 최신 상태로 유지합니다.

시작하기

이 개발자 안내서를 사용하려면 스트리밍 세분화와 관련된 다양한 Adobe Experience Platform 서비스에 대한 작업 이해가 필요합니다. 이 자습서를 시작하기 전에 다음 서비스에 대한 설명서를 검토하십시오.

다음 섹션에서는 Platform API를 성공적으로 호출하기 위해 알아야 하는 추가 정보를 제공합니다.

샘플 API 호출 읽기

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

필수 헤더에 대한 값 수집

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

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

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

특정 요청을 완료하려면 추가 헤더가 필요할 수 있습니다. 이 문서 내의 각 예제에 올바른 헤더가 표시됩니다. 모든 필수 헤더가 포함되도록 하려면 샘플 요청에 특별히 주의하십시오.

스트리밍 세분화 사용 쿼리 유형 query-types

스트리밍 세분화를 사용하여 세그먼트 정의를 평가하려면 쿼리가 다음 지침을 준수해야 합니다.

다음 시나리오에서 스트리밍 세분화에 대해 세그먼트 정의를 사용할 수 없습니다.

스트리밍 세분화를 수행할 때 다음 지침이 적용됩니다.

스트리밍 세분화 기준을 더 이상 충족하지 않도록 세그먼트 정의를 수정하면 세그먼트 정의가 자동으로 "스트리밍"에서 "일괄 처리"로 전환됩니다.

또한 세그먼트 자격과 마찬가지로 세그먼트 비자격은 실시간으로 발생합니다. 따라서 프로필이 더 이상 세그먼트 정의에 적합하지 않으면 즉시 부적격 프로필이 됩니다. 예를 들어 세그먼트 정의가 "지난 3시간 동안 빨간 신발을 구매한 모든 사용자"를 묻는 경우 3시간 후에 세그먼트 정의에 대해 처음에 자격을 부여한 모든 프로필은 부적격합니다.

스트리밍 세분화에 대해 활성화된 모든 세그먼트 정의 검색

/segment/definitions 끝점에 대한 GET 요청을 통해 조직 내에서 스트리밍 세분화에 대해 활성화된 모든 세그먼트 정의 목록을 검색할 수 있습니다.

API 형식

스트리밍 사용 세그먼트 정의를 검색하려면 요청 경로에 쿼리 매개 변수 evaluationInfo.continuous.enabled=true을(를) 포함해야 합니다.

GET /segment/definitions?evaluationInfo.continuous.enabled=true

요청

curl -X GET \
  'https://platform.adobe.io/data/core/ups/segment/definitions?evaluationInfo.continuous.enabled=true' \
  -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}'

응답

성공적인 응답은 스트리밍 세분화에 대해 활성화된 조직의 세그먼트 정의 배열을 반환합니다.

{
    "segments": [
        {
            "id": "15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "",
                "sandboxName": "",
                "type": "production",
                "default": true
            },
            "name": " People who are NOT on their homepage ",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = false"
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": false
                },
                "continuous": {
                    "enabled": true
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "creationTime": 1572029711000,
            "updateEpoch": 1572029712000,
            "updateTime": 1572029712000
        },
        {
            "id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "",
                "sandboxName": "",
                "type": "production",
                "default": true
            },
            "name": "Homepage_continuous",
            "description": "People who are on their homepage - continuous",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": true
                },
                "continuous": {
                    "enabled": true
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "creationTime": 1572021085000,
            "updateEpoch": 1572021086000,
            "updateTime": 1572021086000
        }
    ],
    "page": {
        "totalCount": 2,
        "totalPages": 1,
        "sortField": "creationTime",
        "sort": "desc",
        "pageSize": 2,
        "limit": 100
    },
    "link": {}
}

스트리밍 사용 세그먼트 정의 만들기

세그먼트 정의가 위에 나열된 스트리밍 세분화 유형 중 하나와(과) 일치하는 경우 자동으로 스트리밍이 활성화됩니다.

API 형식

POST /segment/definitions

요청

curl -X POST \
  https://platform.adobe.io/data/core/ups/segment/definitions \
  -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 '{
    "schema": {
        "name": "_xdm.context.profile"
    },
    "name": "Homepage_continuous",
    "description": "People who are on their homepage - continuous",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
    },
    "evaluationInfo": {
        "batch": {
            "enabled": false
        },
        "continuous": {
            "enabled": true
        },
        "synchronous": {
            "enabled": false
        }
    }
}'

응답

성공한 응답은 새로 만든 스트리밍 활성화 세그먼트 정의의 세부 정보를 반환합니다.

{
    "id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "{SANDBOX_ID}",
        "sandboxName": "{SANDBOX_NAME}",
        "type": "production",
        "default": true
    },
    "name": "Homepage_continuous",
    "description": "People who are on their homepage - continuous",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
    },
    "evaluationInfo": {
        "batch": {
            "enabled": false
        },
        "continuous": {
            "enabled": true,
                   },
        "synchronous": {
            "enabled": false
        }
    },
    "creationTime": 1572021085000,
    "updateEpoch": 1572021086000,
    "updateTime": 1572021086000
}

예약된 평가 활성화 enable-scheduled-segmentation

스트리밍 평가가 활성화되면 기준선을 만들어야 합니다. 그 후 세그먼트 정의는 항상 최신 상태가 됩니다. 시스템에서 베이스라인을 자동으로 수행하려면 먼저 예약된 평가(예약된 세그먼테이션이라고도 함)를 활성화해야 합니다. 예약된 세그먼테이션을 사용하면 조직에서 반복 일정을 준수하여 세그먼트 정의를 평가하기 위해 내보내기 작업을 자동으로 실행할 수 있습니다.

일정 만들기

/config/schedules 끝점에 대한 POST 요청을 수행하면 일정을 만들고 일정을 트리거해야 하는 특정 시간을 포함할 수 있습니다.

API 형식

POST /config/schedules

요청

다음 요청은 페이로드에 제공된 사양을 기반으로 새 일정을 만듭니다.

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/schedules \
  -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 '{
        "name": "{SCHEDULE_NAME}",
        "type": "batch_segmentation",
        "properties": {
            "segments": ["*"]
        },
        "schedule": "0 0 1 * * ?",
        "state": "inactive"
        }'

응답

성공한 응답은 새로 생성된 일정의 세부 정보를 반환합니다.

{
    "id": "cd585edf-962d-420d-94ad-3be03e619ac2",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

일정 활성화

기본적으로, 만들기(POST) 요청 본문에서 state 속성이 active(으)로 설정되어 있지 않으면 만들 때 일정이 비활성화됩니다. /config/schedules 끝점에 대한 PATCH 요청을 만들고 경로에 일정 ID를 포함하여 일정을 활성화(state을(를) active(으)로 설정)할 수 있습니다.

API 형식

POST /config/schedules/{SCHEDULE_ID}

요청

다음 요청은 JSON 패치 형식을 사용하여 일정의 state을(를) active(으)로 업데이트합니다.

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/schedules/cd585edf-962d-420d-94ad-3be03e619ac2 \
  -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 '[
        {
          "op": "add",
          "path": "/state",
          "value": "active"
        }
      ]'

응답

성공한 업데이트는 빈 응답 본문과 HTTP 상태 204(콘텐츠 없음)를 반환합니다.

동일한 작업을 사용하여 이전 요청의 "value"를 "inactive"로 대체하여 일정을 비활성화할 수 있습니다.

다음 단계

스트리밍 세분화에 대한 새 세그먼트 정의와 기존 세그먼트 정의를 모두 활성화하고, 기준선 개발과 반복 평가를 수행하기 위해 예약된 세분화를 활성화했으므로 이제 조직에 대해 스트리밍 지원 세그먼트 정의를 만들 수 있습니다.

Adobe Experience Platform 사용자 인터페이스를 사용하여 유사한 작업을 수행하고 세그먼트 정의를 사용하는 방법에 대해 알아보려면 세그먼트 빌더 사용 안내서를 참조하세요.

부록

다음 섹션에서는 스트리밍 세분화에 대해 자주 묻는 질문에 대해 설명합니다.

스트리밍 세분화 "비자격"도 실시간으로 발생합니까?

대부분의 경우 스트리밍 세분화 비자격이 실시간으로 발생합니다. 그러나 세그먼트의 세그먼트를 사용하는 스트리밍 세그먼트 정의는 실시간으로 부적격 ​되지만 24시간 후에는 부적격 처리됩니다.

스트리밍 세분화는 어떤 데이터에 작동합니까?

스트리밍 세분화는 스트리밍 소스를 사용하여 수집된 모든 데이터에 대해 작동합니다. 일괄 처리 기반 소스를 사용하여 수집된 세그먼트는 스트리밍 세그멘테이션 자격이 있는 경우에도 매일 밤 평가됩니다. 타임스탬프가 24시간 이상인 시스템으로 스트리밍되는 이벤트는 후속 일괄 처리 작업에서 처리됩니다.

세그먼트 정의는 배치 또는 스트리밍 세그먼테이션으로 어떻게 정의됩니까?

세그먼트 정의는 쿼리 유형과 이벤트 내역 기간의 조합을 기반으로 하는 일괄 처리 또는 스트리밍 세그먼테이션으로 정의됩니다. 스트리밍 세그먼트로 평가될 세그먼트 정의 목록은 스트리밍 세그먼테이션 쿼리 유형 섹션에서 찾을 수 있습니다.

세그먼트에 모두, inSegment 식 및 직접적인 단일 이벤트 체인이 포함된 경우 스트리밍 세분화에 적합하지 않습니다. 이 세그먼트 정의가 스트리밍 세분화에 적합하도록 하려면 직접 단일 이벤트 체인을 고유한 세그먼트 정의로 만들어야 합니다.

세그먼트 정의 세부 사항 섹션 내에서 "최근 X일"에 있는 숫자가 0으로 유지되는 동안 "총 적격" 세그먼트 정의의 수가 계속 증가하는 이유는 무엇입니까?

총 적격 세그먼트 정의 수는 일괄 처리와 스트리밍 세그먼트 정의를 모두 사용할 수 있는 대상을 포함하는 일별 세그먼테이션 작업에서 가져옵니다. 이 값은 배치 및 스트리밍 세그먼트 정의에 모두 표시됩니다.

"최근 X일" only 아래의 숫자는 스트리밍 세분화에 적합한 대상을 포함하며, 데이터를 시스템으로 스트리밍한 경우 only ​이(가) 증가하여 해당 스트리밍 정의로 계산됩니다. 이 값은 스트리밍 세그먼트 정의에 대해 표시되는 only ​입니다. 따라서 이 값 may ​은(는) 일괄 처리 세그먼트 정의에 대해 0으로 표시됩니다.

따라서 "최근 X일" 아래의 숫자가 0이고 꺾은선형 그래프도 0을 보고하는 경우 해당 세그먼트 정의에 적합한 프로필이 시스템으로 스트리밍되지 않음 ​됩니다.

세그먼트 정의를 사용하려면 얼마나 걸립니까?

세그먼트 정의를 사용할 수 있는 데 최대 1시간이 소요됩니다.

스트리밍되는 데이터에 제한이 있습니까?

스트리밍된 데이터를 스트리밍 세분화에 사용하려면 must ​에서 스트리밍된 이벤트 사이에 간격이 있습니다. 너무 많은 이벤트가 동일한 초 내에서 스트리밍되는 경우 Platform은 이러한 이벤트를 봇 생성 데이터로 취급하며 삭제됩니다. 데이터가 올바르게 사용되도록 하려면 이벤트 데이터 사이에 최소 5초가 있어야 합니다.