설명서 Experience Platform Catalog and Datasets 안내서

필터 Catalog 쿼리 매개 변수를 사용하는 데이터

Last update: Wed Dec 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
Catalog

작성 대상:

Developer

다음 Catalog Service API를 사용하면 요청 쿼리 매개 변수를 사용하여 응답 데이터를 필터링할 수 있습니다. 을 위한 모범 사례의 일부 Catalog 는 API에 대한 로드를 줄이고 전체 성능을 개선하는 데 도움이 되므로 모든 API 호출에서 필터를 사용합니다.

이 문서에서는 가장 일반적인 필터링 방법에 대해 간략히 설명합니다 Catalog API의 개체입니다. 문서를 읽는 동안 이 문서를 참조하는 것이 좋습니다. 카탈로그 개발자 안내서 와 상호 작용하는 방법에 대해 자세히 알아보려면 Catalog API. 에 대한 일반적인 추가 정보 Catalog Service, 다음을 참조하십시오. Catalog 개요.

반환되는 오브젝트 제한

다음 limit 쿼리 매개 변수는 응답에서 반환되는 개체 수를 제한합니다. Catalog 응답은 구성된 제한에 따라 자동으로 측정됩니다.

다음과 같은 경우 limit 매개 변수를 지정하지 않았습니다. 응답 페이로드당 최대 개체 수는 20개입니다.
데이터 세트 쿼리의 경우 observableSchema 을(를) 사용하여 요청됨 properties 쿼리 매개 변수에서 반환되는 최대 데이터 세트 수는 20개입니다.
다른 모든 카탈로그 쿼리에 대한 전역 제한은 100개입니다.
잘못됨 limit 매개 변수(포함) limit=0) 적절한 범위의 윤곽을 나타내는 400개 수준의 오류 응답이 발생합니다.
쿼리 매개 변수로 전달된 제한 또는 오프셋은 헤더로 전달된 제한보다 우선합니다.

API 형식

GET /{OBJECT_TYPE}?limit={LIMIT}

매개변수

설명

{OBJECT_TYPE}

유형 Catalog 검색할 객체. 유효한 오브젝트는 다음과 같습니다.

batches
dataSets
dataSetFiles

{LIMIT}

반환할 개체 수를 나타내는 정수로, 1개에서 100개까지 지정할 수 있습니다.

요청

다음 요청은 응답을 세 개의 객체로 제한하면서 데이터 세트 목록을 검색합니다.

curl -X GET \
  https://platform.adobe.io/data/foundation/catalog/dataSets?limit=3 \
  -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}'

응답

성공적인 응답은 데이터 세트 목록을 로 표시된 숫자로 제한하여 반환합니다. limit 쿼리 매개 변수.

{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bb276b03a14440000971552"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    }
}

표시된 속성 제한

를 사용하여 반환되는 개체 수를 필터링할 경우에도 limit 매개 변수를 사용하면 반환되는 개체 자체에 실제로 필요한 것보다 더 많은 정보가 포함될 수 있습니다. 시스템의 로드를 추가로 줄이려면 필요한 속성만 포함하도록 응답을 필터링하는 것이 좋습니다.

다음 properties 매개 변수는 응답 개체를 필터링하여 지정된 속성 집합만 반환합니다. 매개 변수는 하나 이상의 속성을 반환하도록 설정할 수 있습니다.

다음 properties 매개 변수에는 모든 레벨 개체 속성이 적용될 수 있습니다. sampleKey 다음을 사용하여 추출 가능 ?properties=subItem.sampleKey.

{
  "5ba9452f7de80400007fc52a": {
      "name": "Sample Dataset",
      "description": "Sample dataset containing important data",
      "subitem": {
          "sampleKey": "sampleValue"
      }
  }
}

API 형식

GET /{OBJECT_TYPE}?properties={PROPERTY}
GET /{OBJECT_TYPE}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}

매개변수

설명

{OBJECT_TYPE}

유형 Catalog 검색할 객체. 유효한 오브젝트는 다음과 같습니다.

batches
dataSets
dataSetFiles

{PROPERTY}

응답 본문에 포함할 속성의 이름입니다.

{OBJECT_ID}

특정 항목에 대한 고유 식별자 Catalog 개체를 검색 중입니다.

요청

