메시지 변형 템플릿 만들기 및 테스트 create-template
개요 overview
Adobe은 Destination SDK의 일부로 대상을 구성하고 테스트하는 데 도움이 되는 개발자 도구를 제공합니다. 이 페이지에서는 메시지 변환 템플릿을 만들고 테스트하는 방법을 설명합니다. 대상을 테스트하는 방법에 대한 자세한 내용은 대상 구성 테스트를 참조하십시오.
Adobe Experience Platform의 대상 스키마와 대상에서 지원하는 메시지 형식 간에 메시지 변환 템플릿을 만들고 테스트하려면 아래에 설명된 템플릿 작성 도구 를 사용하십시오. 메시지 형식 문서에서 원본 스키마와 대상 스키마 간의 데이터 변환에 대해 자세히 알아보세요.
메시지 변환 템플릿을 만들고 테스트하는 것이 Destination SDK의 대상 구성 워크플로에 어떻게 적합한지 아래에 나와 있습니다.
메시지 변형 템플릿을 만들고 테스트해야 하는 이유 why-create-message-transformation-template
Destination SDK에서 대상을 만드는 첫 번째 단계 중 하나는 Adobe Experience Platform에서 대상으로 내보낼 때 대상 멤버십, ID 및 프로필 속성에 대한 데이터 형식이 변환되는 방법을 생각하는 것입니다. 메시지 형식 문서에서 Adobe XDM 스키마와 대상 스키마 간의 변환에 대한 정보를 찾으십시오.
변환에 성공하려면 다음 예제와 유사한 변환 템플릿을 제공해야 합니다. 세그먼트, ID 및 프로필 특성을 보내는 템플릿을 만듭니다.
Adobe은 Adobe XDM 형식의 데이터를 대상에서 지원하는 형식으로 변환하는 메시지 템플릿을 만들고 테스트할 수 있는 템플릿 도구를 제공합니다. 이 도구에는 사용할 수 있는 두 개의 API 끝점이 있습니다.
- 샘플 템플릿 API 를 사용하여 샘플 템플릿을 가져옵니다.
- 대상의 예상 데이터 형식과 결과를 비교할 수 있도록 렌더링 템플릿 API 를 사용하여 샘플 템플릿을 렌더링합니다. 내보낸 데이터를 대상에 필요한 데이터 형식과 비교한 후 템플릿을 편집할 수 있습니다. 이렇게 하면 생성하는 내보낸 데이터가 대상에 필요한 데이터 형식과 일치합니다.
템플릿을 만들기 전에 완료해야 하는 단계 prerequisites
템플릿을 만들기 전에 아래 단계를 완료하십시오.
-
대상 서버 구성을 만듭니다.
maxUsersPerRequest매개 변수에 제공한 값에 따라 생성할 템플릿이 다릅니다.- 대상에 대한 API 호출에 대상 자격, ID 및 프로필 특성과 함께 단일 프로필을 포함하려면
maxUsersPerRequest=1을(를) 사용합니다. - 대상에 대한 API 호출에 대상 자격, ID 및 프로필 특성과 함께 여러 프로필을 포함하려면 값이 1보다 큰
maxUsersPerRequest을(를) 사용합니다.
- 대상에 대한 API 호출에 대상 자격, ID 및 프로필 특성과 함께 단일 프로필을 포함하려면
-
대상 구성을 만들고
destinationDelivery.destinationServerId에 대상 서버 구성의 ID를 추가합니다. -
방금 만든 대상 구성의 ID를 가져옵니다. 템플릿 만들기 도구에서 사용할 수 있습니다.
-
메시지 변환 템플릿에서 사용할 수 있는 함수 및 필터를 이해합니다.
샘플 템플릿 API 및 렌더링 템플릿 API를 사용하여 대상에 대한 템플릿을 만드는 방법 iterative-process
"template": "{% for profile in input.profiles %}{{profile|raw}}{% endfor %}}"템플릿을 가져오고 테스트하는 프로세스는 반복적입니다. 내보낸 프로필이 대상의 예상 데이터 형식과 일치할 때까지 아래 단계를 반복합니다.
- 먼저 샘플 템플릿을 가져옵니다.
- 샘플 템플릿을 시작점으로 사용하여 나만의 초안을 만듭니다.
- 고유한 템플릿을 사용하여 렌더링 템플릿 API 끝점을 호출합니다. Adobe은 스키마를 기반으로 샘플 프로필을 생성하고, 결과 또는 발생한 오류를 반환합니다.
- 내보낸 데이터를 대상에 필요한 데이터 형식과 비교합니다. 필요한 경우 템플릿을 편집합니다.
- 내보낸 프로필이 대상의 예상 데이터 형식과 일치할 때까지 이 프로세스를 반복합니다.
샘플 템플릿 API를 사용하여 샘플 템플릿 가져오기 sample-template-api
아래 표시된 대로 호출에 대상 ID를 추가하면 응답이 대상 ID에 해당하는 템플릿 예제를 반환합니다.
curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/testing/template/sample/5114d758-ce71-43ba-b53e-e2a91d67b67f' \
--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}' \
제공한 대상 ID가 집계 정책에서 우수 사례 집계 및 maxUsersPerRequest=1을(를) 사용하는 대상 구성에 해당하는 경우 요청은 다음과 유사한 샘플 템플릿을 반환합니다.
{#- THIS is an example template for a single profile -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
"identities": [
{%- for idMapEntry in input.profile.identityMap -%}
{%- set namespace = idMapEntry.key -%}
{%- for identity in idMapEntry.value %}
{
"type": "{{ namespace }}",
"id": "{{ identity.id }}"
}{%- if not loop.last -%},{%- endif -%}
{%- endfor -%}{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"AdobeExperiencePlatformSegments": {
"add": [
{%- for segment in input.profile.segmentMembership.ups | added %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"remove": [
{#- Alternative syntax for filtering audiences by status: -#}
{% for segment in removedSegments(input.profile.segmentMembership.ups) %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
]
}
}
제공한 대상 ID가 구성 가능한 집계 또는 maxUsersPerRequest이(가) 둘 이상인 최상의 노력 집계인 대상 서버 템플릿에 해당하는 경우 요청은 다음과 유사한 샘플 템플릿을 반환합니다.
{#- THIS is an example template for multiple profiles -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
"profiles": [
{%- for profile in input.profiles %}
{
"identities": [
{%- for idMapEntry in profile.identityMap -%}
{%- set namespace = idMapEntry.key -%}
{%- for identity in idMapEntry.value %}
{
"type": "{{ namespace }}",
"id": "{{ identity.id }}"
}{%- if not loop.last -%},{%- endif -%}
{%- endfor -%}{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"AdobeExperiencePlatformSegments": {
"add": [
{%- for segment in profile.segmentMembership.ups | added %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"remove": [
{#- Alternative syntax for filtering audiences by status: -#}
{% for segment in removedSegments(profile.segmentMembership.ups) %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
]
}
}{%- if not loop.last -%},{%- endif -%}
{% endfor %}
]
}
문자-템플릿 이스케이프 character-escape-template
템플릿을 사용하여 대상의 예상 형식과 일치하는 프로필을 렌더링하기 전에 아래 화면 기록과 같이 템플릿을 문자 이스케이프 처리해야 합니다.
온라인 문자 이스케이프 도구를 사용할 수 있습니다. 위의 데모에서는 JSON 이스케이프 포맷터를 사용합니다.
템플릿 API 렌더링 render-template-api
샘플 템플릿 API를 사용하여 메시지 변환 템플릿을 만든 후 템플릿을 렌더링하여 이를 기반으로 내보낸 데이터를 생성할 수 있습니다. 이렇게 하면 Adobe Experience Platform이 대상으로 내보낼 프로필이 대상의 예상 형식과 일치하는지 확인할 수 있습니다.
수행할 수 있는 호출 예는 API 참조 를 참조하십시오.
내보낸 프로필이 대상의 예상 데이터 형식과 일치할 때까지 템플릿을 편집하고 렌더링 템플릿 API 끝점을 호출합니다.
문자가 이스케이프 처리된 템플릿을 대상 서버 구성에 추가합니다.
메시지 변환 템플릿에 만족하면 httpTemplate.requestBody.value의 대상 서버 구성에 추가하십시오.