세그먼트 정의 끝점

Adobe Experience Platform을 사용하면 프로필 그룹에서 특정 특성 또는 비헤이비어 그룹을 정의하는 세그먼트를 만들 수 있습니다. 세그먼트 정의는 Profile Query Language (PQL)에 작성된 쿼리를 캡슐화하는 객체입니다. 이 객체를 PQL 조건자라고도 합니다. PQL은 Real-time Customer Profile에 제공하는 레코드 또는 시계열 데이터와 관련된 조건에 따라 세그먼트의 규칙을 정의합니다. PQL 쿼리 작성에 대한 자세한 내용은 PQL 안내서를 참조하십시오.

이 안내서에서는 세그먼트 정의를 더 잘 이해할 수 있도록 정보를 제공하며 API를 사용하여 기본 작업을 수행하기 위한 샘플 API 호출을 포함합니다.

시작하기

이 안내서에 사용된 끝점은 Adobe Experience Platform Segmentation Service API의 일부입니다. 계속하기 전에 필수 헤더 및 예제 API 호출 방법을 포함하여 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보가 필요하면 시작 안내서를 검토하십시오.

세그먼트 정의 목록 검색

/segment/definitions 종단점에 GET 요청을 하여 IMS 조직에 대한 모든 세그먼트 정의 목록을 검색할 수 있습니다.

API 형식

/segment/definitions 끝점은 결과를 필터링하는 데 도움이 되는 여러 쿼리 매개 변수를 지원합니다. 이러한 매개 변수는 선택 사항이지만, 비싼 오버헤드를 줄이려면 매개 변수를 사용하는 것이 좋습니다. 매개 변수 없이 이 끝점을 호출하면 조직에 사용할 수 있는 모든 세그먼트 정의가 검색됩니다. 여러 매개 변수를 앰퍼샌드(&)로 구분하여 포함할 수 있습니다.

GET /segment/definitions
GET /segment/definitions?{QUERY_PARAMETERS}

쿼리 매개 변수

매개 변수 설명 예
start 반환된 세그먼트 정의에 대한 시작 오프셋을 지정합니다. start=4
limit 페이지당 반환되는 세그먼트 정의 수를 지정합니다. limit=20
page 세그먼트 정의 결과가 시작되는 페이지를 지정합니다. page=5
sort 결과를 정렬할 필드를 지정합니다. 다음 형식으로 작성됩니다.[attributeName]:[desc|asc]. sort=updateTime:desc
evaluationInfo.continuous.enabled 세그먼트 정의가 스트리밍될 수 있는지 여부를 지정합니다. evaluationInfo.continuous.enabled=true

요청

다음 요청은 IMS 조직 내에 게시된 마지막 두 세그먼트 정의를 검색합니다.

curl -X GET https://platform.adobe.io/data/core/ups/segment/definitions?limit=2 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 지정된 IMS 조직에 대한 세그먼트 정의 목록이 포함된 HTTP 상태 200을 JSON으로 반환합니다.

