外部 ID の名前を変更

このエンドポイントを使用して、ユーザーの外部 ID の名前を変更します。

1 回のリクエストで最大 50 個の名前変更オブジェクトを送信できます。

このエンドポイントは、ユーザーに新しい（プライマリ）external_idを設定し、既存のエンドポイントを廃止します。external_idつまり、external_id非推奨のものが削除されるまで、ユーザーはどちらでも識別できます。複数の外部 ID があると、移行期間を設けることができるため、以前の外部 ID 命名スキーマを使用する古いバージョンのアプリが壊れることはありません。

古い命名スキーマが使用されなくなったら、エンドポイントを使用して非推奨の外部 ID を削除することを強くお勧めします。/users/external_ids/remove

前提条件

このエンドポイントを使用するには、users.external_ids.rename権限のある API キーが必要です。

レート制限

We apply a rate limit of 1,000 requests per minute to this endpoint, as documented in API rate limits.

リクエスト本文

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
{
  "external_id_renames" : (required, array of external ID rename objects)
}

リクエストパラメーター

• はユーザーのプライマリ ID である必要があり、非推奨の ID current_external_id であってはなりません
• は、プライマリ ID または非推奨 ID new_external_id としてまだ使用されていない必要があります。
• current_external_idnew_external_idとを同じにすることはできません

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids/rename' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "external_id_renames" :[
    {
      "current_external_id": "existing_external_id",
      "new_external_id" : "new_external_id"
    }
  ]
}'

応答

この応答では、すべての名前の変更が成功し、名前の変更が失敗し、関連するエラーが発生したかどうかが確認されます。rename_errorsフィールド内のエラーメッセージは、元のリクエストの配列内のオブジェクトのインデックスを参照します。

1
2
3
4
5
{
  "message" : (string) status message,
  "external_ids" : (array of strings) successful rename operations,
  "rename_errors": (array of arrays) <minor error message>
}

有効なリクエストがあると、messagesuccessこのフィールドが返されます。rename_errorsより詳細なエラーがアレイにキャプチャされます。次の場合、messageこのフィールドはエラーを返します。 -API キーが無効です - 空のexternal_id_renames 配列 -50 external_id_renames 個を超えるオブジェクトを含む配列 -レート制限に達しました（1 分あたり 1,000 リクエスト以上）

よくある質問

これはMAUに影響しますか？
いいえ、ユーザー数は同じなので、新しいユーザー数が増えるだけですexternal_id。

ユーザーの行動は歴史的に変わりますか？
いいえ。ユーザーはそのままで、過去の行動はすべてそのユーザーに関連しているからです。

開発/ステージングワークスペースで実行できますか？
はい。実際、ステージングまたは開発ワークスペースでテスト移行を実行し、本番データで実行する前にすべてがスムーズに進んでいることを確認することを強くお勧めします。

これはデータポイントを消費しますか？
この機能にはデータポイントはかかりません。

推奨非推奨期間はどのくらいですか?
非推奨の外部IDを保持できる期間に厳しい制限はありませんが、非推奨のIDでユーザーを参照する必要がなくなったら削除することを強くお勧めします。