사용자 개인 정보 보호 API v2

v2의 새로운 기능

이미 v1과 통합되어 있는 경우 가장 중요한 변경 사항은 삭제 범위가 어떻게 해석되는지입니다. v1은 범위가 지정되지 않은 경우 기본적으로 단일 앱(프로젝트) 삭제로 설정되었습니다. v2는 항상 조직 전체를 삭제합니다.

엔드포인트

모든 v2 경로의 범위는 조직으로 지정됩니다. {orgId}귀하의 Amplitude 조직 ID로 바꿉니다.

지역

기본 URL은 프로젝트의 데이터 상주 위치에 따라 달라집니다. 이 페이지의 모든 예제에서 프로젝트가 Amplitude의 EU 데이터 센터를 사용하지 않는 한 기본 URL을 사용하십시오. 이 경우 이 표의 EU 기본 URL을 사용하십시오.

프로젝트의 데이터 저장 위치에 맞는 호스트를 사용하십시오.

인증

조직 수준의 비밀 키를 사용한 Bearer 토큰 인증.

Authorization: Bearer <org-secret-key>

Amplitude의 설정 > API 키 > 조직 수준 비밀 키에서 조직 수준의 비밀 키를 생성합니다. 요청 경로의 orgId는 암호 키가 속한 조직과 일치해야 합니다. 삭제는 여전히 모든 프로젝트에 조직 전체에 적용됩니다(조직 전체 삭제로 이동). 조직 수준의 비밀 키 페이지를 아직 사용하실 수 없는 경우 Amplitude 서포트에 문의하여 이를 프로비저닝하십시오.

삭제 요청 제출

POST /api/user-deletions/org/{orgId}/requests

JSON 본문(DeletionRequest)을 사용하여 삭제할 사용자를 추가합니다. 한 번에 최대 100명의 사용자를 지정할 수 있습니다. Amplitude ID와 사용자 ID를 함께 사용할 수 있습니다. 모든 요청은 조직 전체의 사용자 데이터를 삭제합니다.

바디 매개변수

목록 삭제 요청

GET /api/user-deletions/org/{orgId}/requests

조직에 대한 모든 삭제 요청을 반환합니다.

curl --request GET 'https://privacy.amplitude.com/api/user-deletions/org/{orgId}/requests' \
  --header 'Authorization: Bearer <org-secret-key>' \
  --header 'Accept: application/json'

삭제 요청 받기

GET /api/user-deletions/org/{orgId}/requests/{requestId}

단일 삭제 요청을 ID별로 반환합니다.

curl --request GET 'https://privacy.amplitude.com/api/user-deletions/org/{orgId}/requests/{requestId}' \
  --header 'Authorization: Bearer <org-secret-key>' \
  --header 'Accept: application/json'

작업 생애주기 분석

작업이 예약된 실행 날짜보다 submitted3일 전에 staging에서 상태로 이동합니다. 작업이 submitted로 변경된 후에는 취소할 수 없습니다.

v2는 아직 스태이징 작업에서 사용자를 제거하거나 요청을 취소할 수 있는 API를 공개하지 않았습니다. 현재 해당 워크플로우가 필요하다면 v1 API를 사용하십시오.

조직 전체 삭제

모든 v2 삭제 요청은 조직 전체에 적용됩니다. 요청을 제출하면 Amplitude는 목록에 있는 사용자의 데이터를 포함하는 조직 내 모든 프로젝트에 삭제 요청을 전파합니다.

• 일치하는 데이터가 있는 각 프로젝트에 대해 하나의 삭제 작업이 생성됩니다.
• 모든 계정 관리자는 조직 전체에서 삭제될 예정인 Amplitude ID의 전체 목록을 포함한 이메일을 받습니다.

v2에는 프로젝트 범위별 삭제 모드가 없습니다. 단일 프로젝트에서만 삭제해야 하는 경우 delete_from_org를 설정하지 않고 기존 v1 API를 사용하십시오.

이전에 delete_from_org를 설정하지 않고 v1을 사용한 적이 있다면 과거 삭제 요청이 단일 프로젝트에서만 삭제되었을 수 있습니다. 조직 전체에서 삭제되도록 하려면 해당 사용자를 v2를 통해 다시 제출하십시오.

서비스 수준 약속 및 시기

