샘플 템플릿 API 작업 가져오기

중요

API 엔드포인트: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

이 페이지에서는 /authoring/testing/template/sample API 종단점을 사용하여 대상에 대한 메시지 변환 템플릿을 생성하기 위해 수행할 수 있는 모든 API 작업을 나열하고 설명합니다. 이 종단점에서 지원하는 기능에 대한 설명은 템플릿 만들기를 참조하십시오.

샘플 템플릿 API 작업 시작

계속하기 전에 필요한 대상 작성 권한 및 필수 헤더를 가져오는 방법을 포함하여 API를 성공적으로 호출하기 위해 알고 있어야 하는 중요한 정보가 필요하면 시작 안내서를 검토하십시오.

샘플 템플릿 가져오기

authoring/testing/template/sample/ 종단점에 GET 요청을 하고 템플릿을 만드는 데 따라 대상 구성의 대상 ID를 제공하여 샘플 템플릿을 가져올 수 있습니다.

  • 여기서 사용해야 하는 대상 ID는 /destinations 종단점을 사용하여 만든 대상 구성에 해당하는 instanceId 입니다. 대상 구성 API 참조를 참조하십시오.

API 형식

GET authoring/testing/template/sample/{DESTINATION_ID}
매개 변수 설명
{DESTINATION_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: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

응답

성공적인 응답은 예상 데이터 형식과 일치하도록 편집할 수 있는 샘플 템플릿과 함께 HTTP 상태 200을 반환합니다.

제공하는 대상 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 segments 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 segments by status: -#}
                {% for segment in removedSegments(profile.segmentMembership.ups) %}
                    "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
                {% endfor %}
                ]
            }
        }{%- if not loop.last -%},{%- endif -%}
    {% endfor %}
    ]
}

API 오류 처리

대상 SDK API 엔드포인트는 일반 Experience Platform API 오류 메시지 원칙을 따릅니다. 플랫폼 문제 해결 안내서에서 API 상태 코드요청 헤더 오류를 참조하십시오.

다음 단계

이 문서를 읽은 후에는 /authoring/testing/template/sample API 종단점을 사용하여 메시지 변환 템플릿을 생성하는 방법을 알 수 있습니다. 다음으로, 템플릿 API 엔드포인트 렌더링 을 사용하여 템플릿을 기반으로 내보낸 프로필을 생성하고 대상의 예상 데이터 형식과 비교할 수 있습니다.

이 페이지에서는