세그먼트 결과 평가 및 액세스

이 문서에서는 세그먼트 평가 및 세그먼트 결과에 액세스하는 자습서를 제공합니다 Segmentation API.

시작하기

이 자습서에서는 대상 세그먼트 만들기와 관련된 다양한 Adobe Experience Platform 서비스에 대해 작업해야 합니다. 이 자습서를 시작하기 전에 다음 서비스에 대한 설명서를 검토하십시오.

  • Real-time Customer Profile:여러 소스에서 수집한 데이터를 기반으로 통합된 고객 프로필을 실시간으로 제공합니다.
  • Adobe Experience Platform Segmentation Service:데이터를 통해 고객 세그먼트를 만들 수 Real-time Customer Profile 있습니다.
  • Experience Data Model (XDM):Platform(플랫폼)이 고객 경험 데이터를 구성하는 표준화된 프레임워크입니다.
  • 샌드박스: Experience Platform 디지털 경험 애플리케이션을 개발하고 발전시키는 데 도움이 되도록 단일 Platform 인스턴스를 별도의 가상 환경으로 분할하는 가상 샌드박스를 제공합니다.

필요한 헤더

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

  • 인증:무기명 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

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

  • x-sandbox-name: {SANDBOX_NAME}
NOTE

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

모든 POST, PUT 및 PATCH 요청에는 추가 헤더가 필요합니다.

  • 컨텐츠 유형:application/json

세그먼트 평가

세그먼트 정의를 개발, 테스트 및 저장한 후에는 예약된 평가나 주문형 평가를 통해 세그먼트를 평가할 수 있습니다.

예약된 평가 (일명 '예약된 세그멘테이션'이라고도 함)를 사용하면 특정 시간에 내보내기 작업을 실행하기 위한 반복 일정을 만들 수 있지만, on-demand 평가에는 대상을 즉시 빌드하기 위한 세그먼트 작업을 만드는 작업이 포함됩니다. 각 단계에 대한 설명은 아래에 나와 있습니다.

세그멘테이션 API 자습서를 사용하여 세그먼트 만들기를 아직 완료하지 않았거나 세그먼트 빌더를 사용하여 세그먼트 정의를 만든 경우 이 자습서를진행하기 전에 그렇게 하십시오.

예약된 평가

예약된 평가를 통해 IMS 조직은 자동으로 내보내기 작업을 실행하는 반복 일정을 생성할 수 있습니다.

NOTE

최대 5개의 병합 정책을 포함하는 샌드박스에 대해 예약된 평가를 활성화할 수 있습니다 XDM Individual Profile. 조직에서 단일 샌드박스 환경 XDM Individual Profile 에 대해 5개 이상의 병합 정책을 보유하고 있는 경우 예약된 평가를 사용할 수 없습니다.

일정 만들기

종단점에 POST 요청을 함으로써 일정을 만들고 일정을 트리거해야 하는 특정 시간을 포함할 수 /config/schedules 있습니다.

이 끝점 사용에 대한 자세한 내용은 예약 끝점 안내서에서 확인할 수 있습니다.

일정 활성화

기본적으로, 속성이 만들기(POST) 요청 본문에 로 설정되어 있지 않은 이상 state 만들어진 경우 일정 active 은 비활성화됩니다. 종단점에 PATCH 요청을 만들고 경로에 있는 일정 state 의 ID를 포함하여 일정(설정 active /config/schedules )을 활성화할 수 있습니다.

이 끝점 사용에 대한 자세한 내용은 예약 끝점 안내서에서 확인할 수 있습니다.

예약 시간 업데이트

종단점에 PATCH 요청을 만들고 경로에 있는 예약의 ID를 포함하여 예약 시간을 /config/schedules 업데이트할 수 있습니다.

이 끝점 사용에 대한 자세한 내용은 예약 끝점 안내서에서 확인할 수 있습니다.

On-Demand 평가

주문형 평가를 통해 필요할 때마다 대상 세그먼트를 생성하기 위해 세그먼트 작업을 만들 수 있습니다. 예약된 평가와는 달리, 이것은 요청이 있을 때만 발생하며 반복되지 않습니다.

세그먼트 작업 만들기