{
    "segments": [
        {
            "id": "3da8bad9-29fb-40e0-b39e-f80322e964de",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{IMS_ORG}",
            "sandbox": {
                "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "name": "segment",
            "description": "",
            "expression": {
                "type": "PQL",
                "format": "pql/json",
                "value": "{PQL_EXPRESSION}"
            },
            "mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
            "evaluationInfo": {
                "batch": {
                    "enabled": true
                },
                "continuous": {
                    "enabled": false
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "dataGovernancePolicy": {
                "excludeOptOut": true
            },
            "creationTime": 1573253640000,
            "baselineTime": 1574327114,
            "updateEpoch": 1575588309,
            "updateTime": 1575588309000
        },
        {
            "id": "ca763983-5572-4ea4-809c-b7dff7e0d79b",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{IMS_ORG}",
            "name": "test segment",
            "description": "",
            "expression": {
                "type": "PQL",
                "format": "pql/json",
                "value": "{PQL_EXPRESSION}"
            },
            "mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
            "evaluationInfo": {
                "batch": {
                    "enabled": true
                },
                "continuous": {
                    "enabled": false
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "dataGovernancePolicy": {
                "excludeOptOut": true
            },
            "creationTime": 1561073779000,
            "baselineTime": 1574327114,
            "updateEpoch": 1574327114,
            "updateTime": 1574327114000
        }
    ],
    "page": {
        "totalCount": 2,
        "totalPages": 1,
        "sortField": "creationTime",
        "sort": "desc",
        "pageSize": 2,
        "limit": 100
    },
    "link": {}
}

새 세그먼트 정의 만들기

/segment/definitions 끝점에 POST 요청을 하여 새 세그먼트 정의를 만들 수 있습니다.

API 형식

POST /segment/definitions

요청

curl -X POST https://platform.adobe.io/data/core/ups/segment/definitions
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
        "name": "People who ordered in the last 30 days",
        "profileInstanceId": "ups",
        "description": "Last 30 days",
        "expression": {
            "type": "PQL",
            "format": "pql/text",
            "value": "workAddress.country = \"US\""
        },
        "schema": {
            "name": "_xdm.context.profile"
        },
        "payloadSchema": "string",
        "ttlInDays": 60
    }'
속성 설명
name 필수 여부. 세그먼트를 참조하는 고유한 이름.
schema 필수 여부. 세그먼트의 엔티티와 연결된 스키마입니다. id 또는 name 필드로 구성됩니다.
expression 필수 여부. 세그먼트 정의에 대한 필드 정보가 포함된 엔티티입니다.
expression.type 표현식 유형을 지정합니다. 현재 "PQL"만 지원됩니다.
expression.format 값에서 표현식의 구조를 나타냅니다. 현재 지원되는 형식은 다음과 같습니다.
  • pql/text:게시된 PQL 문법에 따라 세그먼트 정의에 대한 텍스트 표현입니다. 예: workAddress.stateProvince = homeAddress.stateProvince.
expression.value expression.format에 지정된 유형을 따르는 표현식입니다.
description 그 정의에 대한 사람이 읽을 수 있는 설명입니다.
노트

세그먼트 정의 표현식은 계산된 속성을 참조할 수도 있습니다. 자세한 내용은 계산된 특성 API 끝점 안내서를 참조하십시오.

계산된 속성 기능은 알파에 있으며 일부 사용자는 사용할 수 없습니다. 설명서 및 기능은 변경될 수 있습니다.

응답

성공적인 응답은 새로 만든 세그먼트 정의에 대한 세부 사항과 함께 HTTP 상태 200을 반환합니다.

{
    "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 60,
    "profileInstanceId": "ups",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "People who ordered in the last 30 days",
    "description": "Last 30 days",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "workAddress.country = \"US\""
    },
    "evaluationInfo": {
        "batch": {
            "enabled": true
        },
        "continuous": {
            "enabled": false
        },
        "synchronous": {
            "enabled": false
        }
    },
    "dataGovernancePolicy": {
        "excludeOptOut": true
    },
    "creationTime": 0,
    "updateEpoch": 1579292094,
    "updateTime": 1579292094000
}
속성 설명
id 새로 만든 세그먼트 정의의 시스템 생성 ID.
evaluationInfo 세그먼트 정의가 거치는 평가 유형을 알려주는 시스템 생성 객체입니다. 일괄 처리, 연속(스트리밍 라고도 함) 또는 동기 세그먼테이션일 수 있습니다.

특정 세그먼트 정의 검색

/segment/definitions 끝점에 GET 요청을 하고 요청 경로에서 검색할 세그먼트 정의의 ID를 제공하여 특정 세그먼트 정의에 대한 자세한 정보를 검색할 수 있습니다.

API 형식

GET /segment/definitions/{SEGMENT_ID}
매개 변수 설명
{SEGMENT_ID} 검색할 세그먼트 정의의 id 값.

요청

curl -X GET https://platform.adobe.io/data/core/ups/segment/definitions/4afe34ae-8c98-4513-8a1d-67ccaa54bc05 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 지정된 세그먼트 정의에 대한 자세한 정보와 함께 HTTP 상태 200을 반환합니다.

{
    "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 60,
    "profileInstanceId": "ups",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "People who ordered in the last 30 days",
    "description": "Last 30 days",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "workAddress.country = \"US\""
    },
    "evaluationInfo": {
        "batch": {
            "enabled": true
        },
        "continuous": {
            "enabled": false
        },
        "synchronous": {
            "enabled": false
        }
    },
    "dataGovernancePolicy": {
        "excludeOptOut": true
    },
    "creationTime": 0,
    "updateEpoch": 1579292094,
    "updateTime": 1579292094000
}
속성 설명
id 세그먼트 정의의 시스템에서 생성한 읽기 전용 ID.
name 세그먼트를 참조하는 고유한 이름.
schema 세그먼트의 엔티티와 연결된 스키마입니다. id 또는 name 필드로 구성됩니다.
expression 세그먼트 정의에 대한 필드 정보가 포함된 엔티티입니다.
expression.type 표현식 유형을 지정합니다. 현재 "PQL"만 지원됩니다.
expression.format 값에서 표현식의 구조를 나타냅니다. 현재 지원되는 형식은 다음과 같습니다.
  • pql/text:게시된 PQL 문법에 따라 세그먼트 정의에 대한 텍스트 표현입니다. 예: workAddress.stateProvince = homeAddress.stateProvince.
expression.value expression.format에 지정된 유형을 따르는 표현식입니다.
description 그 정의에 대한 사람이 읽을 수 있는 설명입니다.
evaluationInfo 세그먼트 정의가 진행될 평가, 일괄 처리, 연속(스트리밍 라고도 함) 또는 동기 유형을 알려 주는 시스템 생성 객체입니다.

세그먼트 정의 일괄 검색

POST 요청을 /segment/definitions/bulk-get 끝점에 만들고 요청 본문에 세그먼트 정의의 id 값을 제공하여 지정한 여러 세그먼트 정의에 대한 자세한 정보를 검색할 수 있습니다.

API 형식

POST /segment/definitions/bulk-get

요청

curl -X POST https://platform.adobe.io/data/core/ups/segment/definitions/bulk-get \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "ids": [
            {
                "id": "54669488-03ab-4e0d-a694-37fe49e32be8"
            },
            {
                "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05"
            }
        ]
    }'

