Catalog Service API 안내서 부록

이 문서에는 를 사용하여 작업하는 데 도움이 되는 추가 정보가 포함되어 있습니다. Catalog API.

상호 관련 객체 보기

일부 Catalog 객체는 다른 객체와 상호 관련될 수 있습니다 Catalog 개체. 접두사가 있는 모든 필드 @ 응답 페이로드에서는 관련 개체를 나타냅니다. 이러한 필드의 값은 URI 형식을 취합니다. 이 URI는 URI가 나타내는 관련 개체를 검색하기 위해 별도의 GET 요청에 사용할 수 있습니다.

문서에서 반환된 예제 데이터 세트 특정 데이터 세트 조회 다음 포함 files 다음 URI 값이 있는 필드: "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files". 의 컨텐트 files 새 GET 요청의 경로로 이 URI를 사용하여 필드를 볼 수 있습니다.

API 형식

GET {OBJECT_URI}

매개 변수	설명
`{OBJECT_URI}`	상호 관련 객체 필드에서 제공하는 URI(는 제외) `@` 기호 참조).

요청

다음 요청에서는 데이터 집합 예제 files 데이터 집합에 연결된 파일 목록을 검색하는 속성입니다.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files' \
  -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}'

응답

성공적인 응답은 관련 객체 목록을 반환합니다. 이 예에서는 데이터 집합 파일 목록이 반환됩니다.

{
    "7d501090-0280-11ea-a6bb-f18323b7005c-1": {
        "id": "7d501090-0280-11ea-a6bb-f18323b7005c-1",
        "batchId": "7d501090-0280-11ea-a6bb-f18323b7005c",
        "dataSetViewId": "5ba9452f7de80400007fc52b",
        "imsOrg": "{ORG_ID}",
        "createdUser": "{USER_ID}",
        "createdClient": "{CLIENT_ID}",
        "updatedUser": "{USER_ID}",
        "version": "1.0.0",
        "created": 1573256315368,
        "updated": 1573256315368
    },
    "148ac690-0280-11ea-8d23-8571a35dce49-1": {
        "id": "148ac690-0280-11ea-8d23-8571a35dce49-1",
        "batchId": "148ac690-0280-11ea-8d23-8571a35dce49",
        "dataSetViewId": "5ba9452f7de80400007fc52b",
        "imsOrg": "{ORG_ID}",
        "createdUser": "{USER_ID}",
        "createdClient": "{CLIENT_ID}",
        "updatedUser": "{USER_ID}",
        "version": "1.0.0",
        "created": 1573255982433,
        "updated": 1573255982433
    },
    "64dd5e19-8ea4-4ddd-acd1-f43cccd8eddb-1": {
        "id": "64dd5e19-8ea4-4ddd-acd1-f43cccd8eddb-1",
        "batchId": "64dd5e19-8ea4-4ddd-acd1-f43cccd8eddb",
        "dataSetViewId": "5ba9452f7de80400007fc52b",
        "imsOrg": "{ORG_ID}",
        "createdUser": "{USER_ID}",
        "createdClient": "{CLIENT_ID}",
        "updatedUser": "{USER_ID}",
        "version": "1.0.0",
        "created": 1569499425037,
        "updated": 1569499425037
    }
}

한 번의 호출로 여러 요청 수행

의 루트 끝점 Catalog API를 사용하면 단일 호출 내에서 여러 요청을 수행할 수 있습니다. 요청 페이로드에는 일반적으로 개별 요청일 것을 나타내는 개체 배열이 포함되어 있으며, 그런 다음 순서대로 실행됩니다.

이러한 요청이 수정 또는 추가인 경우 Catalog 변경 사항 중 하나가 실패하면 모든 변경 사항은 되돌립니다.

API 형식

POST /

요청

다음 요청은 새 데이터 세트를 만든 다음 해당 데이터 세트에 대한 관련 보기를 만듭니다. 이 예에서는 템플릿 언어를 사용하여 후속 호출에서 사용하기 위해 이전 호출에서 반환된 값에 액세스하는 방법을 보여줍니다.

예를 들어 이전 하위 요청에서 반환된 값을 참조하려는 경우 다음 형식으로 참조를 만들 수 있습니다. <<{REQUEST_ID}.{ATTRIBUTE_NAME}>> (다음과 같은 경우) {REQUEST_ID} 는 아래 설명된 대로 하위 요청에 대해 사용자가 제공한 ID입니다. 이러한 템플릿을 사용하여 이전 하위 요청의 응답 개체 본문에서 사용할 수 있는 모든 속성을 참조할 수 있습니다.

노트

실행된 하위 요청이 객체에 대한 참조만 반환하는 경우(카탈로그 API의 대부분의 POST 및 PUT 요청에 대한 기본값) 이 참조의 값이 됩니다 id 및은(는) <<{OBJECT_ID}.id>>.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "firstObjectId",
      "resource": "/dataSets",
      "method": "post",
      "body": {
        "type": "raw",
        "name": "First Dataset"
      }
    },
    {
      "id": "secondObjectId",
      "resource": "/datasetViews",
      "method": "post",
      "body": {
        "status": "enabled",
        "dataSetId": "<<firstObjectId.id>>"
      }
    }
  ]'