다음 요청은 데이터 세트 목록을 검색합니다. 아래에 제공된 속성 이름의 쉼표로 구분된 목록 properties 매개 변수는 응답에서 반환할 속성을 나타냅니다. A limit 반환되는 데이터 세트 수를 제한하는 매개 변수도 포함됩니다. 요청에 이 포함되지 않은 경우 limit 매개 변수, 응답에는 최대 20개의 개체가 포함됩니다.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?limit=4&properties=name,schemaRef' \
  -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}'

응답

성공적인 응답은 다음 목록을 반환합니다. Catalog 요청된 속성만 표시된 개체

{
    "Dataset1": {
        "name": "Dataset 1",
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/bc82c518380478b59a95c63e0f843121",
            "contentType": "application/vnd.adobe.xed+json;version=1"
        }
    },
    "Dataset2": {},
    "Dataset3": {
        "name": {},
    },
    "Dataset4": {
        "name": "Dataset 4",
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/142afb78d8b368a5ba97a6cc8fc7e033",
            "contentType": "application/vnd.adobe.xed+json;version=1"
        }
    }
}

위의 응답을 기반으로 다음을 추론할 수 있습니다.

개체에 요청된 속성이 없는 경우 개체에 포함된 요청된 속성만 표시됩니다. (Dataset1)
개체에 요청된 속성이 포함되지 않으면 빈 개체로 표시됩니다. (Dataset2)
데이터 세트는 속성이 포함되어 있지만 값이 없는 경우 요청된 속성을 빈 개체로 반환할 수 있습니다. (Dataset3)
그렇지 않으면 데이터 세트에 요청된 모든 속성의 전체 값이 표시됩니다. (Dataset4)

NOTE

다음에서 schemaRef 각 데이터 세트의 속성에서 버전 번호는 스키마의 최신 부 버전을 나타냅니다. 의 섹션을 참조하십시오. 스키마 버전 관리 자세한 내용은 XDM API 안내서 를 참조하십시오.

응답 목록의 오프셋 시작 인덱스

다음 start 쿼리 매개 변수는 0 기반 번호 매기기를 사용하여 지정된 번호만큼 응답 목록을 앞으로 오프셋합니다. 예를 들어, start=2 은 나열된 세 번째 객체에서 시작할 응답을 오프셋합니다.

다음과 같은 경우 start 매개 변수가 와(과) 연결되어 있지 않습니다. limit 매개 변수에서 반환되는 최대 개체 수는 20개입니다.

API 형식

GET /{OBJECT_TYPE}?start={OFFSET}

매개변수

설명

{OBJECT_TYPE}

검색할 카탈로그 개체의 유형입니다. 유효한 오브젝트는 다음과 같습니다.

batches
dataSets
dataSetFiles

{OFFSET}

응답을 오프셋할 개체 수를 나타내는 정수입니다.

요청

다음 요청은 데이터 세트 목록을 검색하여 다섯 번째 개체로 오프셋(start=4)를 실행하고 응답을 두 개의 반환된 데이터 세트(limit=2).

curl -X GET \
  https://platform.adobe.io/data/foundation/catalog/dataSets?start=4&limit=2 \
  -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}'

응답

응답에는 두 개의 최상위 항목( )이 포함된 JSON 오브젝트가 포함됩니다.limit=2), 각 데이터 세트 및 세부 정보에 대해 하나씩 제공됩니다(예제에 대한 세부 사항이 요약되어 있음). 응답이 4만큼 이동됩니다(start=4)를 반환합니다. 즉, 표시된 데이터 세트는 연대순으로 5번과 6번입니다.

{
    "Dataset5": {},
    "Dataset6": {}
}

태그로 필터링

일부 카탈로그 개체는 tags 특성. 태그는 오브젝트에 정보를 첨부한 다음 나중에 해당 오브젝트를 검색하는 데 사용할 수 있습니다. 사용할 태그와 적용 방법의 선택은 조직 프로세스에 따라 다릅니다.

태그를 사용할 때 고려해야 할 몇 가지 제한 사항이 있습니다.