세그먼트 작업은 새 대상 세그먼트를 만드는 비동기 프로세스입니다. 프로필 조각에서 겹치는 속성을 병합하는 방법을 제어하는 모든 병합 정책뿐만 아니라 세그먼트 정의를 참조합니다 Real-time Customer Profile . 세그먼트 작업이 성공적으로 완료되면 처리 중에 발생한 오류와 대상의 최종 크기 등 세그먼트에 대한 다양한 정보를 수집할 수 있습니다.

API의 종단점에 대한 POST 요청을 만들어 새 세그먼트 작업 /segment/jobs 을 만들 수 Real-time Customer Profile 있습니다.

이 끝점 사용에 대한 자세한 내용은 세그먼트 작업 끝점 안내서에서 확인할 수 있습니다

세그먼트 작업 상태 보기

특정 세그먼트 작업 id 에 대해 조회 요청(GET)을 수행하여 작업의 현재 상태를 볼 수 있습니다.

이 끝점 사용에 대한 자세한 내용은 세그먼트 작업 끝점 안내서에서 확인할 수 있습니다

세그먼트 결과 해석

세그먼트 작업이 성공적으로 실행되면 세그먼트 내에 포함된 각 프로필에 대해 segmentMembership 맵이 업데이트됩니다. segmentMembership 또한 인제스트된 사전 평가 대상 세그먼트를 저장하므로 Platform와 같은 다른 솔루션과 통합할 수 있습니다 Adobe Audience Manager.

다음 예에서는 각 개별 프로필 레코드에 대한 segmentMembership 속성이 어떻게 나타나는지 보여줍니다.

{
  "segmentMembership": {
    "UPS": {
      "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": {
        "timestamp": "2018-04-26T15:52:25+00:00",
        "status": "existing"
      },
      "53cba6b2-a23b-454a-8069-fc41308f1c0f": {
        "lastQualificationTime": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      }
    },
    "Email": {
      "abcd@adobe.com": {
        "lastQualificationTime": "2017-09-26T15:52:25+00:00",
        "status": "exited"
      }
    }
  }
}
속성 설명
lastQualificationTime 세그먼트 구성원 자격 어설션이 만들어지고 프로필이 세그먼트를 입력하거나 종료한 타임스탬프.
status 현재 요청의 일부로서 세그먼트 기여도 상태입니다. 다음과 같은 알려진 값 중 하나와 같아야 합니다.
  • existing:엔티티가 세그먼트에 계속 있습니다.
  • realized:엔티티가 세그먼트를 입력하고 있습니다.
  • exited:엔티티가 세그먼트를 종료합니다.

세그먼트 결과 액세스

다음 두 가지 방법 중 하나로 세그먼트 작업 결과에 액세스할 수 있습니다.개별 프로필에 액세스하거나 전체 대상을 데이터 세트에 내보낼 수 있습니다.

다음 섹션에서는 이러한 옵션에 대해 자세히 설명합니다.

프로필 검색

액세스하려는 특정 프로필을 알고 있는 경우 Real-time Customer Profile API를 사용하여 액세스할 수 있습니다. 개별 프로필에 액세스하는 전체 단계는 프로필 API 자습서를 사용한 실시간 고객 프로필 데이터에 액세스하십시오.

세그먼트 내보내기

세그멘테이션 작업이 성공적으로 완료된 후( status 속성 값이 "성공"됨) 대상을 액세스 및 작동 가능한 데이터 세트로 내보낼 수 있습니다.

대상을 내보내려면 다음 단계가 필요합니다.

  • 대상 데이터 집합 만들기 - 대상 구성원을 포함할 데이터 집합을 만듭니다.
  • 데이터 세트에서 고객 프로필 생성 - 세그먼트 작업 결과를 기반으로 XDM 개별 프로필로 데이터 세트를 채웁니다.
  • 내보내기 진행 모니터링 - 내보내기 프로세스의 현재 진행 상태를 확인합니다.
  • 대상 데이터 읽기 - 대상 구성원을 나타내는 결과 XDM 개별 프로필을 검색합니다.

대상 데이터 세트 만들기

대상을 내보낼 때 먼저 대상 데이터 세트를 만들어야 합니다. 내보내기가 성공하도록 데이터 세트를 올바르게 구성해야 합니다.

