배치 수집 API 개요

Adobe Experience Platform 데이터 수집 API를 사용하면 데이터를 배치 파일로 Platform에 수집할 수 있습니다. 수집되는 데이터는 플랫 파일(예: Parquet 파일)의 프로필 데이터 또는 의 알려진 스키마를 따르는 데이터일 수 있습니다 Experience Data Model (XDM) 레지스트리.

다음 데이터 수집 API 참조 는 이러한 API 호출에 대한 추가 정보를 제공합니다.

다음 다이어그램은 배치 수집 프로세스에 대해 설명합니다.

시작하기

이 안내서에서 사용되는 API 엔드포인트는 데이터 수집 API. 계속하기 전에 시작 안내서 관련 설명서에 대한 링크의 경우, 이 문서에서 샘플 API 호출을 읽는 안내서와 Experience Platform API를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보를 제공합니다.

Data Ingestion 전제 조건

  • 업로드할 데이터는 Parquet 또는 JSON 형식으로 되어 있어야 합니다.
  • 에서 만든 데이터 세트 Catalog services.
  • Parquet 파일의 컨텐츠는 업로드되는 데이터 집합의 스키마 하위 집합과 일치해야 합니다.
  • 인증 후 고유한 액세스 토큰을 가지십시오.

일괄 수집 모범 사례

  • 권장되는 일괄 처리 크기는 256MB와 100GB 사이입니다.
  • 각 일괄 처리에는 최대 1,500개의 파일이 포함되어야 합니다.

배치 수집 제한

배치 데이터 섭취에는 다음과 같은 몇 가지 제한 사항이 있습니다.

  • 일괄 처리당 최대 파일 수: 1500년
  • 최대 일괄 처리 크기: 100GB
  • 행당 최대 속성 또는 필드 수: 10000
  • 사용자당 최대 분당 배치 수: 138년
노트

512MB보다 큰 파일을 업로드하려면 파일을 더 작은 청크로 나누어야 합니다. 큰 파일을 업로드하는 방법은 이 문서의 대용량 파일 업로드 섹션.

유형

데이터를 수집할 때 방법을 이해하는 것이 중요합니다 Experience Data Model (XDM) 스키마가 작동합니다. XDM 필드 유형이 다른 형식으로 매핑되는 방법에 대한 자세한 내용은 스키마 레지스트리 개발자 안내서.

데이터를 수집할 때 몇 가지 유연성이 있습니다. 유형이 대상 스키마에 있는 내용과 일치하지 않으면 데이터가 표현된 대상 유형으로 변환됩니다. 처리할 수 없으면 배치 실패 시 TypeCompatibilityException.

예를 들어, JSON이나 CSV에는 가 없습니다 date 또는 date-time 유형. 따라서 이러한 값은 ISO 8061 형식 문자열 ("2018-07-10T15":05:59.000-08:00") 또는 Unix 시간(밀리초)(1531263959000)으로 포맷되며 수집 시 대상 XDM 유형으로 변환됩니다.

아래 표는 데이터를 수집할 때 지원되는 전환을 보여줍니다.

인바운드(행)과 Target(col) 비교 문자열 바이트 Short 정수 Long 이중 날짜 날짜-시간 개체
문자열 X X X X X X X X
바이트 X X X X X X
Short X X X X X X
정수 X X X X X X
Long X X X X X X X X
이중 X X X X X X
날짜 X
날짜-시간 X
개체 X X
X X
노트

부울 및 배열은 다른 형식으로 변환할 수 없습니다.

API 사용

다음 Data Ingestion API를 사용하면 데이터를 배치(단일 단위로 수집할 하나 이상의 파일로 구성된 데이터 단위)로 수집할 수 있습니다. Experience Platform 다음 세 가지 기본 단계를 수행합니다.

  1. 새 배치를 생성합니다.
  2. 데이터의 XDM 스키마와 일치하는 지정된 데이터 세트에 파일을 업로드합니다.
  3. 일괄 처리의 끝에 신호를 보냅니다.

배치 만들기

데이터를 데이터 세트에 추가하려면 먼저 일괄 처리에 연결해야 하며 나중에 지정된 데이터 세트에 업로드됩니다.

POST /batches

요청

curl -X POST "https://platform.adobe.io/data/foundation/import/batches" \
  -H "Content-Type: application/json" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}"
  -d '{
          "datasetId": "{DATASET_ID}"
      }'
