Ad-hoc 활성화 API를 통해 요청 시 대상자 세그먼트를 배치 대상으로 활성화

중요

베타 단계를 완료한 후 ad-hoc activation API 이제 모든 Experience Platform 고객에게 GA(Ga)를 제공할 수 있습니다. GA 버전에서 API가 버전 2로 업그레이드되었습니다. 4단계 (최신 세그먼트 내보내기 작업 ID 가져오기)는 API에 더 이상 내보내기 ID가 필요하지 않으므로 더 이상 필요하지 않습니다.

자세한 내용은 임시 활성화 작업 실행 자세한 내용은 이 자습서에서 아래 를 참조하십시오.

개요

Ad-hoc 활성화 API를 사용하면 즉시 활성화해야 하는 상황에서 마케터는 빠르고 효율적인 방식으로 대상 세그먼트를 대상으로 프로그래밍 방식으로 활성화할 수 있습니다.

아래 다이어그램은 24시간마다 Platform에서 발생하는 세그먼테이션 작업을 포함하여, Ad-Hoc 활성화 API를 통해 세그먼트를 활성화하는 종단 간 워크플로우를 보여줍니다.

ad-hoc-activation

노트

임시 대상 활성화는 배치 파일 기반 대상.

사용 사례

Flash 판매 또는 프로모션

한 온라인 소매업체에서 제한된 플래시 세일을 준비하고 있으며, 고객에게 단시간에 알릴 것을 원합니다. 마케팅 팀은 Experience Platform Ad-hoc 활성화 API를 통해 세그먼트를 온디맨드(on-demand)로 내보내고 고객 기반에 홍보 이메일을 빠르게 보낼 수 있습니다.

현재 이벤트 또는 최신 뉴스

한 호텔은 다음 날 날씨가 좋을 것으로 예상하고 있어서, 그 팀은 도착된 손님들에게 빨리 알려주기 때문에 그들은 그에 따라 계획을 세울 수 있게 되기를 원합니다. 마케팅 팀은 Experience Platform ad-hoc 활성화 API를 사용하여 세그먼트를 온디맨드(on-demand)로 내보내고 게스트에게 알릴 수 있습니다.

통합 테스트

IT 관리자는 Experience Platform Ad-Hoc 활성화 API를 사용하여 세그먼트를 온디맨드(on-demand)로 내보낼 수 있으므로 Adobe Experience Platform와의 사용자 지정 통합을 테스트하고 모든 것이 제대로 작동하는지 확인할 수 있습니다.

가드레일

임시 활성화 API를 사용할 때는 다음과 같은 보호 기능을 기억하십시오.

  • 현재 각 임시 활성화 작업은 최대 80개의 세그먼트를 활성화할 수 있습니다. 작업당 80개 이상의 세그먼트를 활성화하려고 하면 작업이 실패합니다. 이 동작은 향후 릴리스에서 변경될 수 있습니다.
  • Ad-hoc 활성화 작업은 예약된 작업과 동시에 실행할 수 없습니다 세그먼트 내보내기 작업. 임시 활성화 작업을 실행하기 전에 예약된 세그먼트 내보내기 작업이 완료되었는지 확인하십시오. 자세한 내용은 대상 데이터 흐름 모니터링 활성화 흐름의 상태를 모니터링하는 방법에 대한 정보입니다. 예를 들어 활성화 데이터 양이 처리 중 상태, ad-hoc 활성화 작업을 실행하기 전에 완료될 때까지 기다립니다.
  • 세그먼트당 두 개 이상의 동시 Ad-Hoc 활성화 작업을 실행하지 마십시오.

세그먼테이션 고려 사항

Adobe Experience Platform은 24시간마다 예약된 세그먼테이션 작업을 실행합니다. 임시 활성화 API는 최신 세분화 결과를 기반으로 실행됩니다.

1단계: 전제 조건

Adobe Experience Platform API를 호출하려면 먼저 다음 전제 조건을 충족하는지 확인하십시오.

  • Adobe Experience Platform에 액세스할 수 있는 IMS 조직 계정이 있습니다.
  • Experience Platform 계정에는 developeruser Adobe Experience Platform API 제품 프로필에 대해 활성화된 역할. 다음 사항에 문의하십시오. Admin Console 관리자가 계정에 대해 이러한 역할을 사용할 수 있도록 설정
  • Adobe ID이 있습니다. Adobe ID이 없는 경우 Adobe Developer 콘솔 새 계정을 만듭니다.