현재 태그를 지원하는 유일한 카탈로그 개체는 데이터 세트, 배치 및 연결입니다.
태그 이름은 조직에 고유합니다.
Adobe 프로세스는 특정 비헤이비어에 대해 태그를 활용할 수 있습니다. 이러한 태그의 이름 앞에는 "adobe"가 표준으로 붙습니다. 따라서 태그 이름을 선언할 때는 이 규칙을 사용하지 않아야 합니다.
다음 태그 이름은 전체에서 사용하도록 예약되어 있습니다. Experience Platform를 사용하므로 를 조직의 태그 이름으로 선언할 수 없습니다.
- unifiedProfile: 이 태그 이름은 데이터 세트를에서 수집하도록 예약되어 있습니다 Real-Time Customer Profile.
- unifiedIdentity: 이 태그 이름은 데이터 세트를에서 수집하도록 예약되어 있습니다 Identity Service.

다음은 를 포함하는 데이터 세트의 예입니다. tags 속성. 해당 속성 내의 태그는 키-값 쌍의 형태를 취하며 각 태그 값은 단일 문자열을 포함하는 배열로 표시됩니다.

{
    "5be1f2ecc73c1714ceba66e2": {
        "imsOrg": "{ORG_ID}",
        "tags": {
            "sampleTag": [
                "123456"
            ],
            "secondTag": [
                "sample_tag_value"
            ]
        },
        "name": "Sample Dataset",
        "description": "Same dataset containing sample data.",
        "createdUser": "{CREATED_USER}",
        "createdClient": "{CREATED_CLIENT}",
        "updatedUser": "{UPDATED_USER}",
        "version": "1.0.0",
        "created": 1541534444286,
        "updated": 1541534444286
    }
}

API 형식

값 tags 매개 변수는 형식을 사용하여 키-값 쌍 형태로 가져옵니다. {TAG_NAME}:{TAG_VALUE}. 여러 키-값 쌍을 쉼표로 구분된 목록 형태로 제공할 수 있습니다. 여러 개의 태그가 제공된 경우 AND 관계를 가정합니다.

매개 변수는 와일드카드 문자(*)을 참조하십시오. 예: 검색 문자열 test* 태그 값이 "test"로 시작하는 모든 개체를 반환합니다. 와일드카드로만 구성된 검색 문자열은 값에 관계없이 특정 태그가 포함되어 있는지 여부에 따라 객체를 필터링하는 데 사용할 수 있습니다.

GET /{OBJECT_TYPE}?tags={TAG_NAME}:{TAG_VALUE}
GET /{OBJECT_TYPE}?tags={TAG_NAME_1}:{TAG_VALUE_1},{TAG_NAME_2}:{TAG_VALUE_2}
GET /{OBJECT_TYPE}?tags={TAG_NAME}:{TAG_VALUE}*
GET /{OBJECT_TYPE}?tags={TAG_NAME}:*

매개변수

설명

{OBJECT_TYPE}

유형 Catalog 검색할 객체. 유효한 오브젝트는 다음과 같습니다.

batches
dataSets

{TAG_NAME}

필터링 기준으로 사용할 태그의 이름입니다.

{TAG_VALUE}

필터링 기준으로 사용할 태그의 값. 와일드카드 문자 지원(*).

요청

다음 요청은 데이터 세트 목록을 검색하여 특정 값을 갖는 태그 하나와 존재하는 두 번째 태그로 필터링합니다.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?tags=sampleTag:123456,secondTag:* \
  -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}'

응답

성공적인 응답은 다음을 포함하는 데이터 세트 목록을 반환합니다. sampleTag 값이 "123456"이고, secondTag 모든 값 포함. 제한도 지정하지 않는 한 응답에는 최대 20개의 개체가 포함됩니다.

{
    "5b67f4dd9f6e710000ea9da4": {
            "version": "1.0.2",
            "imsOrg": "{ORG_ID}",
            "name": "Example Dataset 1",
            "created": 1533539550237,
            "updated": 1533539552416,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
            "tags": {
                "sampleTag": [
                    "123456"
                ],
                "secondTag": [
                    "Example tag value"
                ]
            },
    },
    "5b1e3c867e6d2600003d5b49": {
            "version": "1.0.0",
            "imsOrg": "{ORG_ID}",
            "name": "Example Dataset 2",
            "created": 1533539550237,
            "updated": 1533539552416,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
            "tags": {
                "sampleTag": [
                    "123456"
                ],
                "secondTag": [
                    "A different tag value"
                ],
                "anotherTag": [
                    "2.0"
                ]
            },
    }
}

날짜 범위로 필터링

의 일부 엔드포인트 Catalog API에는 광범위한 쿼리를 허용하는 쿼리 매개 변수가 있습니다(대부분의 경우 날짜의 경우).