응답

성공적인 응답은 요청된 세그먼트 정의가 있는 HTTP 상태 207을 반환합니다.

{
    "results": {
        "54669488-03ab-4e0d-a694-37fe49e32be8": {
            "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 60,
            "profileInstanceId": "ups",
            "imsOrgId": "{IMS_ORG}",
            "sandbox": {
                "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "name": "People who ordered in the last 30 days",
            "description": "Last 30 days",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "workAddress.country = \"US\""
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": true
                },
                "continuous": {
                    "enabled": false
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "dataGovernancePolicy": {
                "excludeOptOut": true
            },
            "creationTime": 0,
            "updateEpoch": 1579292094,
            "updateTime": 1579292094000
        },
        "4afe34ae-8c98-4513-8a1d-67ccaa54bc05": {
            "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 60,
            "profileInstanceId": "ups",
            "imsOrgId": "{IMS_ORG}",
            "sandbox": {
                "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "name": "People who ordered in the last 30 days",
            "description": "Last 30 days",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "workAddress.country = \"US\""
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": true
                },
                "continuous": {
                    "enabled": false
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "dataGovernancePolicy": {
                "excludeOptOut": true
            },
            "creationTime": 0,
            "updateEpoch": 1579292094,
            "updateTime": 1579292094000
        }

    }
}
속성 설명
id 세그먼트 정의의 시스템에서 생성한 읽기 전용 ID.
name 세그먼트를 참조하는 고유한 이름.
schema 세그먼트의 엔티티와 연결된 스키마입니다. id 또는 name 필드로 구성됩니다.
expression 세그먼트 정의에 대한 필드 정보가 포함된 엔티티입니다.
expression.type 표현식 유형을 지정합니다. 현재 "PQL"만 지원됩니다.
expression.format 값에서 표현식의 구조를 나타냅니다. 현재 지원되는 형식은 다음과 같습니다.
  • pql/text:게시된 PQL 문법에 따라 세그먼트 정의에 대한 텍스트 표현입니다. 예: workAddress.stateProvince = homeAddress.stateProvince.
expression.value expression.format에 지정된 유형을 따르는 표현식입니다.
description 그 정의에 대한 사람이 읽을 수 있는 설명입니다.
evaluationInfo 세그먼트 정의가 진행될 평가, 일괄 처리, 연속(스트리밍 라고도 함) 또는 동기 유형을 알려 주는 시스템 생성 객체입니다.

특정 세그먼트 정의 삭제

/segment/definitions 끝점에 DELETE 요청을 하고 요청 경로에서 삭제하려는 세그먼트 정의의 ID를 제공하여 특정 세그먼트 정의를 삭제하도록 요청할 수 있습니다.

API 형식

DELETE /segment/definitions/{SEGMENT_ID}
매개 변수 설명
{SEGMENT_ID} 삭제할 세그먼트 정의의 id 값.

요청

curl -X DELETE https://platform.adobe.io/data/core/ups/segment/definitions/4afe34ae-8c98-4513-8a1d-67ccaa54bc05 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 메시지가 없는 HTTP 상태 200을 반환합니다.

특정 세그먼트 정의 업데이트

PATCH 요청을 /segment/definitions 끝점에 만들고 요청 경로에서 업데이트할 세그먼트 정의의 ID를 제공하여 특정 세그먼트 정의를 업데이트할 수 있습니다.

API 형식

PATCH /segment/definitions/{SEGMENT_ID}
매개 변수 설명
{SEGMENT_ID} 업데이트할 세그먼트 정의의 id 값.

요청

다음 요청은 미국 및 캐나다로 작업 주소 국가를 업데이트합니다.

curl -X PATCH https://platform.adobe.io/data/core/ups/segment/definitions/4afe34ae-8c98-4513-8a1d-67ccaa54bc05 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
    "name": "Updated people who ordered in the last 30 days",
    "profileInstanceId": "ups",
    "description": "Last 30 days",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "workAddress.country = \"CA\""
    },
    "schema": {
        "name": "_xdm.context.profile"
    },
    "payloadSchema": "string",
    "ttlInDays": 60,
    "creationTime": 0,
    "updateTime": 0,
    "updateEpoch": 0
}'