2단계: 자격 증명 수집

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

  • 권한 부여: 베어러 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Experience Platform의 리소스는 특정 가상 샌드박스로 분리할 수 있습니다. Platform API에 대한 요청에서 작업을 수행할 샌드박스의 이름 및 ID를 지정할 수 있습니다. 선택적 매개 변수입니다.

  • x-sandbox-name: {SANDBOX_NAME}
노트

Experience Platform의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서.

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

  • Content-Type: application/json

3단계: 플랫폼 UI에서 활성화 흐름 만들기

임시 활성화 API를 통해 세그먼트를 활성화하려면 먼저 선택한 대상에 대해 플랫폼 UI에 활성화 플로우가 구성되어 있어야 합니다.

활성화 워크플로우로 이동하고, 세그먼트를 선택하고, 일정을 구성하고, 활성화합니다. UI 또는 API를 사용하여 활성화 흐름을 만들 수 있습니다.

4단계: 최신 세그먼트 내보내기 작업 ID 가져오기(v2에서는 필요하지 않음)

중요

ad-hoc 활성화 API의 v2에서는 최신 세그먼트 내보내기 작업 ID를 가져올 필요가 없습니다. 이 단계를 건너뛰고 다음 단계로 진행할 수 있습니다.

배치 대상에 대한 활성화 흐름을 구성한 후 24시간마다 예약된 세그먼테이션 작업이 자동으로 실행됩니다.

임시 활성화 작업을 실행하려면 먼저 최신 세그먼트 내보내기 작업의 ID를 가져와야 합니다. 임시 활성화 작업 요청에서 이 ID를 전달해야 합니다.

다음 지침을 따르십시오 여기 를 클릭하여 모든 세그먼트 내보내기 작업의 목록을 검색합니다.

응답에서 아래의 스키마 속성을 포함하는 첫 번째 레코드를 찾습니다.

"schema":{
   "name":"_xdm.context.profile"
}

세그먼트 내보내기 작업 ID는 id 속성은 아래와 같이 표시됩니다.

세그먼트 내보내기 작업 ID

5단계: 임시 활성화 작업 실행

Adobe Experience Platform은 24시간마다 예약된 세그먼테이션 작업을 실행합니다. 임시 활성화 API는 최신 세분화 결과를 기반으로 실행됩니다.

임시 활성화 작업을 실행하기 전에 세그먼트에 대해 예약된 세그먼트 내보내기 작업이 완료되었는지 확인하십시오. 자세한 내용은 대상 데이터 흐름 모니터링 활성화 흐름의 상태를 모니터링하는 방법에 대한 정보입니다. 예를 들어 활성화 데이터 양이 처리 중 상태, ad-hoc 활성화 작업을 실행하기 전에 완료될 때까지 기다립니다.

세그먼트 내보내기 작업이 완료되면 활성화를 트리거할 수 있습니다.

노트

현재 각 임시 활성화 작업은 최대 80개의 세그먼트를 활성화할 수 있습니다. 작업당 80개 이상의 세그먼트를 활성화하려고 하면 작업이 실패합니다. 이 동작은 향후 릴리스에서 변경될 수 있습니다.

요청

중요

를 포함해야 합니다 Accept: application/vnd.adobe.adhoc.activation+json; version=2 ad-hoc 활성화 API의 v2를 사용하기 위해 요청에 있는 헤더입니다.

curl --location --request POST 'https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun' \
--header 'x-gw-ims-org-id: 5555467B5D8013E50A494220@AdobeOrg' \
--header 'Authorization: Bearer {{token}}' \
--header 'x-sandbox-id: 6ef74723-3ee7-46a4-b747-233ee7a6a41a' \
--header 'x-sandbox-name: {sandbox-id}' \
--header 'Accept: application/vnd.adobe.adhoc.activation+json; version=2' \
--header 'Content-Type: application/json' \
--data-raw '{
   "activationInfo":{
      "destinationId1":[
         "segmentId1",
         "segmentId2"
      ],
      "destinationId2":[
         "segmentId2",
         "segmentId3"
      ]
   }
}'
속성 설명
  • destinationId1
  • destinationId2