API 형식

GET /batches?createdAfter={TIMESTAMP_1}&createdBefore={TIMESTAMP_2}

매개변수

설명

{TIMESTAMP }

Unix Epoch 시간의 날짜/시간 정수입니다.

요청

다음 요청은 2019년 4월 한 달 동안 생성된 배치 목록을 검색합니다.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/batches?createdAfter=1554076800000&createdBefore=1556668799000' \
  -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}'

응답

성공적인 응답에는 다음 목록이 포함됩니다. Catalog 지정된 날짜 범위에 속하는 개체입니다. 제한도 지정하지 않는 한 응답에는 최대 20개의 개체가 포함됩니다.

{
    "5b67f4dd9f6e710000ea9da4": {
            "version": "1.0.2",
            "imsOrg": "{ORG_ID}",
            "name": "Example Dataset 1",
            "created": 1554930967705,
            "updated": 1554931119718,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    },
    "5b1e3c867e6d2600003d5b49": {
            "version": "1.0.0",
            "imsOrg": "{ORG_ID}",
            "name": "Example Dataset 2",
            "created": 1554974386247,
            "updated": 1554974386268,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    }
}

속성별 정렬

다음 orderBy 쿼리 매개 변수를 사용하면 지정된 속성 값을 기준으로 응답 데이터를 정렬(순서 지정)할 수 있습니다. 이 매개 변수에는 "direction"(asc 오름차순 또는 desc 내림차순), 콜론(:) 속성을 선택하여 결과를 정렬합니다. 방향을 지정하지 않으면 기본 방향은 오름차순입니다.

여러 정렬 속성을 쉼표로 구분된 목록으로 제공할 수 있습니다. 첫 번째 정렬 속성이 해당 속성에 대해 동일한 값을 포함하는 여러 객체를 생성하는 경우 두 번째 정렬 속성을 사용하여 일치하는 객체를 추가로 정렬합니다.

예를 들어 다음 쿼리를 고려해 보십시오. orderBy=name,desc:created. 결과는 첫 번째 정렬 속성에 따라 오름차순으로 정렬됩니다. name. 여러 레코드가 동일한 경우 name 일치하는 레코드는 두 번째 정렬 속성별로 정렬됩니다. created. 반환된 레코드가 없으면 동일한 내용을 공유합니다. name, created 속성은 정렬에 영향을 주지 않습니다.

API 형식

GET /{OBJECT_TYPE}?orderBy=asc:{PROPERTY_NAME}
GET /{OBJECT_TYPE}?orderBy=desc:{PROPERTY_NAME}
GET /{OBJECT_TYPE}?orderBy={PROPERTY_NAME_1},desc:{PROPERTY_NAME_2}

매개변수

설명

{OBJECT_TYPE}

검색할 카탈로그 개체의 유형입니다. 유효한 오브젝트는 다음과 같습니다.

batches
dataSets
dataSetFiles

{PROPERTY_NAME}

결과를 정렬할 속성의 이름입니다.

요청

다음 요청은 항목별로 정렬된 데이터 세트 목록을 검색합니다. name 속성. 동일한 데이터 세트를 공유하는 경우 name, 이러한 데이터 세트는 순서대로 정렬됩니다. updated 속성을 내림차순으로 표시합니다.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?orderBy=name,desc:updated' \
  -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}'

응답

성공적인 응답에는 다음 목록이 포함됩니다. Catalog 다음에 따라 정렬되는 개체 orderBy 매개 변수. 제한도 지정하지 않는 한 응답에는 최대 20개의 개체가 포함됩니다.

{
    "5b67f4dd9f6e710000ea9da4": {
            "version": "1.0.2",
            "imsOrg": "{ORG_ID}",
            "name": "0405",
            "created": 1554930967705,
            "updated": 1554931119718,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    },
    "5b1e3c867e6d2600003d5b49": {
            "version": "1.0.3",
            "imsOrg": "{ORG_ID}",
            "name": "AAM Dataset",
            "created": 1554974386247,
            "updated": 1554974386268,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    },
    "5cd3a129ec106214b722a939": {
            "version": "1.0.2",
            "imsOrg": "{ORG_ID}",
            "name": "AAM Dataset",
            "created": 1554028394852,
            "updated": 1554130582960,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    }
}

속성으로 필터링

Catalog 는 다음 섹션에 자세히 설명된 두 가지 속성별 필터링 방법을 제공합니다.

