소스 스키마를 기반으로 샘플 프로필 생성 sample-profile-api-operations
IMPORTANT
API 끝점:
https://platform.adobe.io/data/core/activation/authoring/sample-profiles이 페이지에서는 /authoring/sample-profiles API 끝점을 사용하여 수행할 수 있는 모든 API 작업을 나열하고 설명합니다.
API에 따라 다른 프로필 유형 생성 different-profiles-different-apis
IMPORTANT
이 API 끝점을 사용하여 두 개의 별도 사용 사례에 대한 샘플 프로필을 생성합니다. 다음 중 하나를 수행할 수 있습니다.
- 대상 ID 을(를) 쿼리 매개 변수로 사용하여 메시지 변환 템플릿을 만들고 테스트할 때사용할 프로필을 생성합니다.
- 대상 인스턴스 ID 를 쿼리 매개 변수로 사용하여 대상이 올바르게 구성되었는지 테스트를 호출할 때 사용할 프로필을 생성합니다.
Adobe XDM 소스 스키마(대상을 테스트할 때 사용) 또는 대상에서 지원하는 대상 스키마(템플릿을 만들 때 사용)를 기반으로 샘플 프로필을 생성할 수 있습니다. Adobe XDM 원본 스키마와 대상 스키마의 차이점을 이해하려면 메시지 형식 문서의 개요 섹션을 읽어 보세요.
샘플 프로필을 사용할 수 있는 목적은 서로 바꿀 수 없습니다. 대상 ID 을(를) 기반으로 생성된 프로필은 메시지 변환 템플릿을 만드는 데만 사용할 수 있으며 대상 인스턴스 ID 을(를) 기반으로 생성된 프로필은 대상 끝점을 테스트하는 데만 사용할 수 있습니다.
샘플 프로필 생성 API 작업 시작 get-started
계속하기 전에 시작 안내서에서 필요한 대상 작성 권한 및 필수 헤더를 얻는 방법을 포함하여 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보를 검토하십시오.
대상을 테스트할 때 사용할 소스 스키마를 기반으로 샘플 프로필 생성 generate-sample-profiles-source-schema
IMPORTANT
대상을 테스트할 때 여기서 생성된 샘플 프로필을 HTTP 호출에 추가합니다.
authoring/sample-profiles/ 끝점에 대한 GET 요청을 만들고 테스트할 대상 구성을 기반으로 만든 대상 인스턴스의 ID를 제공하여 소스 스키마를 기반으로 샘플 프로필을 생성할 수 있습니다.
대상 인스턴스의 ID를 가져오려면 먼저 대상 테스트를 시도하기 전에 Experience Platform UI에서 대상에 대한 연결을 만들어야 합니다. 대상 활성화 자습서를 읽고 이 API에 사용할 대상 인스턴스 ID를 가져오는 방법에 대한 아래 팁을 참조하십시오.
IMPORTANT
- 이 API를 사용하려면 Experience Platform UI에 대상에 대한 기존 연결이 있어야 합니다. 자세한 내용은 대상에 연결 및 대상에 프로필 및 대상자 활성화를 참조하십시오.
- 대상에 대한 연결을 설정한 후 대상과의 연결을 탐색할 때 이 끝점에 대한 API 호출에 사용해야 하는 대상 인스턴스 ID를 가져옵니다.
API 형식
GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}
쿼리 매개 변수
설명
{DESTINATION_INSTANCE_ID}샘플 프로필을 생성하는 데 기준이 되는 대상 인스턴스의 ID입니다.
{COUNT}선택 사항. 생성 중인 샘플 프로필 수입니다. 매개 변수는
count 매개 변수를 지정하지 않으면 대상 서버 구성의
1 - 1000 사이의 값을 사용할 수 있습니다.count 매개 변수를 지정하지 않으면 대상 서버 구성의
maxUsersPerRequest 값에 의해 생성된 프로필의 기본 수가 결정됩니다. 이 속성이 정의되지 않으면 Adobe에서 샘플 프로필이 생성됩니다.요청
다음 요청은 {DESTINATION_INSTANCE_ID} 및 {COUNT} 쿼리 매개 변수로 구성된 샘플 프로필을 생성합니다.
curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
응답
성공적인 응답은 지정된 수의 샘플 프로필과 함께, 소스 XDM 스키마에 해당하는 대상 멤버십, ID 및 프로필 속성이 포함된 HTTP 상태 200을 반환합니다.
TIP
응답에서는 대상 인스턴스에 사용된 대상 멤버십, ID 및 프로필 속성만 반환합니다. 소스 스키마에 다른 필드가 있더라도 무시됩니다.
[
{
"segmentMembership": {
"ups": {
"03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
"lastQualificationTime": "2021-06-30T18:40:07.591378Z",
"status": "realized"
},
"27e05542-d6a3-46c7-9c8e-d59d50229530": {
"lastQualificationTime": "2021-06-30T18:40:07.591380Z",
"status": "realized"
}
}
},
"personalEmail": {
"address": "john.smith@abc.com"
},
"identityMap": {
"ECID": [
{
"id": "ECID-7VEsJ"
}
]
},
"person": {
"name": {
"firstName": "string"
}
}
},
{
"segmentMembership": {
"ups": {
"03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
"lastQualificationTime": "2021-06-30T18:40:07.591378Z",
"status": "realized"
},
"27e05542-d6a3-46c7-9c8e-d59d50229530": {
"lastQualificationTime": "2021-06-30T18:40:07.591380Z",
"status": "realized"
}
}
},
"personalEmail": {
"address": "john.smith@abc.com"
},
"identityMap": {
"ECID": [
{
"id": "ECID-Y55JJ"
}
]
},
"person": {
"name": {
"firstName": "string"
}
}
},
{
"segmentMembership": {
"ups": {
"03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
"lastQualificationTime": "2021-06-30T18:40:07.591378Z",
"status": "realized"
},
"27e05542-d6a3-46c7-9c8e-d59d50229530": {
"lastQualificationTime": "2021-06-30T18:40:07.591380Z",
"status": "realized"
}
}
},
"personalEmail": {
"address": "john.smith@abc.com"
},
"identityMap": {
"ECID": [
{
"id": "ECID-Nd9GK"
}
]
},
"person": {
"name": {
"firstName": "string"
}
}
}
]
속성
설명
segmentMembership개인의 대상 멤버십을 설명하는 맵 개체입니다.
segmentMembership에 대한 자세한 내용은 대상 멤버십 세부 정보를 참조하세요.lastQualificationTime이 프로필이 세그먼트에 대해 마지막으로 적격한 타임스탬프입니다.
xdm:status대상자 멤버십이 현재 요청의 일부로 실현되었는지 여부를 나타내는 문자열 필드입니다. 다음 값이 허용됩니다.
realized: 프로필이 세그먼트에 속합니다.exited: 프로필이 현재 요청의 일부로 대상을 종료합니다.
identityMap연관된 네임스페이스와 함께 개인에 대한 다양한 ID 값을 설명하는 맵 유형 필드입니다.
identityMap에 대한 자세한 내용은 스키마 컴퍼지션의 기준을 참조하세요.메시지 변환 템플릿을 만들 때 사용할 대상 스키마를 기반으로 샘플 프로필 생성 generate-sample-profiles-target-schema
IMPORTANT
템플릿 렌더링 단계에서 템플릿을 만들 때 여기에서 생성된 샘플 프로필을 사용하십시오.
authoring/sample-profiles/ 끝점에 대한 GET 요청을 수행하고 템플릿을 만드는 데 사용하는 대상 구성의 대상 ID를 제공하는 대상 스키마를 기반으로 샘플 프로필을 생성할 수 있습니다.
TIP
- 여기에서 사용해야 하는 대상 ID는
/destinations끝점을 사용하여 만든 대상 구성에 해당하는instanceId입니다. 자세한 내용은 대상 구성 검색을 참조하세요.
API 형식
GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}
쿼리 매개 변수
설명
{DESTINATION_ID}샘플 프로필을 생성하는 데 기준이 되는 대상 구성의 ID입니다.
{COUNT}선택 사항. 생성 중인 샘플 프로필 수입니다. 매개 변수는
count 매개 변수를 지정하지 않으면 대상 서버 구성의
1 - 1000 사이의 값을 사용할 수 있습니다.count 매개 변수를 지정하지 않으면 대상 서버 구성의
maxUsersPerRequest 값에 의해 생성된 프로필의 기본 수가 결정됩니다. 이 속성이 정의되지 않으면 Adobe에서 샘플 프로필이 생성됩니다.요청
다음 요청은 {DESTINATION_ID} 및 {COUNT} 쿼리 매개 변수로 구성된 샘플 프로필을 생성합니다.
curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
응답
성공적인 응답은 대상 XDM 스키마에 해당하는 대상자 멤버십, ID 및 프로필 속성과 함께 지정된 수의 샘플 프로필이 포함된 HTTP 상태 200을 반환합니다.
[
{
"segmentMembership": {
"ups": {
"segmentid1": {
"lastQualificationTime": "2021-06-30T18:42:27.609326Z",
"status": "realized"
},
"segmentid3": {
"lastQualificationTime": "2021-06-30T18:42:27.609328Z",
"status": "exited"
},
"segmentid2": {
"lastQualificationTime": "2021-06-30T18:42:27.609328Z",
"status": "realized"
}
}
},
"identityMap": {
"phone_sha256": [
{
"id": "phone_sha256-vizii"
}
],
"gaid": [
{
"id": "gaid-adKYs"
}
],
"idfa": [
{
"id": "idfa-t4sKv"
}
],
"extern_id": [
{
"id": "extern_id-C3enB"
}
],
"email_lc_sha256": [
{
"id": "email_lc_sha256-bfnbs"
}
]
}
},
{
"segmentMembership": {
"ups": {
"segmentid1": {
"lastQualificationTime": "2021-06-30T18:42:27.609626Z",
"status": "realized"
},
"segmentid3": {
"lastQualificationTime": "2021-06-30T18:42:27.609627Z",
"status": "exited"
},
"segmentid2": {
"lastQualificationTime": "2021-06-30T18:42:27.609627Z",
"status": "realized"
}
}
},
"identityMap": {
"phone_sha256": [
{
"id": "phone_sha256-6YjGc"
}
],
"gaid": [
{
"id": "gaid-SfJ21"
}
],
"idfa": [
{
"id": "idfa-eQMWS"
}
],
"extern_id": [
{
"id": "extern_id-d3WzP"
}
],
"email_lc_sha256": [
{
"id": "email_lc_sha256-eWfFn"
}
]
}
},
{
"segmentMembership": {
"ups": {
"segmentid1": {
"lastQualificationTime": "2021-06-30T18:42:27.609823Z",
"status": "realized"
},
"segmentid3": {
"lastQualificationTime": "2021-06-30T18:42:27.609824Z",
"status": "exited"
},
"segmentid2": {
"lastQualificationTime": "2021-06-30T18:42:27.609824Z",
"status": "realized"
}
}
},
"identityMap": {
"phone_sha256": [
{
"id": "phone_sha256-2PMjZ"
}
],
"gaid": [
{
"id": "gaid-3aLez"
}
],
"idfa": [
{
"id": "idfa-D2H1J"
}
],
"extern_id": [
{
"id": "extern_id-i6PsF"
}
],
"email_lc_sha256": [
{
"id": "email_lc_sha256-VPUtZ"
}
]
}
}
]
API 오류 처리 api-error-handling
Destination SDK API 엔드포인트는 일반적인 Experience Platform API 오류 메시지 원칙을 따릅니다. 플랫폼 문제 해결 안내서에서 API 상태 코드 및 요청 헤더 오류를 참조하십시오.
다음 단계
이 문서를 읽은 후에는 메시지 변환 템플릿을 테스트하거나 대상이 올바르게 구성되었는지 테스트할 때 사용할 샘플 프로필을 생성하는 방법을 이해할 수 있습니다.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6