속성 설명
datasetId 파일을 업로드할 데이터 세트의 ID입니다.

응답

{
    "id": "{BATCH_ID}",
    "imsOrg": "{ORG_ID}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
속성 설명
id 방금 생성(후속 요청에서 사용)된 배치의 ID입니다.
relatedObjects.id 파일을 업로드할 데이터 세트의 ID입니다.

파일 업로드

업로드할 새 일괄 처리를 성공적으로 만든 후 파일을 특정 데이터 세트에 업로드할 수 있습니다.

작은 파일 업로드 API를 사용하여 파일을 업로드할 수 있습니다. 그러나 파일이 너무 크고 게이트웨이 제한이 초과된 경우(예: 확장 시간 초과, 본문 크기 요청 초과 및 기타 제한) 대용량 파일 업로드 API로 전환할 수 있습니다. 이 API는 파일을 청크로 업로드하고, 대용량 파일 업로드 완료 API 호출을 사용하여 데이터를 함께 결합합니다.

노트

일괄 처리는 프로필 저장소에서 데이터를 점진적으로 업데이트하는 데 사용할 수 있습니다. 자세한 내용은 배치 갱신 에서 배치 수집 개발자 안내서.

정보

아래 예제는 아파치 쪽모이 세공 파일 형식입니다. JSON 파일 형식을 사용하는 예는 배치 수집 개발자 안내서.

작은 파일 업로드

일괄 처리가 만들어지면 기존 데이터 세트에 데이터를 업로드할 수 있습니다. 업로드 중인 파일이 참조된 XDM 스키마와 일치해야 합니다.

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
속성 설명
{BATCH_ID} 일괄 처리의 ID입니다.
{DATASET_ID} 파일을 업로드할 데이터 세트의 ID입니다.
{FILE_NAME} 데이터 집합에 표시되는 파일의 이름입니다.

요청

curl -X PUT "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
속성 설명
{FILE_PATH_AND_NAME} 데이터 집합에 업로드할 파일의 경로 및 파일 이름입니다.

응답

#Status 200 OK, with empty response body

큰 파일 업로드 - 파일 만들기

큰 파일을 업로드하려면 파일을 작은 청크로 분할하고 한 번에 하나씩 업로드해야 합니다.

POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}?action=initialize
속성 설명
{BATCH_ID} 일괄 처리의 ID입니다.
{DATASET_ID} 파일을 수집하는 데이터 세트의 ID입니다.
{FILE_NAME} 데이터 집합에 표시되는 파일의 이름입니다.

요청

curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/part1=a/part2=b/{FILE_NAME}.parquet?action=initialize" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}"

응답

#Status 201 CREATED, with empty response body

대용량 파일 업로드 - 후속 부분 업로드

파일을 만든 후 파일의 각 섹션에 대해 하나씩 반복되는 PATCH 요청을 수행하여 후속 청크를 모두 업로드할 수 있습니다.

PATCH /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
속성 설명
{BATCH_ID} 일괄 처리의 ID입니다.
{DATASET_ID} 파일을 업로드할 데이터 세트의 ID입니다.
{FILE_NAME} 데이터 집합에 표시되는 파일의 이름입니다.

요청

curl -X PATCH "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/part1=a/part2=b/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "Content-Range: bytes {CONTENT_RANGE}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
속성 설명
{FILE_PATH_AND_NAME} 데이터 집합에 업로드할 파일의 경로 및 파일 이름입니다.

응답

#Status 200 OK, with empty response

신호 배치 완료

모든 파일이 배치에 업로드되면 배치에 대해 완료를 알리는 신호를 보낼 수 있습니다. 이렇게 하면 Catalog DataSetFile 항목은 완료된 파일에 대해 생성되고 위에서 생성된 배치와 연결됩니다. 다음 Catalog 그런 다음 일괄 처리가 성공으로 표시되어 사용 가능한 데이터를 수집하기 위해 다운스트림 흐름을 트리거합니다.

요청

POST /batches/{BATCH_ID}?action=COMPLETE
속성 설명
{BATCH_ID} 데이터 세트에 업로드할 일괄 처리의 ID입니다.
curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE" \
-H "x-gw-ims-org-id: {ORG_ID}" \
-H "x-sandbox-name: {SANDBOX_NAME}" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "x-api-key: {API_KEY}"

응답

#Status 200 OK, with empty response

배치 상태 확인

