대상 끝점 API 작업

중요

API 엔드포인트: platform.adobe.io/data/core/activation/authoring/destinations

이 페이지에서는 를 사용하여 수행할 수 있는 모든 API 작업을 나열하고 설명합니다. /authoring/destinations API 엔드포인트. 이 종단점에서 지원하는 기능에 대한 설명은 다음을 참조하십시오 대상 구성.

대상 API 작업 시작

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

대상에 대한 구성 만들기

에 POST 요청을 만들어 새 대상 구성을 만들 수 있습니다 /authoring/destinations 엔드포인트.

API 형식

POST /authoring/destinations

요청

다음 요청은 페이로드에 제공된 매개 변수로 구성된 새 대상 구성을 만듭니다. 아래 페이로드에는 /authoring/destinations 엔드포인트. 호출에 모든 매개 변수를 추가할 필요는 없으며 API 요구 사항에 따라 템플릿을 사용자 지정할 수 있습니다.

curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
 -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 '
{
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}
매개 변수 유형 설명
name 문자열 Experience Platform 카탈로그에서 대상의 제목을 나타냅니다
description 문자열 Adobe이 대상 카드의 Experience Platform 대상 카탈로그에서 사용할 설명을 제공합니다. 4-5개 이하의 문장을 목표로 하라.
status 문자열 대상 카드의 라이프사이클 상태를 나타냅니다. 허용되는 값은 TEST, PUBLISHEDDELETED입니다. 사용 TEST 대상을 처음 구성할 때 사용합니다.
customerAuthenticationConfigurations 문자열 서버에 Experience Platform 고객을 인증하는 데 사용되는 구성을 나타냅니다. 자세한 내용은 authType 아래에 나열된 값을 반환합니다.
customerAuthenticationConfigurations.authType 문자열 허용되는 값은 다음과 같습니다 OAUTH2, BEARER.
customerDataFields.name 문자열 도입하는 사용자 정의 필드의 이름을 입력합니다.
customerDataFields.type 문자열 도입하는 사용자 지정 필드의 유형을 나타냅니다. 허용되는 값은 다음과 같습니다 string, object, integer
customerDataFields.title 문자열 Experience Platform 사용자 인터페이스에서 고객이 볼 수 있는 필드의 이름을 나타냅니다
customerDataFields.description 문자열 사용자 지정 필드에 대한 설명을 입력합니다.
customerDataFields.isRequired 부울 대상 설정 워크플로우에서 이 필드가 필요한지 여부를 나타냅니다.
customerDataFields.enum 문자열 사용자 지정 필드를 드롭다운 메뉴로 렌더링하고 사용자가 사용할 수 있는 옵션을 나열합니다.
customerDataFields.pattern 문자열 필요한 경우 사용자 지정 필드에 패턴을 적용합니다. 패턴을 적용하려면 정규 표현식을 사용합니다. 예를 들어 고객 ID에 숫자나 밑줄이 포함되지 않은 경우 을 입력합니다 ^[A-Za-z]+$ 을 입력합니다.
uiAttributes.documentationLink 문자열 에서 설명서 페이지를 참조합니다. 대상 카탈로그 목적지에 대해 지정합니다. 사용 https://www.adobe.com/go/destinations-YOURDESTINATION-en, 위치 YOURDESTINATION 은 대상의 이름입니다. Moviestar라는 대상의 경우 https://www.adobe.com/go/destinations-moviestar-en.
uiAttributes.category 문자열 Adobe Experience Platform에서 대상에 지정된 카테고리를 나타냅니다. 자세한 내용은 대상 카테고리. 다음 값 중 하나를 사용합니다. adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.
uiAttributes.connectionType 문자열 Server-to-server 은 현재 사용 가능한 유일한 옵션입니다.
uiAttributes.frequency 문자열 Streaming 은 현재 사용 가능한 유일한 옵션입니다.
identityNamespaces.externalId.acceptsAttributes 부울 대상이 표준 프로필 속성을 수락하는지 여부를 나타냅니다. 일반적으로 이러한 속성은 파트너의 설명서에 강조 표시됩니다.
identityNamespaces.externalId.acceptsCustomNamespaces 부울 고객이 대상에서 사용자 지정 네임스페이스를 설정할 수 있는지 여부를 나타냅니다.
identityNamespaces.externalId.allowedAttributesTransformation 문자열 예제 구성에 표시되지 않음. 예를 들어 Platform 고객은 일반 이메일 주소를 특성으로 사용하고 플랫폼에서는 해시된 이메일만 허용합니다. 여기에서 적용해야 하는 변형을 제공합니다(예: 이메일을 소문자로 변환한 다음 해시).
identityNamespaces.externalId.acceptedGlobalNamespaces - 플랫폼에서 표준 id 네임스페이스 (예: IDFA)가 있으므로 Platform 사용자가 이러한 ID 네임스페이스를 선택하도록 제한할 수 있습니다.
사용 시 acceptedGlobalNamespaces, 다음 사용 가능 "requiredTransformation":"sha256(lower($))" 을 소문자로 해시하고 이메일 주소 또는 전화 번호를 해시합니다.
destinationDelivery.authenticationRule 문자열 방법을 나타냅니다. Platform 고객이 대상에 연결합니다. 허용되는 값은 다음과 같습니다 CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • 사용 CUSTOMER_AUTHENTICATION 플랫폼 고객이 사용자 이름과 암호, 베어러 토큰 또는 다른 인증 방법을 통해 시스템에 로그인하는 경우. 예를 들어, 이 옵션을 선택한 경우에도 이 옵션을 선택합니다 authType: OAUTH2 또는 authType:BEARER in customerAuthenticationConfigurations.
  • 사용 PLATFORM_AUTHENTICATION Adobe과 대상 및 대상 사이에 글로벌 인증 시스템이 있는 경우 Platform 고객은 대상에 연결하기 위해 인증 자격 증명을 제공할 필요가 없습니다. 이 경우 자격 증명 구성.
  • 사용 NONE 대상 플랫폼으로 데이터를 전송하는 데 인증이 필요하지 않은 경우
