사용자 식별

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

작동 방식

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

사용자를 식별하려면 다음 객체에 external_id 이 포함되어야 합니다:

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

external_id 을 가진 사용자가 없는 경우 external_id 이 사용자 별칭 지정 기록에 추가되며 해당 사용자는 식별된 것으로 간주됩니다. 사용자는 특정 라벨에 대해 하나의 별칭만 지정할 수 있습니다. 사용자가 이미 external_id 에 존재하고 별칭 전용 프로필과 동일한 라벨을 가진 기존 별칭이 있는 경우 사용자 프로필이 결합되지 않습니다.

병합 동작

기본값으로 이 엔드포인트는 익명 사용자에게만 있는 다음 필드 목록을 식별된 사용자에게 병합합니다.

Prerequisites

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

사용량 제한

요청 본문

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

배열에 identified 을 지정하는 경우, 이는 사용자에게 external_id 이 있어야 캔버스에 입력할 수 있다는 의미입니다. 이메일 주소가 있는 사용자가 본인 확인 여부와 관계없이 메시지를 입력하도록 하려면 most_recently_updated 또는 least_recently_updated 매개변수만 사용하세요.

요청 예시

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"]
    }
  ]
}'

응답

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