샘플 프로필로 파일 기반 대상 테스트

개요

이 페이지에서는 를 사용하는 방법을 설명합니다. /testing/destinationInstance 파일 기반 대상이 올바르게 구성되었는지 테스트하고 구성된 대상에 데이터 흐름의 무결성을 확인하는 API 끝점입니다.

를 추가하거나 추가하지 않고 테스트 종단점에 요청을 수행할 수 있습니다 샘플 프로필 호출 요청에 대해 프로필을 보내지 않는 경우 API가 샘플 프로필을 자동으로 생성하여 요청에 추가합니다.

자동 생성된 샘플 프로필에는 일반 데이터가 포함되어 있습니다. 보다 직관적인 사용자 지정 프로필 데이터를 사용하여 대상을 테스트하려면 샘플 프로필 생성 API 샘플 프로필을 생성하려면 해당 응답을 사용자 지정하고 요청에 포함시킵니다. /testing/destinationInstance 엔드포인트.

시작하기

계속하기 전에 시작 안내서 api를 성공적으로 호출하기 위해 알고 있어야 하는 중요한 정보(필수 대상 작성 권한 및 필수 헤더를 가져오는 방법)입니다.

전제 조건

를 사용하기 전에 /testing/destinationInstance endpoint, 다음 조건을 충족하는지 확인하십시오.

  • Destination SDK을 통해 만든 기존 파일 기반 대상이 있으며 대상 카탈로그.

  • Experience Platform UI에서 대상에 대해 하나 이상의 활성화 흐름을 만들었습니다.

  • API 요청을 성공적으로 수행하려면 테스트할 대상 인스턴스에 해당하는 대상 인스턴스 ID가 필요합니다. Platform UI에서 대상과의 연결을 검색할 때 URL에서 API 호출에 사용해야 하는 대상 인스턴스 ID를 가져옵니다.

    URL에서 대상 인스턴스 ID를 가져오는 방법을 보여주는 UI 이미지입니다.

  • 선택 사항입니다: API 호출에 추가된 샘플 프로필을 사용하여 대상 구성을 테스트하려면 /sample-profiles 기존 소스 스키마를 기반으로 샘플 프로필을 생성하는 끝점입니다. 샘플 프로필을 제공하지 않으면 API가 샘플 프로필을 생성하여 응답으로 반환합니다.

호출에 프로필을 추가하지 않고 대상 구성을 테스트합니다

API 형식

POST /authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}

요청

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
경로 매개 변수 설명
{DESTINATION_INSTANCE_ID} 샘플 프로필을 생성하는 대상 인스턴스의 ID입니다. 자세한 내용은 전제 조건 섹션을 참조하십시오.

응답

성공적인 응답은 응답 페이로드와 함께 HTTP 상태 200을 반환합니다.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"john.smith@abc.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"crmid-P1A7l"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"string",
               "lastName":"string"
            }
         }
      }
   ]
}
속성 설명
activations 활성화된 각 세그먼트에 대한 세그먼트 ID 및 흐름 실행 ID를 반환합니다. 활성화 항목(및 연결된 생성 파일)의 수는 대상 인스턴스에 매핑된 세그먼트 수와 같습니다.

예: 두 세그먼트를 대상 인스턴스에 매핑하면 activations 배열에는 두 개의 항목이 포함됩니다. 활성화된 각 세그먼트는 내보낸 하나의 파일에 해당합니다.
results 를 호출하는 데 사용할 수 있는 대상 인스턴스 ID와 흐름 실행 ID를 반환합니다 결과 API를 눌러 통합을 추가로 테스트합니다.
inputProfiles API에 의해 자동으로 생성된 샘플 프로필을 반환합니다.

호출에 추가된 프로필로 대상 구성을 테스트합니다

보다 직관적인 사용자 지정 프로필 데이터를 사용하여 대상을 테스트하려면 /sample-profiles 선택한 값이 있는 엔드포인트 및 요청에 사용자 지정 프로필을 포함하십시오. /testing/destinationInstance 엔드포인트.

API 형식

POST  /testing/destinationInstance/{DESTINATION_INSTANCE_ID}

요청

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
 {
   "profiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}'
매개 변수 설명
{DESTINATION_INSTANCE_ID} 테스트할 대상의 대상 인스턴스 ID입니다. 샘플 프로필을 생성하는 대상 인스턴스의 ID입니다. 자세한 내용은 전제 조건 섹션을 참조하십시오.
profiles 하나 이상의 프로필을 포함할 수 있는 배열입니다. 를 사용하십시오 샘플 프로필 API 끝점 를 입력하여 이 API 호출에 사용할 프로필을 생성합니다.

응답

성공적인 응답은 응답 페이로드와 함께 HTTP 상태 200을 반환합니다.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}
속성 설명
activations 활성화된 각 세그먼트에 대한 세그먼트 ID 및 흐름 실행 ID를 반환합니다. 활성화 항목(및 연결된 생성 파일)의 수는 대상 인스턴스에 매핑된 세그먼트 수와 같습니다.

예: 두 세그먼트를 대상 인스턴스에 매핑하면 activations 배열에는 두 개의 항목이 포함됩니다. 활성화된 각 세그먼트는 내보낸 하나의 파일에 해당합니다.
results 를 호출하는 데 사용할 수 있는 대상 인스턴스 ID와 흐름 실행 ID를 반환합니다 결과 API를 눌러 통합을 추가로 테스트합니다.
inputProfiles API 요청에서 전달한 사용자 지정 샘플 프로필을 반환합니다.

API 오류 처리

Destination SDK API 엔드포인트는 일반 Experience Platform API 오류 메시지 원칙을 따릅니다. 을(를) 참조하십시오. API 상태 코드요청 헤더 오류 을 참조하십시오.

다음 단계

이 문서를 읽은 후에는 파일 기반 대상 구성을 테스트하는 방법을 알 수 있습니다.

유효한 API 응답을 받은 경우 대상이 올바르게 작동합니다. 활성화 흐름에 대한 자세한 정보를 보려면 results 응답에서 로의 속성 세부 활성화 결과 보기.

이제 공개 대상을 만드는 경우 대상 구성 제출 Adobe을 참조하십시오.

이 페이지에서는