destinationDelivery.destinationServerId 문자열 다음 instanceId대상 서버 템플릿 이 대상에 사용됩니다.
backfillHistoricalProfileData 부울 세그먼트가 대상으로 활성화될 때 이전 프로필 데이터를 내보내지 여부를 제어합니다.
  • true: Platform 세그먼트가 활성화되기 전에 세그먼트에 대해 자격이 있는 내역 사용자 프로필을 보냅니다.
  • false: Platform 세그먼트가 활성화된 후에 세그먼트에 대한 자격이 되는 사용자 프로필만 포함합니다.
segmentMappingConfig.mapUserInput 부울 대상 활성화 워크플로우의 세그먼트 매핑 ID가 사용자가 입력하는지 여부를 제어합니다.
segmentMappingConfig.mapExperiencePlatformSegmentId 부울 대상 활성화 워크플로우의 세그먼트 매핑 ID가 Experience Platform 세그먼트 ID인지 여부를 제어합니다.
segmentMappingConfig.mapExperiencePlatformSegmentName 부울 대상 활성화 워크플로우의 세그먼트 매핑 ID가 Experience Platform 세그먼트 이름인지 여부를 제어합니다.
segmentMappingConfig.audienceTemplateId 부울 다음 instanceId대상 메타데이터 템플릿 이 대상에 사용됩니다.
schemaConfig.profileFields 어레이 사전 정의된 profileFields 위의 구성에 표시된 대로, 사용자는 Experience Platform 속성을 대상 측의 사전 정의된 속성에 매핑하는 옵션을 제공합니다.
schemaConfig.profileRequired 부울 사용 true 위의 예제 구성에 표시된 대로 사용자가 Experience Platform의 프로필 속성을 대상의 사용자 지정 속성에 매핑할 수 있어야 합니다.
schemaConfig.segmentRequired 부울 항상 사용 segmentRequired:true.
schemaConfig.identityRequired 부울 사용 true 사용자가 Experience Platform의 ID 네임스페이스를 원하는 스키마에 매핑할 수 있어야 합니다.
aggregation.aggregationType - BEST_EFFORT 또는 CONFIGURABLE_AGGREGATION 중 하나를 선택합니다. 위의 예제 구성은 다음과 같습니다 BEST_EFFORT 합계. 예 CONFIGURABLE_AGGREGATION에서 의 예제 구성을 참조하십시오. 대상 구성 문서. 구성 가능한 집합과 관련된 매개 변수는 이 표에 아래에 설명되어 있습니다.
aggregation.bestEffortAggregation.maxUsersPerRequest 정수 Experience Platform은 내보낸 여러 프로필을 단일 HTTP 호출로 집계할 수 있습니다. 하나의 HTTP 호출에서 엔드포인트가 수신할 최대 프로필 수를 지정합니다. 이는 최상의 노력 집계에 해당합니다. 예를 들어 값 100을 지정하는 경우 Platform은 호출 시 100보다 작은 수의 프로필을 전송할 수 있습니다.
서버가 요청당 여러 사용자를 허용하지 않는 경우 이 값을 1로 설정하십시오.
aggregation.bestEffortAggregation.splitUserById 부울 대상에 대한 호출이 ID로 분할되어야 하는 경우 이 플래그를 사용합니다. 이 플래그를 로 설정 true 서버가 특정 네임스페이스에 대해 호출당 하나의 ID만 허용하는 경우.
aggregation.configurableAggregation.splitUserById 부울 구성 예는 매개 변수 를 참조하십시오 여기. 대상에 대한 호출이 ID로 분할되어야 하는 경우 이 플래그를 사용합니다. 이 플래그를 로 설정 true 서버가 특정 네임스페이스에 대해 호출당 하나의 ID만 허용하는 경우.
aggregation.configurableAggregation.maxBatchAgeInSecs 정수 최대값: 3600년. 구성 예는 매개 변수 를 참조하십시오 여기. 함께 maxNumEventsInBatch로 지정하는 경우 엔드포인트에 API 호출을 전송할 때까지 Experience Platform이 대기하는 시간을 결정합니다.
예를 들어 두 매개 변수에 최대 값을 사용하는 경우 Experience Platform은 API 호출을 수행하기 전에 10.000개의 정규화된 프로필이 있을 때까지 3600초 또는 10.000개의 대기 중 가장 먼저 수행됩니다.
aggregation.configurableAggregation.maxNumEventsInBatch 정수 최대값: 10000. 구성 예는 매개 변수 를 참조하십시오 여기. 자세한 내용은 maxBatchAgeInSecs 바로 위에요
aggregation.configurableAggregation.aggregationKey 부울 구성 예는 매개 변수 를 참조하십시오 여기. 아래 매개 변수를 기반으로 대상에 매핑된 내보낸 프로필을 집계할 수 있습니다.
  • 세그먼트 ID
  • 세그먼트 상태
  • id 네임스페이스
