대상자 엔드포인트
대상자는 유사한 행동 및/또는 특성을 공유하는 사람들의 컬렉션입니다. 이러한 사람 컬렉션은 Adobe Experience Platform을 사용하거나 외부 소스에서 생성할 수 있습니다. Segmentation API에서 대상을 프로그래밍 방식으로 검색, 만들기, 업데이트 및 삭제할 수 있는 /audiences
끝점을 사용할 수 있습니다.
시작하기
이 가이드에 사용된 끝점은 Adobe Experience Platform Segmentation Service API의 일부입니다. 계속하기 전에 시작 안내서에서 필수 헤더와 예제 API 호출을 읽는 방법 등 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보를 검토하십시오.
대상자 목록 검색 list
/audiences
끝점에 대한 GET 요청을 통해 조직의 모든 대상 목록을 검색할 수 있습니다.
API 형식
/audiences
끝점은 결과를 필터링하는 데 도움이 되는 몇 가지 쿼리 매개 변수를 지원합니다. 이러한 매개 변수는 선택 사항이지만 리소스를 나열할 때 비싼 오버헤드를 줄이는 데 도움이 되도록 사용하는 것이 좋습니다. 매개 변수 없이 이 끝점을 호출하면 조직에서 사용할 수 있는 모든 대상이 검색됩니다. 여러 매개 변수를 포함할 수 있으며 앰퍼샌드(&
)로 구분됩니다.
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
property=audienceId
쿼리 매개 변수와 함께 사용하면 비활성 대상 will 이(가) 반환됩니다.대상자 목록을 검색할 때 다음 쿼리 매개 변수를 사용할 수 있습니다.
start
start=5
limit
limit=10
sort
attributeName:[desc/asc]
형식으로 작성되었습니다.sort=updateTime:desc
property
property=
형식으로 작성되었습니다.property=audienceId==test-audience-id
name
name=Sample
description
description=Test Description
요청
다음 요청은 조직에서 만든 마지막 두 대상을 검색합니다.
code language-shell |
---|
|
응답
성공적인 응답은 조직에서 JSON으로 생성된 대상자 목록과 함께 HTTP 상태 200을 반환합니다.
code language-json |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 | ||
---|---|---|
속성 | 대상자 유형 | 설명 |
id |
모두 | 대상에 대해 시스템에서 생성한 읽기 전용 식별자입니다. |
audienceId |
모두 | 대상이 플랫폼에서 생성한 대상이면 id 과(와) 동일한 값입니다. 대상자가 외부에서 생성된 경우 이 값은 클라이언트가 제공합니다. |
schema |
모두 | 대상의 XDM(Experience Data Model) 스키마. |
imsOrgId |
모두 | 대상자가 속한 조직의 ID입니다. |
sandbox |
모두 | 대상자가 속한 샌드박스에 대한 정보. 샌드박스에 대한 자세한 내용은 샌드박스 개요를 참조하세요. |
name |
모두 | 대상자의 이름입니다. |
description |
모두 | 대상자에 대한 설명. |
expression |
플랫폼 생성 | 대상의 Profile Query Language(PQL) 표현식입니다. PQL 식에 대한 자세한 내용은 PQL 식 안내서를 참조하세요. |
mergePolicyId |
플랫폼 생성 | 대상자가 연결된 병합 정책의 ID입니다. 병합 정책에 대한 자세한 내용은 병합 정책 안내서를 참조하십시오. |
evaluationInfo |
플랫폼 생성 | 대상을 평가하는 방법을 표시합니다. 가능한 평가 방법에는 일괄 처리, 동기(스트리밍) 또는 연속(에지)이 포함됩니다. 평가 방법에 대한 자세한 내용은 세그먼테이션 개요를 참조하세요. |
dependents |
모두 | 현재 대상에 종속되는 대상 ID 배열. 세그먼트의 세그먼트인 대상자를 만드는 경우 사용됩니다. |
dependencies |
모두 | 대상이 종속된 대상 ID의 배열입니다. 세그먼트의 세그먼트인 대상자를 만드는 경우 사용됩니다. |
type |
모두 | 대상자가 플랫폼에서 생성되었는지 또는 외부에서 생성된 대상자인지 여부를 표시하는 시스템 생성 필드입니다. 가능한 값은 SegmentDefinition 및 ExternalSegment 입니다. SegmentDefinition 은(는) 플랫폼에서 생성된 대상을 참조하지만 ExternalSegment 은(는) 플랫폼에서 생성되지 않은 대상을 참조합니다. |
originName |
모두 | 대상자의 이름을 참조하는 필드입니다. 플랫폼 생성 대상의 경우 이 값은 REAL_TIME_CUSTOMER_PROFILE 이 됩니다. Audience Orchestration에서 생성된 대상의 경우 이 값은 AUDIENCE_ORCHESTRATION 이 됩니다. Adobe Audience Manager에서 생성된 대상의 경우 이 값은 AUDIENCE_MANAGER 이 됩니다. 외부에서 생성된 다른 대상의 경우 이 값은 CUSTOM_UPLOAD 이 됩니다. |
createdBy |
모두 | 대상자를 만든 사용자의 ID입니다. |
labels |
모두 | 대상과 관련된 객체 수준 데이터 사용 및 속성 기반 액세스 제어 레이블입니다. |
namespace |
모두 | 대상자가 속한 네임스페이스입니다. 가능한 값은 AAM , AAMSegments , AAMTraits 및 AEPSegments 입니다. |
linkedAudienceRef |
모두 | 다른 대상 관련 시스템에 대한 식별자를 포함하는 객체입니다. |
새 대상 만들기 create
/audiences
끝점에 대한 POST 요청을 수행하여 새 대상을 만들 수 있습니다.
API 형식
POST /audiences
요청
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
속성 | 설명 |
name |
대상자의 이름입니다. |
description |
대상자에 대한 설명. |
type |
대상자가 플랫폼에서 생성되었는지 또는 외부에서 생성된 대상자인지 여부를 표시하는 필드입니다. 가능한 값은 SegmentDefinition 및 ExternalSegment 입니다. SegmentDefinition 은(는) 플랫폼에서 생성된 대상을 참조하지만 ExternalSegment 은(는) 플랫폼에서 생성되지 않은 대상을 참조합니다. |
expression |
대상의 Profile Query Language(PQL) 표현식입니다. PQL 식에 대한 자세한 내용은 PQL 식 안내서를 참조하세요. |
schema |
대상의 XDM(Experience Data Model) 스키마. |
labels |
대상과 관련된 객체 수준 데이터 사용 및 속성 기반 액세스 제어 레이블입니다. |
응답
성공적인 응답은 새로 생성된 대상자에 대한 정보와 함께 HTTP 상태 200을 반환합니다.
code language-json |
---|
|
지정된 대상자 조회 get
/audiences
끝점에 대한 GET 요청을 만들고 요청 경로에서 검색하려는 대상의 ID를 제공하여 특정 대상에 대한 자세한 정보를 조회할 수 있습니다.
API 형식
GET /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
필드이며 audienceId
필드는 이(가) 아닙니다.요청
code language-shell |
---|
|
응답
성공적인 응답은 지정된 대상에 대한 정보와 함께 HTTP 상태 200을 반환합니다.
code language-json |
---|
|
대상자 업데이트 put
/audiences
끝점에 대한 PUT 요청을 만들고 요청 경로에 업데이트하려는 대상자의 ID를 제공하여 특정 대상을 업데이트(덮어쓰기)할 수 있습니다.
API 형식
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
필드이며 audienceId
필드는 이(가) 아닙니다.요청
code language-shell |
---|
|
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 | |
---|---|
속성 | 설명 |
audienceId |
대상자의 ID입니다. 외부에서 생성된 대상자에 대해 이 값은 사용자에 의해 제공될 수 있다. |
name |
대상자의 이름입니다. |
namespace |
대상자를 위한 네임스페이스입니다. |
description |
대상자에 대한 설명. |
type |
대상자가 플랫폼에서 생성되었는지 또는 외부에서 생성된 대상자인지 여부를 표시하는 시스템 생성 필드입니다. 가능한 값은 SegmentDefinition 및 ExternalSegment 입니다. SegmentDefinition 은(는) 플랫폼에서 생성된 대상을 참조하지만 ExternalSegment 은(는) 플랫폼에서 생성되지 않은 대상을 참조합니다. |
lifecycleState |
대상의 상태입니다. 가능한 값은 draft , published 및 inactive 입니다. draft 은(는) 대상을 만들 때, published 은(는) 대상을 게시할 때, inactive 은(는) 대상이 더 이상 활성화되지 않을 때를 나타냅니다. |
datasetId |
대상 데이터를 찾을 수 있는 데이터 세트의 ID입니다. |
labels |
대상과 관련된 객체 수준 데이터 사용 및 속성 기반 액세스 제어 레이블입니다. |
응답
성공적인 응답은 새로 업데이트된 대상자의 세부 정보와 함께 HTTP 상태 200을 반환합니다. 대상자에 대한 세부 정보는 플랫폼 생성 대상자인지 또는 외부에서 생성된 대상자인지에 따라 달라집니다.
code language-json |
---|
|
대상자 삭제 delete
/audiences
끝점에 대한 DELETE 요청을 만들고 요청 경로에 삭제할 대상의 ID를 제공하여 특정 대상을 삭제할 수 있습니다.
API 형식
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
필드이며 audienceId
필드는 이(가) 아닙니다.요청
code language-shell |
---|
|
응답
성공적인 응답은 메시지 없이 HTTP 상태 204를 반환합니다.
여러 대상 검색 bulk-get
/audiences/bulk-get
끝점에 대한 POST 요청을 만들고 검색하려는 대상의 ID를 제공하여 여러 대상을 검색할 수 있습니다.
API 형식
POST /audiences/bulk-get
요청
code language-shell |
---|
|
응답
성공적인 응답은 요청된 대상자에 대한 정보와 함께 HTTP 상태 207을 반환합니다.
code language-json |
---|
|
다음 단계
이제 이 안내서를 읽고 Adobe Experience Platform API를 사용하여 대상을 만들고, 관리하고, 삭제하는 방법을 더 잘 이해하게 되었습니다. UI를 사용한 대상자 관리에 대한 자세한 내용은 세그멘테이션 UI 안내서를 참조하십시오.