사용자 식별

이 엔드포인트를 사용하여 제공된 외부 ID를 사용하여 미식별(별칭 전용, 이메일 전용 또는 전화번호 전용) 사용자를 식별할 수 있습니다.

작동 방식

/users/identify를 호출하면 별칭(별칭 전용 프로필), 이메일 주소(이메일 전용 프로필) 또는 전화번호(전화번호 전용 프로필)로 식별되는 고객 프로필을 external_id(식별된 프로필)가 있는 고객 프로필과 결합한 다음 별칭 전용 프로필을 제거합니다.

사용자를 식별하려면 다음 오브젝트에 external_id가 포함되어야 합니다:

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

해당 external_id를 가진 사용자가 없으면, external_id가 별칭 사용자의 기록에 추가되고 사용자는 식별된 것으로 간주됩니다. 사용자는 특정 레이블에 대해 하나의 별칭만 가질 수 있습니다. 사용자가 이미 external_id와 함께 존재하고 별칭 전용 프로필과 동일한 레이블로 기존 별칭이 있는 경우, 고객 프로필은 결합되지 않습니다.

병합 동작

기본적으로, 이 엔드포인트는 익명 사용자에게서 독점적으로 발견된 다음 필드 목록을 식별된 사용자로 병합합니다.

필수 조건

이 엔드포인트를 사용하려면 users.identify 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트에는 분당 20,000건의 요청에 대한 공유 사용량 제한이 적용됩니다. 이 사용량 제한은 API 사용량 제한 설명서에 설명된 대로 /users/delete, /users/alias/new, /users/merge 및 /users/alias/update 엔드포인트와 공유됩니다.

요청 본문

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
{
   "aliases_to_identify" : (required, array of alias to identify objects),
   "emails_to_identify": (optional, array of alias to identify objects) User emails to identify,
   "phone_numbers_to_identify": (optional, array of alias to identify objects) User phone numbers to identify,
},

요청 매개변수

요청당 최대 50개의 사용자 별칭을 추가할 수 있습니다. 하나의 external_id에 여러 개의 추가 사용자 별칭을 연결할 수 있습니다.

이메일 주소 및 전화번호로 사용자 식별

이메일 주소나 전화번호를 식별자로 지정하는 경우 식별자에 prioritization도 포함해야 합니다.

prioritization은 여러 사용자가 발견된 경우 병합할 사용자를 지정하는 배열이어야 합니다. prioritization은 정렬된 배열로, 우선순위에서 하나 이상의 사용자가 일치하는 경우 병합이 발생하지 않습니다.

배열에 허용되는 값은 다음과 같습니다:

• identified
• unidentified
• most_recently_updated(가장 최근에 업데이트된 사용자에게 우선순위를 부여하는 것을 의미함)
• least_recently_updated(가장 오래전에 업데이트된 사용자에게 우선순위를 부여하는 것을 의미함)

우선순위 배열에는 한 번에 다음 옵션 중 하나만 존재할 수 있습니다:

• identified는 external_id를 가진 사용자에게 우선순위를 지정하는 것을 의미합니다
• unidentified는 external_id가 없는 사용자에게 우선순위를 지정하는 것을 의미합니다

요청 예시

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --location --request POST 'https://rest.iad-01.braze.com/users/identify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "aliases_to_identify": [
    {
      "external_id": "external_identifier",
      "user_alias": {
          "alias_name": "example_alias",
          "alias_label": "example_label"
      }
    }
  ],
  "emails_to_identify": [
    {
      "external_id": "external_identifier_2",
      "email": "[email protected]",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
}'

대소문자 구분

alias_name 필드는 대소문자를 구분합니다. 201 상태 코드를 반환하는 요청은 요청 구문이 유효했음을 확인할 뿐, 별칭이 일치했음을 확인하는 것은 아닙니다. 요청의 alias_name 대소문자가 고객 프로필에 저장된 별칭과 정확히 일치하지 않으면 작업이 자동으로 실패하고 external_id가 할당되지 않습니다. 예를 들어, 저장된 별칭이 [email protected]인 경우 [email protected]으로 요청하면 성공을 반환하지만 결과가 생성되지 않습니다.

응답

1
2
3
4
{
    "aliases_processed": 1,
    "message": "success"
}