aggregation.configurableAggregation.aggregationKey.includeSegmentId 부울 구성 예는 매개 변수 를 참조하십시오 여기. 을(를) (으)로 설정합니다. true 대상으로 내보낸 프로필을 세그먼트 ID별로 그룹화하려면
aggregation.configurableAggregation.aggregationKey.includeSegmentStatus 부울 구성 예는 매개 변수 를 참조하십시오 여기. 둘 다 설정해야 합니다 includeSegmentId:trueincludeSegmentStatus:true 대상으로 내보낸 프로필을 세그먼트 ID 및 세그먼트 상태별로 그룹화하려면
aggregation.configurableAggregation.aggregationKey.includeIdentity 부울 구성 예는 매개 변수 를 참조하십시오 여기. 을(를) (으)로 설정합니다. true id 네임스페이스로 대상에 내보낸 프로필을 그룹화하려는 경우.
aggregation.configurableAggregation.aggregationKey.oneIdentityPerGroup 부울 구성 예는 매개 변수 를 참조하십시오 여기. 이 매개 변수를 사용하여 내보낸 프로필을 단일 ID(GAID, IDFA, 전화번호, 이메일 등) 그룹으로 집계할지 여부를 지정합니다.
aggregation.configurableAggregation.aggregationKey.groups 문자열 구성 예는 매개 변수 를 참조하십시오 여기. 대상에 내보낸 프로필을 ID 네임스페이스 그룹으로 그룹화하려면 ID 그룹 목록을 만듭니다. 예를 들어, 예제의 구성을 사용하여 IDFA 및 GAID 모바일 식별자를 포함하는 프로필을 대상에 대한 한 호출로 결합하고 이메일을 다른 호출로 결합할 수 있습니다.

