CSV 템플릿을 스키마 변환 API 엔드포인트로
다음 /rpc/csv2schema
의 엔드포인트 Schema Registry API를 사용하면 CSV 파일을 템플릿으로 사용하여 XDM(경험 데이터 모델) 스키마를 자동으로 만들 수 있습니다. 이 끝점을 사용하면 템플릿을 만들어 스키마 필드를 대량 가져오고 수동 API 또는 UI 작업을 줄일 수 있습니다.
시작하기
다음 /rpc/csv2schema
끝점이 의 일부임 Schema Registry API. 계속하기 전에 다음을 검토하십시오. 시작 안내서 관련 설명서에 대한 링크, 이 문서의 샘플 API 호출 읽기에 대한 안내서 및 Adobe Experience Platform API를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보입니다.
다음 /rpc/csv2schema
끝점은 이 지원하는 원격 프로시저 호출(RPC)의 일부입니다. Schema Registry. 의 다른 끝점과 달리 Schema Registry API, RPC 끝점에는 다음과 같은 추가 헤더가 필요하지 않습니다. Accept
또는 Content-Type
, 및 를 사용하지 않음 CONTAINER_ID
. 대신 /rpc
아래 API 호출에 나와 있는 대로 네임스페이스.
CSV 파일 요구 사항
이 끝점을 사용하려면 먼저 적절한 열 헤더와 해당 값이 있는 CSV 파일을 만들어야 합니다. 일부 열은 필수이고 나머지는 선택 사항입니다. 아래 표에서는 이러한 열과 스키마 구성에서 해당 역할에 대해 설명합니다.
isIgnored
true
는 필드가 API 업로드에 준비되지 않았으므로 무시해야 함을 나타냅니다.isCustom
fieldGroupId
fieldGroupName
기존 표준 필드를 확장하지 않는 사용자 정의 필드의 경우 선택 사항입니다. 비워 두면 이름이 자동으로 할당됩니다.
표준 필드 그룹을 확장하는 표준 필드 또는 사용자 정의 필드에 필요하며, 이 필드는
fieldGroupId
.fieldPath
fieldGroupName
), 값을 로 설정합니다. ALL
.displayName
fieldDescription
dataType
If
dataType
이(가) (으)로 설정됨 object
, 중 하나 properties
또는 $ref
동일한 행에 대해서도 정의해야 하지만 둘 다 정의해서는 안 됩니다.isRequired
isArray
dataType
.isIdentity
isPrimaryIdentity
minimum
maximum
enum
[value1,value2,value3]
).stringPattern
format
minLength
maxLength
properties
dataType
이(가) (으)로 설정됨 object
및 $ref
가 정의되지 않았습니다. 오브젝트 본문을 JSON 문자열로 정의합니다(예: {"myField": {"type": "string"}}
).$ref
dataType
이(가) (으)로 설정됨 object
및 properties
가 정의되지 않았습니다. 다음을 정의합니다. $id
객체 유형에 대해 참조된 객체(예: https://ns.adobe.com/xdm/context/person
).comment
isIgnored
이(가) (으)로 설정됨 true
, 이 열은 스키마의 헤더 정보를 제공하는 데 사용됩니다.다음을 참조하십시오 CSV 템플릿 를 사용하여 CSV 파일의 형식을 지정하는 방법을 결정합니다.
CSV 파일에서 내보내기 페이로드 만들기
CSV 템플릿을 설정한 후에는 파일을 로 보낼 수 있습니다. /rpc/csv2schema
끝점을 지정하고 내보내기 페이로드로 변환합니다.
API 형식
POST /rpc/csv2schema
요청
요청 페이로드는 양식 데이터를 해당 형식으로 사용해야 합니다. 필수 양식 필드가 아래에 표시되어 있습니다.
curl -X POST \
https://platform.adobe.io/data/foundation/schemaregistry/rpc/csv2schema \
-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}' \
-F 'csv-file=@"/Users/userName/Documents/sample-csv-template.csv"' \
-F 'schema-class-id="https://ns.adobe.com/xdm/context/profile"' \
-F 'schema-name="Example Schema"' \
-F 'schema-description="Example schema description."'
csv-file
schema-class-id
$id
XDM의 클래스 이 스키마에 사용될 것입니다.schema-name
schema-description
응답
성공적인 응답은 CSV 파일에서 생성된 내보내기 페이로드를 반환합니다. 페이로드는 배열의 형태를 취하며 각 배열 항목은 스키마에 대한 종속 XDM 구성 요소를 나타내는 개체입니다. CSV 파일에서 생성된 내보내기 페이로드의 전체 예를 보려면 아래 섹션을 선택하십시오.
code language-json |
---|
|
스키마 페이로드 가져오기
CSV 파일에서 내보내기 페이로드를 생성한 후 해당 페이로드를 로 전송할 수 있습니다. /rpc/import
스키마를 생성할 끝점입니다.
다음을 참조하십시오. 끝점 가져오기 안내서 내보내기 페이로드에서 스키마를 생성하는 방법에 대한 자세한 내용