着せ替え完了通知¶
概要¶
エンドユーザのアバターが変更されたタイミングで通知します。ペイロードにはアバター画像の情報などが含まれるため、アバター取得 API の代わりに利用できます。
仕様¶
ペイロードの仕様¶
クエリパラメータ形式の以下のパラメータが含まれています。
| パラメータ | 内容 |
|---|---|
| avatarId | 着せ替えを行ったアバターID |
| event | イベント名。「avatar_updated」で固定。 |
| avatarImageUrl | アバター全身画像のURL。画像は240x320ピクセルサイズのアニメーションGIFです。 |
| faceImageUrl | アバターバストアップ画像のURL。画像は120x120ピクセルサイズのGIFファイルです。 |
| avatarTimestamp | 着せ替えを行った日時のUNIXタイムスタンプ |
| timestamp | Webhook を通知した日時のUNIXタイムスタンプ |
ペイロードのサンプル¶
avatarId=5715702266724352&avatarImageUrl=https%3A%2F%2Fexample.com%2Favatar.gif&event=avatar_updated&faceImageUrl=https%3A%2F%2Fexample.com%2Fface.gif&avatarTimestamp=1603158368×tamp=1603158368
ユースケース¶
自社ストレージのアバター画像を更新する¶
avatarImageUrl、faceImageUrl に設定されたURLからアバター画像をダウンロードし、自社ストレージに保存してアバター画像として利用できるようにします。
キャッシュにおける注意点¶
アバター画像URL¶
Webhook で取得したアバター画像URLをキャッシュすることは推奨しません。アバター画像URLは予告なく変更される可能性があり、長期間キャッシュして利用する用途には向いていません。
アバター画像ファイル¶
代わりに、アバター画像ファイル自体をキャッシュすることを推奨します。エンドユーザがアバターを変更した場合は、Webhook 経由でそれを検知し、キャッシュしたアバター画像ファイルを更新します。
アバター取得 API を利用する場合との比較¶
RESTful API の Avatar API を使って画像取得する場合と比較します。
| 観点 | Webhook | RESTful API |
|---|---|---|
| アバター画像の取得方法 | Webhook 受信用のエンドポイントを用意し、通知受信時にアバター画像をダウンロードし、自社アプリのアバター画像を更新します。 | アバターを表示する箇所で API を呼び出し、アバター画像を取得します。必要に応じてAPI 結果をキャッシュします。 |
| レイテンシ | エンドユーザが着せ替えを完了してから通知を受信するまで遅延が発生します | 通常は最新の情報を取得できます |
最終更新日: 2023-03-07