응답

성공적인 응답은 새로 업데이트된 세그먼트 정의에 대한 세부 사항과 함께 HTTP 상태 200을 반환합니다. 직장 주소 국가가 미국(미국)에서 캐나다(CA)로 어떻게 업데이트되었는지 확인하십시오.

{
    "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 60,
    "profileInstanceId": "ups",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "Updated people who ordered in the last 30 days",
    "description": "Last 30 days",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "workAddress.country = \"CA\""
    },
    "evaluationInfo": {
        "batch": {
            "enabled": true
        },
        "continuous": {
            "enabled": false
        },
        "synchronous": {
            "enabled": false
        }
    },
    "dataGovernancePolicy": {
        "excludeOptOut": true
    },
    "creationTime": 0,
    "updateEpoch": 1579295340,
    "updateTime": 1579295340000
}

세그먼트 정의 변환

/segment/conversion 끝점에 POST 요청을 하여 pql/text과 pql/json 또는 pql/json 사이의 세그먼트 정의를 pql/text(으)로 변환할 수 있습니다.

API 형식

POST /segment/conversion

요청

다음 요청은 세그먼트 정의의 형식을 pql/text에서 pql/json(으)로 변경합니다.

curl -X POST https://platform.adobe.io/data/core/ups/segment/conversion \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
        "name": "People who ordered in the last 30 days",
        "profileInstanceId": "ups",
        "description": "Last 30 days",
        "expression": {
            "type": "PQL",
            "format": "pql/text",
            "value": "workAddress.country = \"US\""
        },
        "schema": {
            "name": "_xdm.context.profile"
        },
        "payloadSchema": "string",
        "ttlInDays": 60
    }'

응답

성공적인 응답은 새로 전환된 세그먼트 정의에 대한 세부 사항과 함께 HTTP 상태 200을 반환합니다.

{
    "ttlInDays": 60,
    "imsOrgId": "6A29340459CA8D350A49413A@AdobeOrg",
    "sandbox": {
        "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "description": "Last 30 days",
    "expression": {
        "type": "PQL",
        "format": "pql/json",
        "value": "{\"nodeType\":\"fnApply\",\"fnName\":\"=\",\"params\":[{\"nodeType\":\"fieldLookup\",\"fieldName\":\"country\",\"object\":{\"nodeType\":\"fieldLookup\",\"fieldName\":\"workAddress\",\"object\":{\"nodeType\":\"parameterReference\",\"position\":1}}},{\"nodeType\":\"literal\",\"literalType\":\"String\",\"value\":\"US\"}]}"
    }
}

다음 단계

이 안내서를 읽고 나면 세그먼트 정의가 작동하는 방식을 더 잘 이해할 수 있습니다. 세그먼트 만들기에 대한 자세한 내용은 세그먼트 만들기 자습서를 참조하십시오.

이 페이지에서는