이 자습서에서는 Flow Service API를 사용하여 타사 클라우드 스토리지 시스템을 탐색합니다.
이 가이드를 사용하려면 다음과 같은 Adobe Experience Platform 구성 요소에 대해 작업해야 합니다.
다음 섹션에서는 Flow Service API를 사용하여 클라우드 스토리지 시스템에 성공적으로 접속하기 위해 알아야 할 추가 정보를 제공합니다.
Platform API를 사용하여 타사 클라우드 스토리지를 탐색하려면 유효한 연결 ID를 보유해야 합니다. 작업할 저장소에 대한 연결이 아직 없는 경우 다음 자습서를 통해 연결을 만들 수 있습니다.
이 자습서에서는 요청의 서식을 지정하는 방법을 보여주는 API 호출 예를 제공합니다. 여기에는 경로, 필수 헤더 및 올바른 형식의 요청 페이로드가 포함됩니다. API 응답으로 반환된 샘플 JSON도 제공됩니다. 샘플 API 호출에 대한 설명서에 사용된 규칙에 대한 자세한 내용은 Experience Platform 문제 해결 안내서의 API 호출 예를 읽는 방법에 대한 섹션을 참조하십시오.
Platform API를 호출하려면 먼저 인증 자습서를 완료해야 합니다. 인증 자습서를 완료하면 아래와 같이 모든 Experience Platform API 호출에서 각 필수 헤더에 대한 값을 제공합니다.
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Flow Service에 속하는 리소스를 포함하여 Experience Platform의 모든 리소스는 특정 가상 샌드박스로 구분됩니다. Platform API에 대한 모든 요청에는 작업이 수행할 샌드박스의 이름을 지정하는 헤더가 필요합니다.
x-sandbox-name: {SANDBOX_NAME}
페이로드(POST, PUT, PATCH)을 포함하는 모든 요청에는 추가 미디어 유형 헤더가 필요합니다.
Content-Type: application/json
클라우드 스토리지에 대한 연결 ID를 사용하여 GET 요청을 수행하여 파일 및 디렉터리를 탐색할 수 있습니다. 클라우드 스토리지를 탐색하기 위한 GET 요청을 수행할 때 아래 표에 나열된 쿼리 매개 변수를 포함해야 합니다.
매개 변수 | 설명 |
---|---|
objectType |
탐색할 객체의 유형입니다. 다음 중 하나로 이 값을 설정합니다.
|
object |
이 매개 변수는 특정 디렉토리를 볼 때만 필요합니다. 이 값은 탐색할 디렉토리의 경로를 나타냅니다. |
다음 호출을 사용하여 Platform에 가져올 파일의 경로를 찾습니다.
API 형식
GET /connections/{CONNECTION_ID}/explore?objectType=root
GET /connections/{CONNECTION_ID}/explore?objectType=folder&object={PATH}
매개 변수 | 설명 |
---|---|
{CONNECTION_ID} |
클라우드 스토리지 소스 커넥터의 연결 ID입니다. |
{PATH} |
디렉토리 경로입니다. |
요청
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/{CONNECTION_ID}/explore?objectType=folder&object=/some/path/' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답으로 쿼리된 디렉터리 내에 있는 파일 및 폴더의 배열을 반환합니다. 다음 단계에서 해당 구조를 검사하기 위해 파일을 제공해야 하므로 업로드할 파일의 path
속성을 주의하십시오.
[
{
"type": "File",
"name": "data.csv",
"path": "/some/path/data.csv"
},
{
"type": "Folder",
"name": "foobar",
"path": "/some/path/foobar"
}
]
클라우드 저장소에서 데이터 파일의 구조를 검사하려면 파일의 경로를 제공하고 쿼리 매개 변수로 입력하는 동안 GET 요청을 수행합니다.
사용자 지정 구분 기호를 쿼리 둘레로 지정하여 CSV 또는 TSV 파일의 구조를 검사할 수 있습니다. 단일 문자 값은 허용되는 열 구분 기호입니다. 제공되지 않으면 쉼표 (,)
이 기본값으로 사용됩니다.
API 형식
GET /connections/{CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}
GET /connections/{CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&preview=true&fileType=delimited&columnDelimiter=;
GET /connections/{CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&preview=true&fileType=delimited&columnDelimiter=\t
매개 변수 | 설명 |
---|---|
{CONNECTION_ID} |
클라우드 스토리지 소스 커넥터의 연결 ID입니다. |
{FILE_PATH} |
검사할 파일의 경로입니다. |
{FILE_TYPE} |
파일의 유형입니다. 지원되는 파일 유형은 다음과 같습니다.
|
columnDelimiter |
CSV 또는 TSV 파일을 검사하기 위해 열 구분 기호로 지정한 단일 문자 값. 매개 변수를 제공하지 않으면 값의 기본값은 쉼표 (,) 입니다. |
요청
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/{CONNECTION_ID}/explore?objectType=file&object=/some/path/data.csv&fileType=DELIMITED' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 테이블 이름 및 데이터 유형을 포함하여 쿼리된 파일의 구조를 반환합니다.
[
{
"name": "Id",
"type": "String"
},
{
"name": "FirstName",
"type": "String"
},
{
"name": "LastName",
"type": "String"
},
{
"name": "Email",
"type": "String"
},
{
"name": "Phone",
"type": "String"
}
]
이 튜토리얼을 따라 클라우드 스토리지 시스템을 탐색하고 Platform에 가져올 파일의 경로를 찾아 구조를 확인합니다. 다음 튜토리얼에서 이 정보를 사용하여 클라우드 저장소에서 데이터를 수집하고 플랫폼](…/collect/cloud-storage.md)에 가져올 수 있습니다.[