응답

성공적인 응답은 새로 만든 대상 구성에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다.

대상 구성 나열

IMS 조직에 대한 모든 대상 구성 목록을 검색하려면 /authoring/destinations 엔드포인트.

API 형식

GET /authoring/destinations

요청

다음 요청은 IMS 조직 및 샌드박스 구성을 기반으로 액세스 권한이 있는 대상 구성 목록을 검색합니다.

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

다음 응답은 사용한 IMS 조직 ID 및 샌드박스 이름을 기반으로 액세스 권한이 있는 대상 구성 목록과 함께 HTTP 상태 200을 반환합니다. 1개 instanceId 는 한 대상에 대한 템플릿에 해당합니다. 간결성을 위해 응답이 잘립니다.

{
   "items":[
      {
         "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
         "createdDate":"2020-10-28T06:14:09.784471Z",
         "lastModifiedDate":"2021-06-28T06:14:09.784471Z",
         "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
         "sandboxName":"prod",
         "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
         "name":"Moviestar",
         "description":"Moviestar is a fictional destination, used for this example.",
         "status":"TEST",
         "customerAuthenticationConfigurations":[
            {
               "authType":"BEARER"
            }
         ],
         "customerDataFields":[
            {
               "name":"endpointsInstance",
               "type":"string",
               "title":"Select Endpoint",
               "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
               "isRequired":true,
               "enum":[
                  "US",
                  "EU",
                  "APAC",
                  "NZ"
               ]
            },
            {
               "name":"customerID",
               "type":"string",
               "title":"Moviestar Customer ID",
               "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
               "isRequired":true,
               "pattern":"^[A-Za-z]+$"
            }
         ],
         "uiAttributes":{
            "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
            "category":"mobile",
            "connectionType":"Server-to-server",
            "frequency":"Streaming"
         },
         "identityNamespaces":{
            "external_id":{
               "acceptsAttributes":true,
               "acceptsCustomNamespaces":true,
               "acceptedGlobalNamespaces":{
                  "Email":{
                     
                  }
               }
            },
            "another_id":{
               "acceptsAttributes":true,
               "acceptsCustomNamespaces":true
            }
         },
         "segmentMappingConfig":{
            "mapExperiencePlatformSegmentName":false,
            "mapExperiencePlatformSegmentId":false,
            "mapUserInput":false,
            "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
         },
         "schemaConfig":{
            "profileFields":[
               {
                  "name":"a_custom_attribute",
                  "title":"a_custom_attribute",
                  "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
                  "type":"string",
                  "isRequired":false,
                  "readOnly":false,
                  "hidden":false
               }
            ],
            "profileRequired":true,
            "segmentRequired":true,
            "identityRequired":true
         },
         "aggregation":{
            "aggregationType":"BEST_EFFORT",
            "bestEffortAggregation":{
               "maxUsersPerRequest":10,
               "splitUserById":false
            }
         },
         "destinationDelivery":[
            {
               "authenticationRule":"CUSTOMER_AUTHENTICATION",
               "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
            }
         ],
         "destConfigId":"410631b8-f6b3-4b7c-82da-7998aa3f327c",
         "backfillHistoricalProfileData":true
      }
   ]
}
    
