Destination SDK으로 생성된 대상의 서버 사양
대상 서버 사양은 Adobe Experience Platform에서 데이터를 수신할 대상 플랫폼의 유형 및 플랫폼과 대상 간의 통신 매개 변수를 정의합니다. 예:
이 구성 요소가 Destination SDK으로 만든 통합에 어디에 맞는지 이해하려면 구성 옵션 설명서의 다이어그램을 참조하거나 다음 대상 구성 개요 페이지를 참조하십시오.
/authoring/destination-servers
끝점을 통해 대상 서버 사양을 구성할 수 있습니다. 이 페이지에 표시된 구성 요소를 구성할 수 있는 자세한 API 호출 예는 다음 API 참조 페이지를 참조하십시오.
이 페이지에는 모든 구성 매개 변수와 함께 Destination SDK에서 지원하는 모든 대상 서버 유형이 표시됩니다. 대상을 만들 때 매개 변수 값을 자신의 매개 변수 값으로 바꿉니다.
지원되는 통합 유형 supported-integration-types
이 페이지에 설명된 기능을 지원하는 통합 유형에 대한 자세한 내용은 아래 표를 참조하십시오.
대상 서버를 생성 또는 업데이트할 때 이 페이지에 설명된 서버 유형 구성 중 하나를 사용하십시오. 통합 요구 사항에 따라 이러한 예제의 샘플 매개 변수 값을 자신의 매개 변수로 교체해야 합니다.
하드 코딩된 필드와 템플릿화된 필드 templatized-fields
Destination SDK을 통해 대상 서버를 만들 때 구성 매개 변수 값을 하드 코딩하거나 템플릿화된 필드를 사용하여 정의할 수 있습니다. 템플릿화된 필드를 사용하면 Platform UI에서 사용자가 제공한 값을 읽을 수 있습니다.
대상 서버 매개 변수에는 구성 가능한 필드가 두 개 있습니다. 이러한 옵션은 하드 코딩된 값을 사용할지 또는 템플릿화된 값을 사용할지 여부를 지정합니다.
templatingStrategy
필수. value
필드를 통해 하드 코딩된 값이 제공되는지 또는 UI에 사용자가 구성할 수 있는 값이 있는지 정의합니다. 지원되는 값:
NONE
:value
매개 변수를 통해 매개 변수 값을 하드 코딩하는 경우 이 값을 사용하십시오(다음 행 참조). 예:"value": "my-storage-bucket"
.PEBBLE_V1
: 사용자가 UI에서 매개 변수 값을 제공하도록 할 때 이 값을 사용합니다. 예:"value": "{{customerData.bucket}}"
.
value
필수. 매개 변수 값을 정의합니다. 지원되는 값 유형:
- 하드 코딩된 값: 사용자가 UI에 매개 변수 값을 입력할 필요가 없는 경우 하드 코딩된 값(예:
"value": "my-storage-bucket"
)을 사용합니다. 값을 하드 코딩하는 경우templatingStrategy
은(는) 항상NONE
(으)로 설정되어야 합니다. - 템플릿화된 값: 사용자가 UI에서 매개 변수 값을 제공하도록 할 때 템플릿화된 값(예:
"value": "{{customerData.bucket}}"
)을 사용하십시오. 템플릿화된 값을 사용할 때는templatingStrategy
을(를) 항상PEBBLE_V1
(으)로 설정해야 합니다.
하드 코딩된 필드와 템플릿화된 필드를 사용해야 하는 경우
하드 코딩된 필드와 템플릿화된 필드는 만드는 통합 유형에 따라 Destination SDK에서 각각 고유한 용도가 있습니다.
사용자 입력 없이 대상에 연결
사용자가 Platform UI에서 대상에 연결할 때 입력 없이 대상 연결 프로세스를 처리할 수 있습니다.
이를 위해 서버 사양에서 대상 플랫폼 연결 매개변수를 하드 코딩할 수 있습니다. 대상 서버 구성에서 하드 코딩된 매개 변수 값을 사용하면 사용자의 입력 없이 Adobe Experience Platform과 대상 플랫폼 간의 연결이 처리됩니다.
아래 예에서 파트너는 path.value
필드가 하드코딩된 데이터 랜딩 영역 대상 서버를 만듭니다.
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"NONE",
"value":"Your/hardcoded/path/here"
},
"useCase": "Your use case"
}
}
따라서 사용자가 대상 연결 자습서를 진행할 때 인증 단계가 표시되지 않습니다. 대신, 아래 이미지에 표시된 대로 인증은 Platform에서 처리됩니다.
사용자 입력으로 대상에 연결
API 끝점 선택 또는 필드 값 제공과 같이, Platform UI의 특정 사용자 입력 후 Platform과 대상 간의 연결을 설정해야 하는 경우, 서버 사양의 템플릿화된 필드를 사용하여 사용자 입력을 읽고 대상 플랫폼에 연결할 수 있습니다.
아래 예에서 파트너는 실시간(스트리밍) 통합을 만들고 url.value
필드는 템플릿화된 매개 변수 {{customerData.region}}
을(를) 사용하여 사용자 입력을 기반으로 API 끝점의 일부를 개인화합니다.
{
"name":"Templatized API endpoint example",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.yourcompany.com/data/{{customerData.region}}/items"
}
}
}
사용자에게 플랫폼 UI에서 값을 선택할 수 있는 옵션을 제공하려면 region
매개 변수도 아래와 같이 대상 구성에서 고객 데이터 필드로 정의해야 합니다.
"customerDataFields":[
{
"name":"region",
"title":"Region",
"description":"Select an option",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"US",
"EU"
]
}
따라서 사용자가 대상 연결 자습서를 진행할 때 대상 플랫폼에 연결하려면 먼저 지역을 선택해야 합니다. 대상이 대상에 연결되면 아래 그림과 같이 템플릿화된 필드 {{customerData.region}}
이(가) 사용자가 UI에서 선택한 값으로 바뀝니다.
실시간(스트리밍) 대상 서버 streaming-example
이 대상 서버 유형을 사용하면 HTTP 요청을 통해 Adobe Experience Platform의 데이터를 대상으로 내보낼 수 있습니다. 서버 구성에는 메시지를 받는 서버(사용자 측 서버)에 대한 정보가 포함되어 있습니다.
이 프로세스는 사용자 데이터를 일련의 HTTP 메시지로 대상 플랫폼에 전달합니다. 아래의 매개 변수는 HTTP 서버 사양 템플릿을 형성합니다.
아래 샘플은 실시간(스트리밍) 대상에 대한 대상 서버 구성의 예를 보여줍니다.
{
"name":"Your destination server name",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"{YOUR_API_ENDPOINT}"
}
}
}
name
Moviestar destination server
.destinationServerType
URL_BASED
(으)로 설정합니다.templatingStrategy
필수.
value
필드에서 하드 코딩된 값 대신 템플릿화된 필드를 사용하는 경우PEBBLE_V1
을(를) 사용합니다. 사용자가 Platform UI에서 끝점 영역을 선택해야 하는https://api.moviestar.com/data/{{customerData.region}}/items
과(와) 같은 끝점이 있는 경우 이 옵션을 사용합니다.- Adobe 측에 템플릿 변환이 필요하지 않은 경우, 예를 들어 다음과 같은 끝점이 있는 경우
NONE
을(를) 사용합니다.https://api.moviestar.com/data/items
value
Amazon S3 대상 서버 s3-example
이 대상 서버를 사용하면 Adobe Experience Platform 데이터가 포함된 파일을 Amazon S3 스토리지로 내보낼 수 있습니다.
아래 샘플은 Amazon S3 대상에 대한 대상 서버 구성의 예를 보여줍니다.
{
"name":"Amazon S3 destination",
"destinationServerType":"FILE_BASED_S3",
"fileBasedS3Destination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_S3
(으)로 설정하십시오.fileBasedS3Destination.bucket.templatingStrategy
필수. bucket.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에 자신의 버킷 이름을 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드의 값을 읽으려면value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. - 통합에
"bucket.value":"MyBucket"
과(와) 같이 하드 코딩된 버킷 이름을 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedS3Destination.bucket.value
"value":"MyBucket"
과(와) 같이 하드 코딩된 값일 수 있습니다.fileBasedS3Destination.path.templatingStrategy
필수. path.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에서 자신의 경로를 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드의 값을 읽으려면path.value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. "bucket.value":"/path/to/MyBucket"
과(와) 같이 통합에 하드 코딩된 경로를 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedS3Destination.path.value
"value":"/path/to/MyBucket"
과(와) 같이 하드 코딩된 값일 수 있습니다.SFTP 대상 서버 sftp-example
이 대상 서버를 사용하면 Adobe Experience Platform 데이터가 포함된 파일을 SFTP 저장소 서버로 내보낼 수 있습니다.
아래 샘플은 SFTP 대상에 대한 대상 서버 구성의 예를 보여 줍니다.
{
"name":"File-based SFTP destination server",
"destinationServerType":"FILE_BASED_SFTP",
"fileBasedSFTPDestination":{
"rootDirectory":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.rootDirectory}}"
},
"hostName":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.hostName}}"
},
"port":22,
"encryptionMode":"PGP"
}
}
name
destinationServerType
FILE_BASED_SFTP
(으)로 설정하십시오.fileBasedSFTPDestination.rootDirectory.templatingStrategy
필수. rootDirectory.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에서 자신의 루트 디렉터리 경로를 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드에서 사용자가 제공한 값을 읽으려면rootDirectory.value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. "rootDirectory.value":"Storage/MyDirectory"
과(와) 같이 통합에 하드 코딩된 루트 디렉터리 경로를 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedSFTPDestination.rootDirectory.value
"value":"Storage/MyDirectory"
과(와) 같이 하드 코딩된 값일 수 있습니다.fileBasedSFTPDestination.hostName.templatingStrategy
필수. hostName.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에 자신의 호스트 이름을 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드에서 사용자가 제공한 값을 읽으려면hostName.value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. - 통합에 하드 코딩된 호스트 이름(예:
"hostName.value":"my.hostname.com"
)을 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedSFTPDestination.hostName.value
"hostName.value":"my.hostname.com"
과(와) 같이 하드 코딩된 값일 수 있습니다.port
encryptionMode
파일 암호화를 사용할지 여부를 나타냅니다. 지원되는 값:
- PGP
- None
Azure Data Lake Storage (ADLS) 대상 서버 adls-example
이 대상 서버를 사용하면 Adobe Experience Platform 데이터가 포함된 파일을 Azure Data Lake Storage 계정으로 내보낼 수 있습니다.
아래 샘플은 Azure Data Lake Storage 대상에 대한 대상 서버 구성의 예를 보여 줍니다.
{
"name":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_ADLS_GEN2
(으)로 설정하십시오.fileBasedAdlsGen2Destination.path.templatingStrategy
필수. path.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에서 자신의 ADLS 폴더 경로를 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드의 값을 읽으려면path.value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. "abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/"
과(와) 같이 통합에 하드 코딩된 경로를 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedAdlsGen2Destination.path.value
abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/
과(와) 같이 하드 코딩된 값일 수 있습니다.Azure Blob Storage 대상 서버 blob-example
이 대상 서버를 사용하면 Adobe Experience Platform 데이터가 포함된 파일을 Azure Blob Storage 컨테이너로 내보낼 수 있습니다.
아래 샘플은 Azure Blob Storage 대상에 대한 대상 서버 구성의 예를 보여 줍니다.
{
"name":"Blob destination server",
"destinationServerType":"FILE_BASED_AZURE_BLOB",
"fileBasedAzureBlobDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"container":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.container}}"
}
}
}
name
destinationServerType
FILE_BASED_AZURE_BLOB
(으)로 설정하십시오.fileBasedAzureBlobDestination.path.templatingStrategy
필수. path.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에 자신의 Azure Blob 저장소 계정 URI를 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우path.value
필드를 템플릿으로 만들어 사용자가 입력한 고객 데이터 필드의 값을 읽어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. "path.value": "https://myaccount.blob.core.windows.net/"
과(와) 같이 통합에 하드 코딩된 경로를 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedAzureBlobDestination.path.value
https://myaccount.blob.core.windows.net/
과(와) 같이 하드 코딩된 값일 수 있습니다.fileBasedAzureBlobDestination.container.templatingStrategy
필수. container.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
fileBasedAzureBlobDestination.container.value
myContainer
과(와) 같이 하드 코딩된 값일 수 있습니다.Data Landing Zone (DLZ) 대상 서버 dlz-example
이 대상 서버를 사용하면 플랫폼 데이터가 포함된 파일을 Data Landing Zone 저장소로 내보낼 수 있습니다.
아래 샘플은 Data Landing Zone (DLZ) 대상에 대한 대상 서버 구성의 예입니다.
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"useCase": "Your use case"
}
}
name
destinationServerType
FILE_BASED_DLZ
(으)로 설정하십시오.fileBasedDlzDestination.path.templatingStrategy
필수. path.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에서 자신의 Data Landing Zone 계정을 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드의 값을 읽으려면path.value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. "path.value": "https://myaccount.blob.core.windows.net/"
과(와) 같이 통합에 하드 코딩된 경로를 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedDlzDestination.path.value
Google Cloud Storage 대상 서버 gcs-example
이 대상 서버를 사용하면 플랫폼 데이터가 포함된 파일을 Google Cloud Storage 계정으로 내보낼 수 있습니다.
아래 샘플은 Google Cloud Storage 대상에 대한 대상 서버 구성의 예를 보여 줍니다.
{
"name":"Google Cloud Storage Server",
"destinationServerType":"FILE_BASED_GOOGLE_CLOUD",
"fileBasedGoogleCloudStorageDestination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_GOOGLE_CLOUD
(으)로 설정하십시오.fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy
필수. bucket.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에 자신의 Google Cloud Storage 버킷 이름을 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드의 값을 읽으려면bucket.value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. - 통합에
"bucket.value": "my-bucket"
과(와) 같이 하드 코딩된 버킷 이름을 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedGoogleCloudStorageDestination.bucket.value
"value": "my-bucket"
과(와) 같이 하드 코딩된 값일 수 있습니다.fileBasedGoogleCloudStorageDestination.path.templatingStrategy
필수. path.value
필드에 사용된 값의 유형에 따라 이 값을 설정하십시오.
- 사용자가 Experience Platform UI에 자신의 Google Cloud Storage 버킷 경로를 입력하도록 하려면 이 값을
PEBBLE_V1
(으)로 설정하십시오. 이 경우 사용자가 입력한 고객 데이터 필드의 값을 읽으려면path.value
필드를 템플릿으로 만들어야 합니다. 이 사용 사례는 위의 예제에 나와 있습니다. "path.value": "/path/to/my-bucket"
과(와) 같이 통합에 하드 코딩된 경로를 사용하는 경우 이 값을NONE
(으)로 설정하십시오.
fileBasedGoogleCloudStorageDestination.path.value
"value": "/path/to/my-bucket"
과(와) 같이 하드 코딩된 값일 수 있습니다.다음 단계 next-steps
이 문서를 읽고 나면 대상 서버 사양의 의미와 대상 서버 사양을 구성하는 방법을 보다 잘 이해할 수 있습니다.
다른 대상 서버 구성 요소에 대한 자세한 내용은 다음 문서를 참조하십시오.