단순 필터 사용: 특정 속성이 특정 값과 일치하는지 여부를 기준으로 필터링합니다.
속성 매개 변수 사용: 조건부 표현식을 사용하여 속성이 있는지 여부 또는 속성 값이 지정된 다른 값 또는 정규 표현식과 일치하거나, 비슷하거나, 비교되는 경우 필터링합니다.

단순 필터 사용 using-simple-filters

단순 필터를 사용하면 특정 속성 값을 기준으로 응답을 필터링할 수 있습니다. 간단한 필터는 다음 형식을 사용합니다. {PROPERTY_NAME}={VALUE}.

예: 쿼리 name=exampleName 다음 위치의 개체만 반환합니다. name 속성에 "exampleName" 값이 포함되어 있습니다. 반대로 쿼리는 name=!exampleName 다음 위치의 개체만 반환합니다. name 속성은 입니다. 아님 "exampleName".

또한 간단한 필터는 단일 속성에 대해 여러 값을 쿼리하는 기능을 지원합니다. 여러 값을 제공하면 응답이 속성이 일치하는 개체를 반환합니다 임의 제공된 목록에 있는 값. 접두사를 사용하여 다중 값 쿼리를 반전할 수 있습니다. ! 목록에 문자가 추가되고 속성 값이 인 개체만 반환됩니다. 아님 제공된 목록(예: name=!exampleName,anotherName).

API 형식

GET /{OBJECT_TYPE}?{PROPERTY_NAME}={VALUE}
GET /{OBJECT_TYPE}?{PROPERTY_NAME}=!{VALUE}
GET /{OBJECT_TYPE}?{PROPERTY_NAME}={VALUE_1},{VALUE_2},{VALUE_3}
GET /{OBJECT_TYPE}?{PROPERTY_NAME}=!{VALUE_1},{VALUE_2},{VALUE_3}

매개변수

설명

{OBJECT_TYPE}

유형 Catalog 검색할 객체. 유효한 오브젝트는 다음과 같습니다.

batches
dataSets
dataSetFiles

{PROPERTY_NAME}

필터링 기준으로 사용할 값을 가진 속성의 이름입니다.

{VALUE}

쿼리에 따라 포함(또는 제외)할 결과를 결정하는 속성 값입니다.

요청

다음 요청은 데이터 세트 목록을 검색하고 다음 데이터 세트만 포함하도록 필터링됩니다. name 속성의 값은 "exampleName" 또는 "anotherName"입니다.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?name=exampleName,anotherName' \
  -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 는 "exampleName" 또는 "anotherName"입니다. 제한도 지정하지 않는 한 응답에는 최대 20개의 개체가 포함됩니다.

{
    "5b67f4dd9f6e710000ea9da4": {
            "version": "1.0.2",
            "imsOrg": "{ORG_ID}",
            "name": "exampleName",
            "created": 1554930967705,
            "updated": 1554931119718,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    },
    "5b1e3c867e6d2600003d5b49": {
            "version": "1.0.3",
            "imsOrg": "{ORG_ID}",
            "name": "anotherName",
            "created": 1554974386247,
            "updated": 1554974386268,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    }
}

사용 `property` 매개 변수 using-the-property-parameter

