외부 대상 엔드포인트
외부 대상을 사용하면 외부 소스의 프로필 데이터를 Adobe Experience Platform에 업로드할 수 있습니다. 세그먼테이션 서비스 API의 /external-audience
끝점을 사용하여 외부 대상을 Experience Platform으로 수집하고, 세부 정보를 보고, 외부 대상을 업데이트하며, 외부 대상을 삭제할 수 있습니다.
시작
/core/ais
이(가) 아닌 /core/ups
이(가) 접두사로 사용됩니다.Experience Platform API를 사용하려면 인증 자습서를 완료해야 합니다. 인증 자습서를 완료하면 아래와 같이 Experience Platform API 호출에서 필요한 각 헤더에 대한 값이 제공됩니다.
- 인증:
Bearer {ACCESS_TOKEN}
- x-api 키:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Experience Platform의 모든 리소스는 특정 가상 샌드박스로 격리되어 있습니다. Experience Platform API에 대한 모든 요청에는 작업을 수행할 샌드박스의 이름을 지정하는 헤더가 필요합니다.
- x-sandbox-name:
{SANDBOX_NAME}
외부 대상 만들기 create-audience
/external-audience/
끝점에 대한 POST 요청을 수행하여 외부 대상을 만들 수 있습니다.
API 형식
POST /external-audience/
요청
code language-shell |
---|
|
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 | ||
---|---|---|
속성 | 유형 | 설명 |
name |
문자열 | 외부 대상의 이름입니다. |
description |
문자열 | 외부 대상자에 대한 선택적 설명입니다. |
customAudienceId |
문자열 | 외부 대상자에 대한 선택적 식별자입니다. |
fields |
오브젝트 배열 |
필드 및 해당 데이터 유형 목록. 필드 목록을 만들 때 다음 항목을 추가할 수 있습니다.
|
sourceSpec |
오브젝트 |
외부 대상자가 있는 정보가 포함된 객체입니다. 이 개체를 사용할 때 다음 정보를 포함해야 합니다.
|
ttlInDays |
정수 | 외부 대상에 대한 데이터 만료(일 단위). 이 값은 1부터 90까지 설정할 수 있습니다. 기본적으로 데이터 만료는 30일로 설정됩니다. |
audienceType |
문자열 | 외부 대상의 대상 유형입니다. 현재 people 만 지원됩니다. |
originName |
문자열 | 필수 대상자의 원본입니다. 이는 대상자가 어디에서 오는지 설명합니다. 외부 대상의 경우 CUSTOM_UPLOAD 을(를) 사용해야 합니다. |
namespace |
문자열 | 대상자를 위한 네임스페이스입니다. 기본적으로 이 값은 CustomerAudienceUpload (으)로 설정됩니다. |
labels |
문자열 배열 | 외부 대상에 적용되는 액세스 제어 레이블입니다. 사용 가능한 액세스 제어 레이블에 대한 자세한 내용은 데이터 사용 레이블 용어집에 있습니다. |
tags |
문자열 배열 | 외부 대상에 적용할 태그입니다. 태그에 대한 자세한 내용은 태그 관리 가이드에서 확인할 수 있습니다. |
응답
성공적인 응답은 새로 생성된 외부 대상의 세부 정보와 함께 HTTP 상태 202를 반환합니다.
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 | ||
---|---|---|
속성 | 유형 | 설명 |
operationId |
문자열 | 작업의 ID입니다. 그런 다음 이 ID를 사용하여 대상자의 생성 상태를 검색할 수 있습니다. |
operationDetails |
오브젝트 | 외부 대상을 만들기 위해 제출한 요청의 세부 정보가 포함된 객체입니다. |
name |
문자열 | 외부 대상의 이름입니다. |
description |
문자열 | 외부 대상에 대한 설명입니다. |
fields |
오브젝트 배열 | 필드 및 해당 데이터 유형 목록. 이 배열은 외부 대상자에 필요한 필드를 결정합니다. |
sourceSpec |
오브젝트 | 외부 대상자가 있는 정보가 포함된 객체입니다. |
ttlInDays |
정수 | 외부 대상에 대한 데이터 만료(일 단위). 이 값은 1부터 90까지 설정할 수 있습니다. 기본적으로 데이터 만료는 30일로 설정됩니다. |
audienceType |
문자열 | 외부 대상의 대상 유형입니다. |
originName |
문자열 | 필수 대상자의 원본입니다. 이는 대상자가 어디에서 오는지 설명합니다. |
namespace |
문자열 | 대상자를 위한 네임스페이스입니다. |
labels |
문자열 배열 | 외부 대상에 적용되는 액세스 제어 레이블입니다. 사용 가능한 액세스 제어 레이블에 대한 자세한 내용은 데이터 사용 레이블 용어집에 있습니다. |
대상자 만들기 상태 가져오기 retrieve-status
/external-audiences/operations
끝점에 대한 GET 요청을 만들고 외부 대상 만들기 응답에서 받은 작업의 ID를 제공하여 외부 대상 제출 상태를 검색할 수 있습니다.
API 형식
GET /external-audiences/operations/{OPERATION_ID}
{OPERATION_ID}
id
값입니다.요청
code language-shell |
---|
|
응답
성공적인 응답은 외부 대상의 작업 상태에 대한 세부 정보와 함께 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 | ||
---|---|---|
속성 | 유형 | 설명 |
operationId |
문자열 | 검색 중인 작업의 ID입니다. |
status |
문자열 | 작업의 상태입니다. SUCCESS , FAILED , PROCESSING 값 중 하나일 수 있습니다. |
operationDetails |
오브젝트 | 대상자의 세부 정보를 포함하는 객체입니다. |
audienceId |
문자열 | 작업에서 제출 중인 외부 대상의 ID입니다. |
createdBy |
문자열 | 외부 대상을 만든 사용자의 ID입니다. |
createdAt |
긴 에포크 타임스탬프 | 외부 대상 만들기 요청이 제출된 타임스탬프(초). |
updatedBy |
문자열 | 대상자를 마지막으로 업데이트한 사용자의 ID입니다. |
updatedAt |
긴 에포크 타임스탬프 | 대상이 마지막으로 업데이트된 타임스탬프(초)입니다. |
외부 대상 업데이트 update-audience
audienceId
이(가) 있어야 합니다. audienceId
끝점에 대한 성공적인 호출에서 GET /external-audiences/operations/{OPERATION_ID}
을(를) 가져올 수 있습니다./external-audience
끝점에 대한 PATCH 요청을 만들고 요청 경로에 대상자의 ID를 제공하여 외부 대상의 필드를 업데이트할 수 있습니다.
이 끝점을 사용할 때 다음 필드를 업데이트할 수 있습니다.
- 대상자 설명
- 필드 수준 액세스 제어 레이블
- 대상자 수준 액세스 제어 레이블
- 대상자의 데이터 만료
이 끝점을 사용하여 필드를 업데이트하면 요청한 필드의 내용이 대체 됩니다.
API 형식
PATCH /external-audience/{AUDIENCE_ID}
요청
code language-shell |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
속성 | 유형 | 설명 |
description |
문자열 | 외부 대상에 대해 업데이트된 설명. |
또한 다음 매개 변수를 업데이트할 수 있습니다.
table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
---|---|---|
속성 | 유형 | 설명 |
labels |
배열 | 대상에 대해 업데이트된 액세스 레이블 목록이 포함된 배열입니다. 사용 가능한 액세스 제어 레이블에 대한 자세한 내용은 데이터 사용 레이블 용어집에 있습니다. |
fields |
오브젝트 배열 | 외부 대상에 대한 필드 및 관련 레이블이 포함된 배열입니다. PATCH 요청에 나열된 필드만 업데이트됩니다. 사용 가능한 액세스 제어 레이블에 대한 자세한 내용은 데이터 사용 레이블 용어집에 있습니다. |
ttlInDays |
정수 | 외부 대상에 대한 데이터 만료(일 단위). 이 값은 1부터 90까지 설정할 수 있습니다. |
응답
성공적인 응답은 업데이트된 외부 대상의 세부 정보와 함께 HTTP 상태 200을 반환합니다.
code language-json |
---|
|
대상자 수집 시작 start-audience-ingestion
audienceId
이(가) 있어야 합니다. audienceId
끝점에 대한 성공적인 호출에서 GET /external-audiences/operations/{OPERATION_ID}
을(를) 가져올 수 있습니다.대상 ID를 제공하는 동안 다음 엔드포인트에 POST 요청을 하여 대상 수집을 시작할 수 있습니다.
API 형식
POST /external-audience/{AUDIENCE_ID}/runs
요청
다음 요청은 외부 대상에 대해 수집 실행을 트리거합니다.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 | ||
---|---|---|
속성 | 유형 | 설명 |
dataFilterStartTime |
Epoch 타임스탬프 | 필수 처리할 파일을 결정하는 시작 시간을 지정하는 범위입니다. 즉, 선택한 파일은 지정된 시간 after 파일이 됩니다. |
dataFilterEndTime |
Epoch 타임스탬프 | 처리할 파일을 선택하기 위해 플로우를 실행할 종료 시간을 지정하는 범위입니다. 즉, 선택한 파일은 지정된 시간 이전 파일이 됩니다. |
응답
성공적인 응답은 수집 실행에 대한 세부 정보와 함께 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 | ||
---|---|---|
속성 | 유형 | 설명 |
audienceName |
문자열 | 수집 실행을 시작하는 대상자의 이름입니다. |
audienceId |
문자열 | 대상자의 ID입니다. |
runId |
문자열 | 시작한 수집 실행의 ID입니다. |
differentialIngestion |
부울 | 마지막 수집 이후의 차이점을 기반으로 수집이 부분 수집인지 전체 대상 수집인지 결정하는 필드입니다. |
dataFilterStartTime |
Epoch 타임스탬프 | 처리된 파일을 선택하기 위한 플로우 실행의 시작 시간을 지정하는 범위입니다. |
dataFilterEndTime |
Epoch 타임스탬프 | 처리된 파일을 선택하기 위해 흐름이 실행되는 종료 시간을 지정하는 범위입니다. |
createdAt |
긴 에포크 타임스탬프 | 외부 대상 만들기 요청이 제출된 타임스탬프(초). |
createdBy |
문자열 | 외부 대상을 만든 사용자의 ID입니다. |
특정 대상자 수집 상태 검색 retrieve-ingestion-status
audienceId
과(와) 수집 실행 ID의 runId
이(가) 모두 있어야 합니다. audienceId
끝점에 대한 성공적인 호출에서 GET /external-audiences/operations/{OPERATION_ID}
을(를) 가져올 수 있으며 runId
끝점에 대한 이전의 성공적인 호출에서 POST /external-audience/{AUDIENCE_ID}/runs
을(를) 가져올 수 있습니다.대상과 실행 ID를 모두 제공하면서 다음 끝점에 GET 요청을 하여 대상 수집 상태를 검색할 수 있습니다.
API 형식
GET /external-audience/{AUDIENCE_ID}/runs/{RUN_ID}
요청
다음 요청은 외부 대상자에 대한 수집 상태를 검색합니다.
code language-shell |
---|
|
응답
성공적인 응답은 외부 대상 수집에 대한 세부 정보와 함께 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 | ||
---|---|---|
속성 | 유형 | 설명 |
audienceName |
문자열 | 대상자의 이름입니다. |
audienceId |
문자열 | 대상자의 ID입니다. |
runId |
문자열 | 수집 실행의 ID입니다. |
status |
문자열 | 수집 실행의 상태입니다. 가능한 상태는 SUCCESS 및 FAILED 입니다. |
differentialIngestion |
부울 | 마지막 수집 이후의 차이점을 기반으로 수집이 부분 수집인지 전체 대상 수집인지 결정하는 필드입니다. |
dataFilterStartTime |
Epoch 타임스탬프 | 처리된 파일을 선택하기 위한 플로우 실행의 시작 시간을 지정하는 범위입니다. |
dataFilterEndTime |
Epoch 타임스탬프 | 처리된 파일을 선택하기 위해 흐름이 실행되는 종료 시간을 지정하는 범위입니다. |
createdAt |
긴 에포크 타임스탬프 | 외부 대상 만들기 요청이 제출된 타임스탬프(초). |
createdBy |
문자열 | 외부 대상을 만든 사용자의 ID입니다. |
details |
오브젝트 배열 |
수집 실행의 세부 사항이 포함된 객체입니다.
|
대상자 수집 실행 나열 list-ingestion-runs
audienceId
이(가) 있어야 합니다. audienceId
끝점에 대한 성공적인 호출에서 GET /external-audiences/operations/{OPERATION_ID}
을(를) 가져올 수 있습니다.대상 ID를 제공하는 동안 다음 엔드포인트에 GET 요청을 하여 선택한 외부 대상에 대한 모든 수집 실행을 검색할 수 있습니다. 여러 매개 변수를 포함할 수 있으며 앰퍼샌드(&
)로 구분됩니다.
API 형식
GET /external-audience/{AUDIENCE_ID}/runs
요청
다음 요청은 외부 대상에 대한 모든 수집 실행을 검색합니다.
code language-shell |
---|
|
응답
성공적인 응답은 지정된 외부 대상에 대한 수집 실행 목록과 함께 HTTP 상태 200을 반환합니다.
code language-json |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
속성 | 유형 | 설명 |
runs |
오브젝트 | 수집 목록이 포함된 개체는 대상에 속하며 실행됩니다. 이 개체에 대한 자세한 내용은 수집 상태 검색 섹션을 참조하십시오. |
외부 대상 삭제 delete-audience
audienceId
이(가) 있어야 합니다. audienceId
끝점에 대한 성공적인 호출에서 GET /external-audiences/operations/{OPERATION_ID}
을(를) 가져올 수 있습니다.대상 ID를 제공하는 동안 다음 엔드포인트에 DELETE 요청을 하여 외부 대상을 삭제할 수 있습니다.
API 형식
DELETE /external-audience/{AUDIENCE_ID}
요청
다음 요청은 지정된 외부 대상을 삭제합니다.
code language-shell |
---|
|
응답
성공적인 응답은 빈 응답 본문과 함께 HTTP 상태 204를 반환합니다.
다음 단계 next-steps
이 안내서를 읽은 후에는 Experience Platform API를 사용하여 외부 대상을 만들고, 관리하고, 삭제하는 방법을 더 잘 이해할 수 있습니다. Experience Platform UI로 외부 대상을 사용하는 방법을 알아보려면 대상 포털 설명서를 읽어 보십시오.
부록 appendix
다음 섹션에서는 외부 대상 API를 사용할 때 사용할 수 있는 오류 코드를 나열합니다.
BAD_REQUEST
BAD_REQUEST
UNAUTHORIZED
UNAUTHORIZED
imsOrgId
이(가) 입력되었습니다.UNAUTHORIZED
NOT_FOUND
DUPLICATE_RESOURCE
UNPROCESSABLE_ENTITY
INTERNAL_SERVER_ERROR
BAD_GATEWAY