매개 변수 유형 설명
name 문자열 Experience Platform 카탈로그에서 대상의 제목을 나타냅니다.
description 문자열 Adobe이 대상 카드의 Experience Platform 대상 카탈로그에서 사용할 설명을 제공합니다. 4-5개 이하의 문장을 목표로 하라.
status 문자열 대상 카드의 라이프사이클 상태를 나타냅니다. 허용되는 값은 TEST, PUBLISHEDDELETED입니다. 사용 TEST 대상을 처음 구성할 때 사용합니다.
customerAuthenticationConfigurations 문자열 서버에 Experience Platform 고객을 인증하는 데 사용되는 구성을 나타냅니다. 자세한 내용은 authType 아래에 나열된 값을 반환합니다.
customerAuthenticationConfigurations.authType 문자열 허용되는 값은 다음과 같습니다 OAUTH2, BEARER.
customerDataFields.name 문자열 도입하는 사용자 정의 필드의 이름을 입력합니다.
customerDataFields.type 문자열 도입하는 사용자 지정 필드의 유형을 나타냅니다. 허용되는 값은 다음과 같습니다 string, object, integer
customerDataFields.title 문자열 Experience Platform 사용자 인터페이스에서 고객이 볼 수 있는 필드의 이름을 나타냅니다
customerDataFields.description 문자열 사용자 지정 필드에 대한 설명을 입력합니다.
customerDataFields.isRequired 부울 대상 설정 워크플로우에서 이 필드가 필요한지 여부를 나타냅니다.
customerDataFields.enum 문자열 사용자 지정 필드를 드롭다운 메뉴로 렌더링하고 사용자가 사용할 수 있는 옵션을 나열합니다.
customerDataFields.pattern 문자열 필요한 경우 사용자 지정 필드에 패턴을 적용합니다. 패턴을 적용하려면 정규 표현식을 사용합니다. 예를 들어 고객 ID에 숫자나 밑줄이 포함되지 않은 경우 을 입력합니다 ^[A-Za-z]+$ 을 입력합니다.
uiAttributes.documentationLink 문자열 에서 설명서 페이지를 참조합니다. 대상 카탈로그 목적지에 대해 지정합니다. 사용 https://www.adobe.com/go/destinations-YOURDESTINATION-en, 위치 YOURDESTINATION 은 대상의 이름입니다. Moviestar라는 대상의 경우 https://www.adobe.com/go/destinations-moviestar-en
uiAttributes.category 문자열 Adobe Experience Platform에서 대상에 지정된 카테고리를 나타냅니다. 자세한 내용은 대상 카테고리. 다음 값 중 하나를 사용합니다. adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments
uiAttributes.connectionType 문자열 Server-to-server 은 현재 사용 가능한 유일한 옵션입니다.
uiAttributes.frequency 문자열 Streaming 은 현재 사용 가능한 유일한 옵션입니다.
identityNamespaces.externalId.acceptsAttributes 부울 대상이 표준 프로필 속성을 수락하는지 여부를 나타냅니다. 일반적으로 이러한 속성은 파트너의 설명서에 강조 표시됩니다.
identityNamespaces.externalId.acceptsCustomNamespaces 부울 고객이 대상에서 사용자 지정 네임스페이스를 설정할 수 있는지 여부를 나타냅니다. 자세한 내용 사용자 지정 네임스페이스 Adobe Experience Platform.
identityNamespaces.externalId.allowedAttributesTransformation 문자열 예제 구성에 표시되지 않음. 예를 들어 Platform 고객은 일반 이메일 주소를 특성으로 사용하고 플랫폼에서는 해시된 이메일만 허용합니다. 여기에서 적용해야 하는 변형을 제공합니다(예: 이메일을 소문자로 변환한 다음 해시).
identityNamespaces.externalId.acceptedGlobalNamespaces - 플랫폼에서 표준 id 네임스페이스 (예: IDFA)가 있으므로 Platform 사용자가 이러한 ID 네임스페이스를 선택하도록 제한할 수 있습니다.
destinationDelivery.authenticationRule 문자열 방법을 나타냅니다. Platform 고객이 대상에 연결합니다. 허용되는 값은 다음과 같습니다 CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • 사용 CUSTOMER_AUTHENTICATION 플랫폼 고객이 사용자 이름과 암호, 베어러 토큰 또는 다른 인증 방법을 통해 시스템에 로그인하는 경우. 예를 들어, 이 옵션을 선택한 경우에도 이 옵션을 선택합니다 authType: OAUTH2 또는 authType:BEARER in customerAuthenticationConfigurations.
  • 사용 PLATFORM_AUTHENTICATION Adobe과 대상 및 대상 사이에 글로벌 인증 시스템이 있는 경우 Platform 고객은 대상에 연결하기 위해 인증 자격 증명을 제공할 필요가 없습니다. 이 경우 자격 증명 구성.
  • 사용 NONE 대상 플랫폼으로 데이터를 전송하는 데 인증이 필요하지 않은 경우