파일이 배치에 업로드될 때까지 기다리는 동안 일괄 처리의 상태를 확인하여 진행 상태를 확인할 수 있습니다.

API 형식

GET /batch/{BATCH_ID}
속성 설명
{BATCH_ID} 확인 중인 배치의 ID입니다.

요청

curl GET "https://platform.adobe.io/data/foundation/catalog/batch/{BATCH_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "x-api-key: {API_KEY}"

응답

{
    "{BATCH_ID}": {
        "imsOrg": "{ORG_ID}",
        "created": 1494349962314,
        "createdClient": "MCDPCatalogService",
        "createdUser": "{USER_ID}",
        "updatedUser": "{USER_ID}",
        "updated": 1494349963467,
        "externalId": "{EXTERNAL_ID}",
        "status": "success",
        "errors": [
            {
                "code": "err-1494349963436"
            }
        ],
        "version": "1.0.3",
        "availableDates": {
            "startDate": 1337,
            "endDate": 4000
        },
        "relatedObjects": [
            {
                "type": "batch",
                "id": "foo_batch"
            },
            {
                "type": "connection",
                "id": "foo_connection"
            },
            {
                "type": "connector",
                "id": "foo_connector"
            },
            {
                "type": "dataSet",
                "id": "foo_dataSet"
            },
            {
                "type": "dataSetView",
                "id": "foo_dataSetView"
            },
            {
                "type": "dataSetFile",
                "id": "foo_dataSetFile"
            },
            {
                "type": "expressionBlock",
                "id": "foo_expressionBlock"
            },
            {
                "type": "service",
                "id": "foo_service"
            },
            {
                "type": "serviceDefinition",
                "id": "foo_serviceDefinition"
            }
        ],
        "metrics": {
            "foo": 1337
        },
        "tags": {
            "foo_bar": [
                "stuff"
            ],
            "bar_foo": [
                "woo",
                "baz"
            ],
            "foo/bar/foo-bar": [
                "weehaw",
                "wee:haw"
            ]
        },
        "inputFormat": {
            "format": "parquet",
            "delimiter": ".",
            "quote": "`",
            "escape": "\\",
            "nullMarker": "",
            "header": "true",
            "charset": "UTF-8"
        }
    }
}
속성 설명
{USER_ID} 배치를 생성하거나 갱신한 사용자의 ID입니다.

다음 "status" 필드는 요청한 배치의 현재 상태를 표시하는 필드입니다. 배치에는 다음 상태 중 하나가 있을 수 있습니다.

배치 수집 상태

상태 설명
포기 일괄 처리가 예상 기간에 완료되지 않았습니다.
중단됨 중단 작업이 있습니다. 명시적으로 지정된 배치에 대해 배치 수집 API를 통해 호출되었습니다. 일괄 처리가 "로드됨" 상태에 있으면 중단될 수 없습니다.
활성 일괄 처리가 성공적으로 홍보되었으며 다운스트림 소비에 사용할 수 있습니다. 이 상태는 "성공"과 교환하여 사용할 수 있습니다.
삭제됨 배치에 대한 데이터가 완전히 제거되었습니다.
실패 잘못된 구성 및/또는 잘못된 데이터에서 발생하는 터미널 상태입니다. 실패한 배치에 대한 데이터는 not 표시합니다. 이 상태는 "실패"와 서로 교환하여 사용할 수 있습니다.
비활성 일괄 처리가 성공적으로 승격되었지만 복귀되었거나 만료되었습니다. 일괄 처리는 더 이상 다운스트림 소비에 사용할 수 없습니다.
로드됨 배치에 대한 데이터가 완료되고 배치가 승격 준비가 되었습니다.
로드 중 이 일괄 처리에 대한 데이터가 업로드되고 일괄 처리가 현재 있습니다 not 승격할 준비가 되었습니다.
다시 시도 중 이 배치에 대한 데이터를 처리 중입니다. 그러나 시스템 오류 또는 일시적인 오류로 인해 배치에 실패하여 이 배치를 다시 시도합니다.
스테이징됨 배치에 대한 프로모션 프로세스의 스테이징 단계가 완료되고 수집 작업이 실행되었습니다.
스테이징 일괄 처리에 대한 데이터를 처리 중입니다.
정지된 상태 일괄 처리에 대한 데이터를 처리 중입니다. 그러나 다시 시도 후 배치 프로모션이 중단되었습니다.

이 페이지에서는