세그먼트를 활성화할 대상 인스턴스의 ID입니다. 로 이동하여 Platform UI에서 이러한 ID를 가져올 수 있습니다 대상 > 찾아보기 탭하고 원하는 대상 행을 클릭하여 오른쪽 레일에 대상 ID를 표시합니다. 자세한 내용은 대상 작업 공간 설명서.
  • segmentId1
  • segmentId2
  • segmentId3
선택한 대상으로 활성화할 세그먼트의 ID입니다.

내보내기 ID를 사용한 요청(더 이상 사용되지 않음)

중요

사용되지 않는 요청 유형. 이 예제 유형은 API 버전 1에 대한 요청 유형을 설명합니다. ad-hoc 활성화 API의 v2에서는 최신 세그먼트 내보내기 작업 ID를 포함할 필요가 없습니다.

curl -X POST https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -d '
{
   "activationInfo":{
      "destinationId1":[
         "segmentId1",
         "segmentId2"
      ],
      "destinationId2":[
         "segmentId2",
         "segmentId3"
      ]
   },
   "exportIds":[
      "exportId1"
   ]
}
속성 설명
  • destinationId1
  • destinationId2
세그먼트를 활성화할 대상 인스턴스의 ID입니다. 로 이동하여 Platform UI에서 이러한 ID를 가져올 수 있습니다 대상 > 찾아보기 탭하고 원하는 대상 행을 클릭하여 오른쪽 레일에 대상 ID를 표시합니다. 자세한 내용은 대상 작업 공간 설명서.
  • segmentId1
  • segmentId2
  • segmentId3
선택한 대상으로 활성화할 세그먼트의 ID입니다.
  • exportId1
의 응답으로 반환된 ID입니다 세그먼트 내보내기 작업. 자세한 내용은 4단계: 최신 세그먼트 내보내기 작업 ID 가져오기 를 참조하십시오.

응답

성공한 응답은 HTTP 상태 200을 반환합니다.

{
   "order":[
      {
         "segment":"db8961e9-d52f-45bc-b3fb-76d0382a6851",
         "order":"ef2dcbd6-36fc-49a3-afed-d7b8e8f724eb",
         "statusURL":"https://platform.adobe.io/data/foundation/flowservice/runs/88d6da63-dc97-460e-b781-fc795a7386d9"
      }
   ]
}
속성 설명
segment 활성화된 세그먼트의 ID입니다.
order 세그먼트가 활성화된 대상의 ID입니다.
statusURL 활성화 흐름의 상태 URL입니다. 를 사용하여 흐름 진행률을 추적할 수 있습니다 Flow Service API.

API 오류 처리

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

Ad-hoc 활성화 API와 관련된 API 오류 코드 및 메시지

Ad-hoc 활성화 API를 사용할 때 이 API 엔드포인트에 해당하는 오류 메시지가 표시될 수 있습니다. 테이블이 표시될 때 해당 주소를 지정하는 방법을 이해하려면 표를 검토하십시오.

오류 메시지 해상도
세그먼트에 대해 이미 실행 segment ID 주문 dataflow ID 실행 id 사용 flow run ID 이 오류 메시지는 임시 활성화 흐름이 현재 세그먼트에 대해 진행 중임을 나타냅니다. 활성화 작업을 다시 트리거하기 전에 작업이 완료될 때까지 기다립니다.
세그먼트 <segment name> 이 데이터 흐름의 일부가 아니거나 일정 범위를 벗어났습니다. 이 오류 메시지는 활성화하도록 선택한 세그먼트가 데이터 플로우에 매핑되지 않거나 세그먼트에 대해 설정된 활성화 일정이 만료되었거나 아직 시작되지 않았음을 나타냅니다. 세그먼트가 실제로 데이터 플로우에 매핑되었는지 확인하고 세그먼트 활성화 일정이 현재 날짜와 겹치는지 확인합니다.

이 페이지에서는