destinationDelivery.destinationServerId 문자열 다음 instanceId대상 서버 템플릿 이 대상에 사용됩니다.
destConfigId 문자열 이 필드는 자동으로 생성되며 입력이 필요하지 않습니다.
backfillHistoricalProfileData 부울 세그먼트가 대상으로 활성화될 때 이전 프로필 데이터를 내보내지 여부를 제어합니다.
  • true: Platform 세그먼트가 활성화되기 전에 세그먼트에 대해 자격이 있는 내역 사용자 프로필을 보냅니다.
  • false: Platform 세그먼트가 활성화된 후에 세그먼트에 대한 자격이 되는 사용자 프로필만 포함합니다.
segmentMappingConfig.mapUserInput 부울 대상 활성화 워크플로우의 세그먼트 매핑 ID가 사용자가 입력하는지 여부를 제어합니다.
segmentMappingConfig.mapExperiencePlatformSegmentId 부울 대상 활성화 워크플로우의 세그먼트 매핑 ID가 Experience Platform 세그먼트 ID인지 여부를 제어합니다.
segmentMappingConfig.mapExperiencePlatformSegmentName 부울 대상 활성화 워크플로우의 세그먼트 매핑 ID가 Experience Platform 세그먼트 이름인지 여부를 제어합니다.
segmentMappingConfig.audienceTemplateId 부울 다음 instanceId대상 메타데이터 템플릿 이 대상에 사용됩니다. 대상 메타데이터 템플릿을 설정하려면 다음을 참조하십시오. 대상 메타데이터 API 참조.

기존 대상 구성 업데이트

에 PUT 요청을 작성하여 기존 대상 구성을 업데이트할 수 있습니다 /authoring/destinations 업데이트하려는 대상 구성의 인스턴스 ID를 제공하는 끝점입니다. 호출 본문에서 업데이트된 대상 구성을 제공합니다.

API 형식

PUT /authoring/destinations/{INSTANCE_ID}
매개 변수 설명
{INSTANCE_ID} 업데이트할 대상 구성의 ID입니다.

요청

다음 요청은 페이로드에 제공된 매개 변수로 구성된 기존 대상 구성을 업데이트합니다. 아래 예제 호출에서 구성을 업데이트합니다 이전에 생성됨 이제 GAID, IDFA 및 해시된 이메일 식별자를 id 네임스페이스로 허용합니다.

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-04-28T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

특정 대상 구성 검색

에 GET 요청을 수행하여 특정 대상 구성에 대한 세부 정보를 검색할 수 있습니다 /authoring/destinations 엔드포인트 및 검색할 대상 구성의 인스턴스 ID를 제공합니다.

API 형식

GET /authoring/destinations/{INSTANCE_ID}
매개 변수 설명
{INSTANCE_ID} 검색할 대상 구성의 ID입니다.

요청

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 지정된 대상 구성에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다.

{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-06-04T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
               
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

특정 대상 구성 삭제

에 DELETE 요청을 수행하여 지정된 대상 구성을 삭제할 수 있습니다 /authoring/destinations 엔드포인트 및 요청 경로에서 삭제할 대상 구성의 ID를 제공합니다.

API 형식

DELETE /authoring/destinations/{INSTANCE_ID}
매개 변수 설명
{INSTANCE_ID} 다음 id 삭제할 대상 구성 중 하나입니다.

요청

curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

응답

성공적인 응답은 빈 HTTP 응답과 함께 HTTP 상태 200을 반환합니다.

API 오류 처리

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

다음 단계

이 문서를 읽은 후에는 /authoring/destinations API 엔드포인트. 읽기 대상 SDK를 사용하여 대상을 구성하는 방법 대상 구성 프로세스에 이 단계가 어떤 영향을 주는지 이해하기 위해 노력합니다.

이 페이지에서는