대상자 템플릿 업데이트

Last update: Mon Jul 29 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
대상

작성 대상:

관리자
사용자

IMPORTANT

API 끝점: platform.adobe.io/data/core/activation/authoring/audience-templates

이 페이지는 /authoring/audience-templates API 끝점을 사용하여 대상 템플릿을 업데이트하는 데 사용할 수 있는 API 요청 및 페이로드를 구현합니다.

이 끝점을 통해 구성할 수 있는 기능에 대한 자세한 설명은 대상 메타데이터 관리를 참조하십시오.

IMPORTANT

Destination SDK에서 지원하는 모든 매개 변수 이름과 값은 대/소문자를 구분합니다. 대소문자 구분 오류를 방지하려면 설명서에 표시된 대로 매개 변수 이름과 값을 정확히 사용하십시오.

대상자 템플릿 API 작업 시작 get-started

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

대상자 템플릿 업데이트 create

업데이트된 페이로드로 /authoring/audience-templates 끝점에 대해 PUT 요청을 수행하여 기존 대상 템플릿을 업데이트할 수 있습니다.

기존 대상 템플릿과 해당 {INSTANCE_ID}을(를) 가져오려면 대상 템플릿 검색에 대한 문서를 참조하십시오.

API 형식

PUT /authoring/audience-templates/{INSTANCE_ID}

매개변수

설명

{INSTANCE_ID}

업데이트할 대상 템플릿의 ID입니다. 기존 대상 템플릿과 해당 {INSTANCE_ID}을(를) 가져오려면 대상 템플릿 검색을 참조하십시오.

다음 요청은 페이로드에 제공된 매개 변수로 구성된 기존 대상 메타데이터 템플릿을 업데이트합니다.

요청

code language-shell

code language-shell
curl -X POST https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \ -H 'Authorization: Bearer {ACCESS_TOKEN}' \ -H 'Content-Type: application/json' \ -H 'x-gw-ims-org-id: {ORG_ID}' \ -H 'x-api-key: {API_KEY}' \ -H 'x-sandbox-name: {SANDBOX_NAME}' \ -d ' { "metadataTemplate": { "name": "Test Webhook Audience Template", "create": { "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments", "httpMethod": "POST", "headers": [ { "value": "application/json", "header": "Content-Type" }, { "value": "Bearer {{authData.token}}", "header": "Authorization" } ], "requestBody": { "json": { "name": "{{segment.name}}", "type": "segment", "metadata": { "org_id": "{{destination.imsOrgId}}", "sandbox": "{{destination.sandboxName}}", "destination_id": "{{destination.id}}", "destination_name": "{{destination.name}}", "segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns\|merge([atr.source]) %}{% endfor %}{{ columns \| toJson }}" }, "external_id": "{{segment.id}}" } }, "responseFields": [ { "value": "{{headers.X-Request-Id}}", "name": "externalAudienceId" } ], "responseErrorFields": [ { "value": "{{root}}", "name": "message" } ] }, "update": { "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}", "httpMethod": "PUT", "headers": [ { "value": "application/json", "header": "Content-Type" }, { "value": "Bearer {{authData.token}}", "header": "Authorization" } ], "requestBody": { "json": { "name": "{{segment.name}}", "type": "segment", "metadata": { "org_id": "{{destination.imsOrgId}}", "sandbox": "{{destination.sandboxName}}", "destination_id": "{{destination.id}}", "destination_name": "{{destination.name}}", "segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns\|merge([atr.source]) %}{% endfor %}{{ columns \| toJson }}" }, "external_id": "{{segment.id}}" } }, "responseFields": [ { "value": "{{headers.X-Request-Id}}", "name": "externalAudienceId" } ], "responseErrorFields": [ { "value": "{{root}}", "name": "message" } ] }, "delete": { "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}", "httpMethod": "DELETE", "headers": [ { "value": "Bearer {{authData.token}}", "header": "Authorization" } ], "responseErrorFields": [ { "value": "{{root}}", "name": "message" } ] }, "createDestination": { "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/createDestination", "httpMethod": "POST", "headers": [ { "value": "application/json", "header": "Content-Type" }, { "value": "Bearer {{authData.token}}", "header": "Authorization" } ], "requestBody": { "json": { "name": "{{destination.name}}", "type": "destination", "metadata": { "org_id": "{{destination.imsOrgId}}", "sandbox": "{{destination.sandboxName}}", "destination_id": "{{destination.id}}", "destination_name": "{{destination.name}}", "enrichmentAttributes": "{{destination.enrichmentAttributes}}" }, "external_id": "{{destination.id}}" } }, "responseFields": [ { "value": "{{headers.X-Request-Id}}", "name": "externalAudienceId" } ], "responseErrorFields": [ { "value": "{{root}}", "name": "message" } ] }, "updateDestination": { "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/updateDestination", "httpMethod": "POST", "headers": [ { "value": "application/json", "header": "Content-Type" }, { "value": "Bearer {{authData.token}}", "header": "Authorization" } ], "requestBody": { "json": { "name": "{{destination.name}}", "type": "destination", "metadata": { "org_id": "{{destination.imsOrgId}}", "sandbox": "{{destination.sandboxName}}", "destination_id": "{{destination.id}}", "destination_name": "{{destination.name}}", "enrichmentAttributes": "{{destination.enrichmentAttributes}}" }, "external_id": "{{destination.id}}" } }, "responseFields": [ { "value": "{{headers.X-Request-Id}}", "name": "externalAudienceId" } ], "responseErrorFields": [ { "value": "{{root}}", "name": "message" } ] }, "deleteDestination": { "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/deleteDestination", "httpMethod": "DELETE", "headers": [ { "value": "Bearer {{authData.token}}", "header": "Authorization" } ], "responseErrorFields": [ { "value": "{{root}}", "name": "message" } ] } }, "validations":[ { "field":"string", "regex":"string" } ] }'

