세그먼트 작업 엔드포인트
세그먼트 작업은 요청 시 대상 세그먼트를 만드는 비동기 프로세스입니다. Real-Time Customer Profile이(가) 프로필 조각에서 겹치는 특성을 병합하는 방법을 제어하는 병합 정책뿐만 아니라 세그먼트 정의을(를) 참조합니다. 세그먼트 작업이 성공적으로 완료되면 처리 중에 발생할 수 있는 오류와 대상자의 최종 크기 등 세그먼트에 대한 다양한 정보를 수집할 수 있습니다.
이 안내서에서는 세그먼트 작업을 더 잘 이해하는 데 도움이 되는 정보를 제공하며 API를 사용하여 기본 작업을 수행하기 위한 샘플 API 호출을 포함합니다.
시작하기
이 가이드에 사용된 끝점은 Adobe Experience Platform Segmentation Service API의 일부입니다. 계속하기 전에 시작 안내서에서 필수 헤더와 예제 API 호출을 읽는 방법 등 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보를 검토하십시오.
세그먼트 작업 목록 검색 retrieve-list
/segment/jobs
끝점에 대한 GET 요청을 수행하여 조직에 대한 모든 세그먼트 작업 목록을 검색할 수 있습니다.
API 형식
/segment/jobs
끝점은 결과를 필터링하는 데 도움이 되는 몇 가지 쿼리 매개 변수를 지원합니다. 이러한 매개 변수는 선택 사항이지만 값비싼 오버헤드를 줄이는 데 도움이 되도록 사용하는 것이 좋습니다. 매개 변수 없이 이 끝점을 호출하면 조직에서 사용할 수 있는 모든 내보내기 작업을 검색합니다. 여러 매개 변수를 포함할 수 있으며 앰퍼샌드(&
)로 구분됩니다.
GET /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}
쿼리 매개 변수
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
---|---|---|
매개변수 | 설명 | 예 |
start |
반환된 세그먼트 작업의 시작 오프셋을 지정합니다. | start=1 |
limit |
페이지당 반환되는 세그먼트 작업 수를 지정합니다. | limit=20 |
status |
상태를 기반으로 결과를 필터링합니다. 지원되는 값은 NEW, QUEUED, PROCESSING, SUCCEEDED, FAILED, CANCELLING, CANCELLED입니다. | status=NEW |
sort |
반환된 세그먼트 작업의 순서를 지정합니다. `[attributeName]:[desc | asc]` 형식으로 작성되었습니다. |
property |
작업을 필터링하고 지정된 필터와 정확히 일치하는 항목을 가져옵니다. 다음 형식 중 하나로 쓸 수 있습니다.
|
property=segments~segmentId==workInUS |
요청
code language-shell |
---|
|
응답
성공적인 응답은 지정된 조직에 대한 세그먼트 작업 목록이 JSON인 HTTP 상태 200을 반환합니다. 모든 세그먼트 정의의 전체 목록이 children.segments
특성 내에 표시됩니다.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 | |
---|---|
속성 | 설명 |
id |
세그먼트 작업에 대해 시스템에서 생성한 읽기 전용 식별자입니다. |
status |
세그먼트 작업의 현재 상태입니다. 상태에 대한 잠재적 값에는 "NEW", "PROCESSING", "CANCELING", "CANCELLED", "FAILED" 및 "SUCCEEDED"가 있습니다. |
segments |
세그먼트 작업 내에서 반환된 세그먼트 정의에 대한 정보를 포함하는 객체입니다. |
segments.segment.id |
세그먼트 정의의 ID입니다. |
segments.segment.expression |
PQL으로 작성된 세그먼트 정의의 표현식에 대한 정보를 포함하는 객체입니다. |
metrics |
세그먼트 작업에 대한 진단 정보를 포함하는 개체입니다. |
metrics.totalTime |
세분화 작업이 시작 및 종료된 시간과 총 소요 시간에 대한 정보가 포함된 개체입니다. |
metrics.profileSegmentationTime |
세분화 평가가 시작되고 종료된 시간 및 총 소요 시간에 대한 정보가 포함된 개체입니다. |
metrics.segmentProfileCounter |
세그먼트 기준으로 적격한 프로필 수입니다. |
metrics.segmentedProfileByNamespaceCounter |
세그먼트 정의별로 각 ID 네임스페이스에 적합한 프로필 수입니다. |
metrics.segmentProfileByStatusCounter |
각 상태에 대한 프로필 수입니다. 다음 세 가지 상태가 지원됩니다.
|
metrics.totalProfilesByMergePolicy |
병합 정책별 병합된 총 프로필 수입니다. |
새 세그먼트 작업 만들기 create
/segment/jobs
끝점에 대한 POST 요청을 만들고 세그먼트 정의의 ID를 요청 본문에 포함하여 새 세그먼트 작업을 만들 수 있습니다.
API 형식
POST /segment/jobs
요청
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
속성 | 설명 |
segmentId |
평가할 세그먼트 정의의 ID입니다. 이러한 세그먼트 정의는 다른 병합 정책에 속할 수 있습니다. 세그먼트 정의에 대한 자세한 내용은 세그먼트 정의 끝점 안내서를 참조하십시오. |
응답
성공적인 응답은 새로 생성된 세그먼트 작업에 대한 정보와 함께 HTTP 상태 200을 반환합니다.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
속성 | 설명 |
id |
새로 생성된 세그먼트 작업에 대한 시스템에서 생성한 읽기 전용 식별자입니다. |
status |
세그먼트 작업의 현재 상태입니다. 세그먼트 작업이 새로 생성되므로 상태는 항상 "NEW"가 됩니다. |
segments |
이 세그먼트 작업이 실행 중인 세그먼트 정의에 대한 정보를 포함하는 개체입니다. |
segments.segment.id |
제공한 세그먼트 정의의 ID입니다. |
segments.segment.expression |
PQL으로 작성된 세그먼트 정의의 표현식에 대한 정보를 포함하는 객체입니다. |
특정 세그먼트 작업 검색 get
/segment/jobs
끝점에 대한 GET 요청을 만들고 요청 경로에 검색할 세그먼트 작업의 ID를 제공하여 특정 세그먼트 작업에 대한 자세한 정보를 검색할 수 있습니다.
API 형식
GET /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
값입니다.요청
code language-shell |
---|
|
응답
성공한 응답은 지정된 세그먼트 작업에 대한 자세한 정보와 함께 HTTP 상태 200을 반환합니다. 모든 세그먼트 정의의 전체 목록이 children.segments
특성 내에 표시됩니다.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
속성 | 설명 |
id |
세그먼트 작업에 대해 시스템에서 생성한 읽기 전용 식별자입니다. |
status |
세그먼트 작업의 현재 상태입니다. 상태에 대한 잠재적 값에는 "NEW", "PROCESSING", "CANCELING", "CANCELLED", "FAILED" 및 "SUCCEEDED"가 있습니다. |
segments |
세그먼트 작업 내에서 반환된 세그먼트 정의에 대한 정보를 포함하는 객체입니다. |
segments.segment.id |
세그먼트 정의의 ID입니다. |
segments.segment.expression |
PQL으로 작성된 세그먼트 정의의 표현식에 대한 정보를 포함하는 객체입니다. |
metrics |
세그먼트 작업에 대한 진단 정보를 포함하는 개체입니다. |
[!ENDTABS]
세그먼트 작업 일괄 검색 bulk-get
/segment/jobs/bulk-get
끝점에 대한 POST 요청을 만들고 요청 본문에 세그먼트 작업의 id
값을 제공하여 여러 세그먼트 작업에 대한 자세한 정보를 검색할 수 있습니다.
API 형식
POST /segment/jobs/bulk-get
요청
code language-shell |
---|
|
응답
성공적인 응답은 요청된 세그먼트 작업과 함께 HTTP 상태 207을 반환합니다.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
속성 | 설명 |
id |
세그먼트 작업에 대해 시스템에서 생성한 읽기 전용 식별자입니다. |
status |
세그먼트 작업의 현재 상태입니다. 상태에 대한 잠재적 값에는 "NEW", "PROCESSING", "CANCELING", "CANCELLED", "FAILED" 및 "SUCCEEDED"가 있습니다. |
segments |
세그먼트 작업 내에서 반환된 세그먼트 정의에 대한 정보를 포함하는 객체입니다. |
segments.segment.id |
세그먼트 정의의 ID입니다. |
segments.segment.expression |
PQL으로 작성된 세그먼트 정의의 표현식에 대한 정보를 포함하는 객체입니다. |
특정 세그먼트 작업 취소 또는 삭제 delete
/segment/jobs
끝점에 대한 DELETE 요청을 만들고 요청 경로에 삭제할 세그먼트 작업의 ID를 제공하여 특정 세그먼트 작업을 삭제할 수 있습니다.
API 형식
DELETE /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
값입니다.요청
code language-shell |
---|
|
응답
성공적인 응답은 빈 응답 본문과 함께 HTTP 상태 204를 반환합니다.
다음 단계
이제 이 안내서를 읽고 세그먼트 작업이 작동하는 방식을 보다 잘 이해할 수 있습니다.