다음 property 쿼리 매개 변수는 간단한 필터보다 속성 기반 필터링에 더 많은 유연성을 제공합니다. 속성에 특정 값이 있는지 여부에 따른 필터링 외에, property 매개 변수는 다른 비교 연산자(예: "보다 큼"(>) 및 "보다 작음"(<)와 속성 값을 기준으로 필터링할 정규 표현식도 포함되어 있습니다. 또한 속성의 값에 관계없이 속성의 존재 여부에 따라 필터링할 수도 있습니다.

다음 property 매개 변수에는 모든 레벨 개체 속성이 적용될 수 있습니다. sampleKey 을 사용하여 필터링에 사용할 수 있습니다. ?properties=subItem.sampleKey.

{
  "5ba9452f7de80400007fc52a": {
      "name": "Sample Dataset",
      "description": "Sample dataset containing important data",
      "subitem": {
          "sampleKey": "sampleValue"
      }
  }
}

API 형식

GET /{OBJECT_TYPE}?property={CONDITION}

매개변수

설명

{OBJECT_TYPE}

유형 Catalog 검색할 객체. 유효한 오브젝트는 다음과 같습니다.

batches
dataSets
dataSetFiles

{CONDITION}

쿼리할 속성 및 해당 값의 평가 방법을 나타내는 조건부 식입니다. 예제는 아래에 나와 있습니다.

값 property 매개 변수는 여러 종류의 조건부 표현식을 지원합니다. 다음 표에서는 지원되는 표현식에 대한 기본 구문을 간략하게 설명합니다.

기호

설명

예

(없음)

연산자가 없는 속성 이름을 입력하면 해당 값에 관계없이 속성이 있는 객체만 반환됩니다.

property=name

접두사 사용!" 을 a 값으로 property 매개 변수는 속성이 포함하는 개체만 반환합니다. 아님 존재합니다.

property=!name

속성 값(문자열)이 물결표 다음에 제공된 정규 표현식과 일치하는 개체만 반환합니다(~) 기호를 사용할 수 없습니다.

property=name~^example

속성 값이 double-equals 기호 뒤에 제공된 문자열과 정확히 일치하는 개체만 반환합니다(==).

property=name==exampleName

속성 값이 있는 개체만 반환합니다. 아님 같지 않음 기호 뒤에 제공된 일치 문자열(!=).

property=name!=exampleName

속성 값이 지정된 양보다 작지만 같지 않은 개체만 반환합니다.

property=version<1.0.0

속성 값이 지정된 양보다 작거나 같은 개체만 반환합니다.

property=version<=1.0.0

속성 값이 지정된 양보다 큰(하지만 같지 않은) 개체만 반환합니다.

property=version>1.0.0

속성 값이 지정된 양보다 크거나 같은 개체만 반환합니다.

property=version>=1.0.0

NOTE

다음 name 속성은 와일드카드 사용을 지원합니다. *를 전체 검색 문자열로 또는 그 일부로 사용합니다. 와일드카드는 빈 문자와 일치하므로 검색 문자열을 검색합니다. te*st 은 값 "test"와 일치합니다. 별표는 두 배로 늘려 이스케이프 처리합니다(**). 검색 문자열의 이중 별표는 리터럴 문자열로 단일 별표를 나타냅니다.

요청

다음 요청은 버전 번호가 1.0.3보다 큰 모든 데이터 세트를 반환합니다.

curl -X GET \
  https://platform.adobe.io/data/foundation/catalog/dataSets?property=version>1.0.3 \
  -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}'

응답

성공적인 응답에는 버전 번호가 1.0.3보다 큰 데이터 세트 목록이 포함되어 있습니다. 제한도 지정하지 않는 한 응답에는 최대 20개의 개체가 포함됩니다.

{
    "5b67f4dd9f6e710000ea9da4": {
            "version": "1.1.2",
            "imsOrg": "{ORG_ID}",
            "name": "sampleDataset",
            "created": 1554930967705,
            "updated": 1554931119718,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    },
    "5b1e3c867e6d2600003d5b49": {
            "version": "1.0.6",
            "imsOrg": "{ORG_ID}",
            "name": "exampleDataset",
            "created": 1554974386247,
            "updated": 1554974386268,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    },
    "5cd3a129ec106214b722a939": {
            "version": "1.0.4",
            "imsOrg": "{ORG_ID}",
            "name": "anotherDataset",
            "created": 1554028394852,
            "updated": 1554130582960,
            "createdClient": "{API_KEY}",
            "createdUser": "{USER_ID}",
            "updatedUser": "{USER_ID}",
    }
}

여러 필터 결합

앰퍼샌드 사용(&)에서는 여러 필터를 하나의 요청에 결합할 수 있습니다. 요청에 추가 조건이 추가되면 AND 관계가 간주됩니다.

API 형식

GET /{OBJECT_TYPE}?{FILTER_1}={VALUE}&{FILTER_2}={VALUE}&{FILTER_3}={VALUE}

recommendation-more-help

c5c02be6-79a3-4a2f-b766-136bffe8b676

필터 Catalog 쿼리 매개 변수를 사용하는 데이터

반환되는 오브젝트 제한

표시된 속성 제한

응답 목록의 오프셋 시작 인덱스

태그로 필터링

날짜 범위로 필터링

속성별 정렬

속성으로 필터링

단순 필터 사용 using-simple-filters

사용 property 매개 변수 using-the-property-parameter

여러 필터 결합

사용 `property` 매개 변수 using-the-property-parameter