삭제 요청을 하면 Amplitude는 모든 계정 관리자에게 삭제 세부 정보를 이메일로 전송합니다.

중요한 동작

삭제해도 향후 추적은 중단되지 않습니다.

사용자 개인정보 보호 API는 기존 데이터를 제거합니다. 이는 Amplitude가 삭제된 사용자에 대한 새로운 이벤트를 수락하는 것을 방지하지 않습니다. SDK가 해당 사용자에 대한 이벤트를 계속 전송하면 해당 이벤트는 새로운 사용자로 수집됩니다. Amplitude는 다시 연결할 삭제된 ID에 대한 기록이 남아 있지 않습니다.

향후 추적을 중지하려면 사용 중인 Amplitude SDK의 setOptOut()메서드를 사용하세요.

웨어하우스 / CDC 재수집

변경 데이터 캡처(CDC) 또는 기타 웨어하우스 기반 수집 방법을 통해 데이터 웨어하우스에서 Amplitude로 데이터를 수집하는 경우, Amplitude에서 삭제된 내용은 소스로 다시 전파되지 않습니다. 다음 동기화에서는 삭제된 데이터가 다시 수집될 수 있습니다.

완전한 삭제를 보장하려면 웨어하우스 소스의 데이터도 삭제한 다음 사용자 개인 정보 API 요청을 다시 실행하십시오. 이는 다음에 적용됩니다.

• Snowflake / BigQuery / Databricks / Redshift CDC 소스
• 미러 동기화
• 순서 무관 웨어하우스 기본 수집 경로

향후 이벤트 ID(identity)

삭제 후 동일한 user_id에 대한 새로운 이벤트가 도착하면 해당 이벤트는 새로운 Amplitude ID를 가진 새로운 사용자로 취급됩니다. 자동으로 다시 스티치되는 기능은 없습니다.

Statsig 데이터

이 사용자 개인 정보 보호 API는 Amplitude 플랫폼의 데이터만 삭제합니다. Statsig 플랫폼에서 데이터를 삭제하려면 Statsig 사용자 데이터 삭제 요청 API를 사용하십시오.

v1에서 마이그레이션

기존 v1 연동이 있는 경우 레거시 엔드포인트 참조에 대한 v1 문서를 참조하십시오. v2로 전환할 때 변경해야 할 사항은 다음과 같습니다.

1. 엔드포인트 업데이트

- POST https://amplitude.com/api/2/deletions/users
+ POST https://privacy.amplitude.com/api/user-deletions/org/{orgId}/requests

v1의 날짜 범위 쿼리 대신 위의 목록과 ID 기반 검색 GET 경로를 사용하십시오. v2는 아직 스테이징에서 사용자를 제거하는 기능을 지원하지 않습니다. 필요한 경우 해당 워크플로에 v1을 계속 사용하십시오.DELETE

2. 인증 업데이트

v2는 v1의 프로젝트 API 키 + 암호 키 대신 조직 수준의 암호 키를 사용하여 베어러 인증을 사용합니다.

- Authorization: Basic <base64(api_key:secret_key)>
+ Authorization: Bearer <org-secret-key>

설정 → API 키 → 조직 수준 암호 키에서 조직 수준 암호 키를 생성합니다.

3. 요청 일괄 처리

v2는 요청당 최대 100개의 ID를 허용합니다. 사용자를 효율적으로 삭제하려면 각 요청에서 ID를 배치로 처리하십시오.

4. delete_from_org 제거

이 delete_from_org 매개변수는 v1 전용입니다. v2에서는 모든 요청이 기본적으로 조직 전체를 삭제합니다. 이 플래그를 설정할 필요가 없으며 설정할 수도 없습니다.

  {
    "user_ids": ["user_1"],
    "requester": "privacy@yourcompany.com",
-   "delete_from_org": true
  }

delete_from_org없이 v1을 사용 중이었던 경우, 요청은 하나의 프로젝트에서만 삭제되었습니다. v2로 마이그레이션하면 해당 요청이 자동으로 조직 전체의 삭제로 업그레이드됩니다.

5. 요청 상태 가시성 사용

v2는 삭제 요청을 나열하고 를 통해 단일 요청을 가져오는 GET엔드포인트를 requestId노출하며, 여기에는 생애주기 분석 상태( staging/ submitted/ done)가 포함됩니다.

상태 코드