curl -X POST https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
  "metadataTemplate": {
    "name": "Test Webhook Audience Template",
    "create": {
      "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments",
      "httpMethod": "POST",
      "headers": [
        {
          "value": "application/json",
          "header": "Content-Type"
        },
        {
          "value": "Bearer {{authData.token}}",
          "header": "Authorization"
        }
      ],
      "requestBody": {
        "json": {
          "name": "{{segment.name}}",
          "type": "segment",
          "metadata": {
            "org_id": "{{destination.imsOrgId}}",
            "sandbox": "{{destination.sandboxName}}",
            "destination_id": "{{destination.id}}",
            "destination_name": "{{destination.name}}",
            "segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns|merge([atr.source]) %}{% endfor %}{{ columns | toJson }}"
          },
          "external_id": "{{segment.id}}"
        }
      },
      "responseFields": [
        {
          "value": "{{headers.X-Request-Id}}",
          "name": "externalAudienceId"
        }
      ],
      "responseErrorFields": [
        {
          "value": "{{root}}",
          "name": "message"
        }
      ]
    },
    "update": {
      "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}",
      "httpMethod": "PUT",
      "headers": [
        {
          "value": "application/json",
          "header": "Content-Type"
        },
        {
          "value": "Bearer {{authData.token}}",
          "header": "Authorization"
        }
      ],
      "requestBody": {
        "json": {
          "name": "{{segment.name}}",
          "type": "segment",
          "metadata": {
            "org_id": "{{destination.imsOrgId}}",
            "sandbox": "{{destination.sandboxName}}",
            "destination_id": "{{destination.id}}",
            "destination_name": "{{destination.name}}",
            "segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns|merge([atr.source]) %}{% endfor %}{{ columns | toJson }}"
          },
          "external_id": "{{segment.id}}"
        }
      },
      "responseFields": [
        {
          "value": "{{headers.X-Request-Id}}",
          "name": "externalAudienceId"
        }
      ],
      "responseErrorFields": [
        {
          "value": "{{root}}",
          "name": "message"
        }
      ]
    },
    "delete": {
      "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}",
      "httpMethod": "DELETE",
      "headers": [
        {
          "value": "Bearer {{authData.token}}",
          "header": "Authorization"
        }
      ],
      "responseErrorFields": [
        {
          "value": "{{root}}",
          "name": "message"
        }
      ]
    },
    "createDestination": {
      "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/createDestination",
      "httpMethod": "POST",
      "headers": [
        {
          "value": "application/json",
          "header": "Content-Type"
        },
        {
          "value": "Bearer {{authData.token}}",
          "header": "Authorization"
        }
      ],
      "requestBody": {
        "json": {
          "name": "{{destination.name}}",
          "type": "destination",
          "metadata": {
            "org_id": "{{destination.imsOrgId}}",
            "sandbox": "{{destination.sandboxName}}",
            "destination_id": "{{destination.id}}",
            "destination_name": "{{destination.name}}",
            "enrichmentAttributes": "{{destination.enrichmentAttributes}}"
          },
          "external_id": "{{destination.id}}"
        }
      },
      "responseFields": [
        {
          "value": "{{headers.X-Request-Id}}",
          "name": "externalAudienceId"
        }
      ],
      "responseErrorFields": [
        {
          "value": "{{root}}",
          "name": "message"
        }
      ]
    },
    "updateDestination": {
      "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/updateDestination",
      "httpMethod": "POST",
      "headers": [
        {
          "value": "application/json",
          "header": "Content-Type"
        },
        {
          "value": "Bearer {{authData.token}}",
          "header": "Authorization"
        }
      ],
      "requestBody": {
        "json": {
          "name": "{{destination.name}}",
          "type": "destination",
          "metadata": {
            "org_id": "{{destination.imsOrgId}}",
            "sandbox": "{{destination.sandboxName}}",
            "destination_id": "{{destination.id}}",
            "destination_name": "{{destination.name}}",
            "enrichmentAttributes": "{{destination.enrichmentAttributes}}"
          },
          "external_id": "{{destination.id}}"
        }
      },
      "responseFields": [
        {
          "value": "{{headers.X-Request-Id}}",
          "name": "externalAudienceId"
        }
      ],
      "responseErrorFields": [
        {
          "value": "{{root}}",
          "name": "message"
        }
      ]
    },
    "deleteDestination": {
      "url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/deleteDestination",
      "httpMethod": "DELETE",
      "headers": [
        {
          "value": "Bearer {{authData.token}}",
          "header": "Authorization"
        }
      ],
      "responseErrorFields": [
        {
          "value": "{{root}}",
          "name": "message"
        }
      ]
    }
  },
  "validations":[
      {
         "field":"string",
         "regex":"string"
      }
   ]
}'

응답

성공적인 응답은 업데이트된 대상자 템플릿의 세부 정보와 함께 HTTP 상태 200을 반환합니다.

API 오류 처리

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

다음 단계

이제 이 문서를 읽고 나면 대상 템플릿을 사용할 시점과 /authoring/audience-templates API 끝점을 사용하여 대상 템플릿을 업데이트하는 방법을 알 수 있습니다. Destination SDK을 사용하여 대상을 구성하는 방법을 읽고 대상 구성 프로세스에 이 단계가 어디에 맞는지 파악하십시오.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6