이 자습서에서는 를 사용하여 클라우드 스토리지의 구조와 콘텐츠를 탐색하고 미리 보는 방법에 대한 단계를 제공합니다. Flow Service API.
클라우드 스토리지를 탐색하려면 클라우드 스토리지 소스에 대한 유효한 기본 연결 ID가 이미 있어야 합니다. 이 ID가 없는 경우 소스 개요 기본 연결을 만들 수 있는 클라우드 스토리지 소스 목록의 경우
이 안내서를 사용하려면 Adobe Experience Platform의 다음 구성 요소에 대해 이해하고 있어야 합니다.
Platform API를 성공적으로 호출하는 방법에 대한 자세한 내용은 의 안내서를 참조하십시오. platform API 시작하기.
에 GET 요청을 하여 클라우드 스토리지 폴더의 구조에 대한 정보를 검색할 수 있습니다. Flow Service 소스의 기본 연결 ID를 제공하는 동안 API입니다.
클라우드 스토리지를 탐색하기 위해 GET 요청을 수행할 때 아래 표에 나열된 쿼리 매개 변수를 포함해야 합니다.
매개변수 | 설명 |
---|---|
objectType |
탐색하려는 오브젝트의 유형입니다. 이 값을 다음 중 하나로 설정합니다.
|
object |
이 매개 변수는 특정 디렉터리를 볼 때만 필요합니다. 해당 값은 탐색하려는 디렉터리의 경로를 나타냅니다. |
API 형식
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}
매개변수 | 설명 |
---|---|
{BASE_CONNECTION_ID} |
클라우드 스토리지 소스의 기본 연결 ID입니다. |
{PATH} |
디렉터리의 경로입니다. |
요청
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/dc3c0646-5e30-47be-a1ce-d162cb8f1f07/explore?objectType=folder&object=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공한 응답은 쿼리된 디렉터리 내에서 발견된 파일 및 폴더 배열을 반환합니다. 다음 사항에 유의하십시오. path
다음 단계에서 파일 구조를 검사하여 제공해야 하므로 업로드하려는 파일의 속성입니다.
[
{
"type": "file",
"name": "account.csv",
"path": "/test-connectors/testFolder-fileIngestion/account.csv",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "profileData.json",
"path": "/test-connectors/testFolder-fileIngestion/profileData.json",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "sampleprofile--3.parquet",
"path": "/test-connectors/testFolder-fileIngestion/sampleprofile--3.parquet",
"canPreview": true,
"canFetchSchema": true
}
]
클라우드 스토리지에서 데이터 파일의 구조를 검사하려면 파일의 경로와 유형을 쿼리 매개 변수로 제공하면서 GET 요청을 수행합니다.
파일의 경로와 유형을 제공하면서 GET 요청을 수행하여 클라우드 스토리지 소스의 데이터 파일 구조를 검사할 수 있습니다. 쿼리 매개 변수의 일부로 파일 형식을 지정하여 CSV, TSV 또는 압축 JSON과 같은 다양한 파일 형식과 구분된 파일을 검사할 수도 있습니다.
API 형식
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&{QUERY_PARAMS}&preview=true
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&columnDelimiter=\t
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&compressionType=gzip;
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=FILE&object={FILE_PATH}&preview=true&fileType=delimited&encoding=ISO-8859-1;
매개변수 | 설명 |
---|---|
{BASE_CONNECTION_ID} |
클라우드 저장소 소스 커넥터의 연결 ID입니다. |
{FILE_PATH} |
검사할 파일의 경로입니다. |
{FILE_TYPE} |
파일의 유형입니다. 지원되는 파일 유형은 다음과 같습니다.
|
{QUERY_PARAMS} |
결과를 필터링하는 데 사용할 수 있는 선택적 쿼리 매개 변수입니다. 의 섹션을 참조하십시오. 쿼리 매개 변수 추가 정보. |
요청
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=file&object=/aep-bootcamp/Adobe%20Pets%20Customer%2020190801%20EXP.json&fileType=json&preview=true' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-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"
}
]
다음 Flow Service API 에서는 쿼리 매개 변수를 사용하여 다양한 파일 형식을 미리 보고 검사할 수 있습니다.
매개변수 | 설명 |
---|---|
columnDelimiter |
CSV 또는 TSV 파일을 검사하기 위해 열 구분 기호로 지정한 단일 문자 값입니다. 매개 변수를 제공하지 않으면 기본값은 쉼표로 설정됩니다 (,) . |
compressionType |
압축된 구분 기호 또는 JSON 파일을 미리 보기 위한 필수 쿼리 매개 변수입니다. 지원되는 압축 파일은 다음과 같습니다.
|
encoding |
미리 보기를 렌더링할 때 사용할 인코딩 유형을 정의합니다. 지원되는 인코딩 유형은 다음과 같습니다. UTF-8 및 ISO-8859-1 . 참고: encoding 매개 변수는 구분된 CSV 파일을 수집할 때만 사용할 수 있습니다. 다른 파일 유형은 기본 인코딩으로 수집됩니다. UTF-8 . |
이 자습서에 따라 클라우드 스토리지 시스템을 탐색하여 가져올 파일의 경로를 찾았습니다 Platform, 그리고 해당 구조를 살펴보았습니다. 다음 자습서에서 이 정보를 사용하여 다음을 수행할 수 있습니다. 클라우드 스토리지에서 데이터를 수집하고 플랫폼으로 가져옵니다..