중요한 고려 사항 중 하나는 데이터 세트가 기반으로 하는 스키마입니다(아래schemaRef.id API 샘플 요청). 세그먼트를 내보내려면 데이터 세트에 XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union)가 있어야 합니다. 결합 스키마는 동일한 클래스를 공유하는 스키마의 필드를 집계하는 시스템 생성 읽기 전용 스키마입니다. 이 경우 XDM 개인 프로필 클래스입니다. 결합 보기 스키마에 대한 자세한 내용은 스키마 레지스트리 개발자 안내서의 실시간 고객 프로필 섹션을 참조하십시오.

다음 두 가지 방법으로 필요한 데이터 세트를 만들 수 있습니다.

  • API 사용: 이 튜토리얼의 다음 단계는 API를 사용하여 해당 데이터 세트를 참조하는 XDM Individual Profile Union Schema 데이터 세트를 만드는 방법에 대해 Catalog 설명합니다.
  • UI 사용: 사용자 Adobe Experience Platform 인터페이스를 사용하여 조합 스키마를 참조하는 데이터 세트를 만들려면 UI 튜토리얼의 단계를 수행한 다음 이 튜토리얼로 돌아가 대상 프로필 생성 단계를 계속 진행합니다.

이미 호환되는 데이터 세트가 있고 ID를 알고 있는 경우 대상 프로필을 생성하는 단계로 직접 이동할 수 있습니다.

API 형식

POST /dataSets

요청

다음 요청은 페이로드에서 구성 매개 변수를 제공하는 새 데이터 세트를 만듭니다.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -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}' \
  -d '{
    "name": "Segment Export",
    "schemaRef": {
        "id": "https://ns.adobe.com/xdm/context/profile__union",
        "contentType": "application/vnd.adobe.xed+json;version=1"
    },
    "fileDescription": {
        "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    }
}'
속성 설명
name 데이터 세트에 대한 설명형 이름입니다.
schemaRef.id 데이터 집합에 연결할 통합 보기(스키마)의 ID입니다.
fileDescription.persisted 로 설정하면 데이터 세트 true가 조합 보기에서 유지될 수 있도록 하는 부울 값입니다.

응답

성공적인 응답은 새로 만든 데이터 세트에 대한 읽기 전용 시스템 생성 고유 ID가 포함된 배열을 반환합니다. 대상 구성원을 성공적으로 내보내려면 제대로 구성된 데이터 집합 ID가 필요합니다.

[
  "@/datasets/5b020a27e7040801dedba61b"
] 

대상 구성원을 위한 프로필 생성

조합 지속 데이터 집합이 있으면 내보내기 작업을 만들어 API의 /export/jobs 종단점에 POST 요청을 수행하고 내보내려는 세그먼트에 대한 데이터 집합 ID 및 세그먼트 정보를 제공하여 대상 멤버를 데이터 세트에 유지할 수 Real-time Customer Profile 있습니다.

이 끝점 사용에 대한 자세한 내용은 내보내기 작업 끝점 안내서를 참조하십시오

내보내기 진행 상태 모니터링

내보내기 작업 프로세스에서는 종단점에 GET 요청을 만들고 경로에 내보내기 작업 /export/jobs id 을 포함하여 해당 상태를 모니터링할 수 있습니다. 필드가 "SUCCESS" 값을 반환하면 내보내기 작업이 status 완료됩니다.

이 끝점 사용에 대한 자세한 내용은 내보내기 작업 끝점 안내서를 참조하십시오

다음 단계

내보내기가 성공적으로 완료되면 in 내에서 데이터를 사용할 수 Data Lake 있습니다 Experience Platform. 그런 다음 내보내기와 연결된 데이터 Data Access API 를 사용하여 데이터에 batchId 액세스할 수 있습니다. 세그먼트 크기에 따라 데이터가 청크 단위일 수 있으며 일괄 처리는 여러 파일로 구성될 수 있습니다.

API를 사용하여 일괄 파일에 액세스하고 다운로드하는 방법에 대한 단계별 지침을 보려면 Data Access 데이터 액세스 자습서를 따르십시오 .

를 사용하여 성공적으로 내보낸 세그먼트 데이터에 액세스할 수도 있습니다 Adobe Experience Platform Query Service. UI 또는 RESTful API를 사용하여 데이터 Query Service 에 대한 쿼리를 작성하고 유효성을 확인하고 실행할 수 Data Lake있습니다.

대상 데이터를 쿼리하는 방법에 대한 자세한 내용은 설명서를 참조하십시오 Query Service.

이 페이지에서는