속성	설명
`id`	요청에 응답과 일치시킬 수 있도록 응답 개체에 첨부된 사용자 제공 ID입니다. Catalog 은 이 값을 저장하지 않고 참조용으로 응답에 반환하면 됩니다.
`resource`	의 루트에 상대적인 리소스 경로입니다 Catalog API. 프로토콜 및 도메인은 이 값의 일부가 아니어야 하며 “/” 접두사가 있어야 합니다. PATCH 또는 DELETE을 하위 요청의 `method`를 채울 때는 리소스 경로에 개체 ID를 포함합니다. 사용자가 제공한 것과 혼동하지 마십시오 `id`를 지정하는 경우 리소스 경로는 의 ID를 사용합니다 Catalog 개체 자체(예: `resource: "/dataSets/1234567890"`).
`method`	요청에서 수행되는 작업과 관련된 메서드(GET, PUT, POST, PATCH 또는 DELETE)의 이름입니다.
`body`	일반적으로 POST, PUT 또는 PATCH 요청에서 페이로드로 전달되는 JSON 문서입니다. 이 속성은 GET 또는 DELETE 요청에 필요하지 않습니다.

응답

성공적인 응답은 id 각 요청에 할당한 HTTP 상태 코드, 개별 요청에 대한 HTTP 상태 코드 및 응답 body. 세 개의 샘플 요청이 모두 새 개체를 만들기 위한 것이므로 body 각 개체의 ID만 들어 있는 배열이며, 이는 POST 응답이 가장 성공한 표준입니다 Catalog.

[
    {
        "id": "firstObjectId",
        "code": 200,
        "body": [
            "@/dataSets/5be230aef5b02914cd52dbfa"
        ]
    },
    {
        "id": "secondObjectId",
        "code": 200,
        "body": [
            "@/dataSetViews/5be230aef5b02914cd52dbfb"
        ]
    }
]

여러 요청에 대한 응답을 검사할 때 개별 하위 요청의 코드를 확인해야 하고, 상위 POST 요청에 대한 HTTP 상태 코드에만 의존하지 않아야 합니다. 전체 요청이 200을 반환하는 반면, 단일 하위 요청이 404(잘못된 리소스에 대한 GET 요청 등)를 반환할 수 있습니다.

추가 요청 헤더

Catalog 는 업데이트 중에 데이터의 무결성을 유지하는 데 도움이 되는 몇 가지 헤더 규칙을 제공합니다.

If-Match

객체 버전 관리를 사용하여 객체를 동시에 여러 사용자가 저장할 때 발생하는 데이터 손상 유형을 방지하는 것이 좋습니다.

개체를 업데이트할 때 가장 좋은 방법은 먼저 업데이트할 개체를 보기(GET)위해 API를 호출하는 것입니다. 응답 내에 포함된(및 응답에 단일 개체가 포함된 모든 호출)은 E-Tag 개체의 버전을 포함하는 헤더입니다. 개체 버전을 라는 요청 헤더로 추가 If-Match 업데이트(PUT 또는 PATCH)에서 호출하면 버전이 여전히 동일한 경우에만 업데이트가 진행되므로 데이터 충돌을 방지할 수 있습니다.

버전이 일치하지 않으면(개체를 검색한 후 다른 프로세스에서 수정한 경우) 대상 리소스에 대한 액세스가 거부되었음을 나타내는 HTTP 상태 412(전제 조건 실패)를 받게 됩니다.

Pragma

경우에 따라 정보를 저장하지 않고 개체의 유효성을 확인할 수 있습니다. 사용 Pragma 값이 인 헤더 validate-only 을(를) 사용하면 유효성 검사 목적으로만 POST 또는 PUT 요청을 전송할 수 있으므로 데이터 변경 사항이 지속되지 않습니다.

데이터 압축

압축은 Experience Platform 데이터를 변경하지 않고 작은 파일의 데이터를 큰 파일로 병합하는 서비스입니다. 성능상의 이유로 쿼리 시 보다 신속하게 데이터에 액세스할 수 있도록 작은 파일 세트를 더 큰 파일로 결합하는 것이 좋은 경우가 있습니다.

수집된 일괄 처리의 파일이 압축되면 해당 파일이 연결됩니다 Catalog 개체는 모니터링 목적으로 업데이트됩니다.

Adobe.com의 리소스

Website Personalization Content Insights Auto Text Summarization Document Generation Web Content Management Second Party Data

새로운 검색, 검색 기능 개선

Catalog Service API 안내서 부록

상호 관련 객체 보기

한 번의 호출로 여러 요청 수행

추가 요청 헤더

If-Match

Pragma

데이터 압축

Adobe.com의 리소스

이 페이지에서는

다음 보기:

학습

기술 문서

커뮤니티

고객지원

리소스

Adobe 계정

Adobe