アクティビティ
k-ID API のほとんどは、プロダクトからの問い合わせに答えるものです。このプレイヤーは何歳か、何が許可されているか、保護者は同意したか。アクティビティはその逆方向です。プロダクトが子どもの実際の行動を報告し、k-ID はその報告を、信頼できる大人が確認できる形に変換します。
プロダクトにとってアクティビティが何を意味するかは、ご自身で決めます。チャット機能での滞在時間、送信メッセージ数、購入したアイテム、完了したレッスンなど、重要なタイプを宣言し、それに対してレコードをプッシュします。k-ID は送信された内容を保存し、集計します。
アクティビティレコードとは
アクティビティレコードは、プロダクト内で発生した 1 件のタイムスタンプ付きの出来事であり、k-ID のセッションに紐づきます。
| フィールド | 内容 |
|---|---|
id | プロダクトが生成する UUID。冪等性のためにレコードを識別します。 |
type | Compliance Studio でプロダクトに宣言されたアクティビティタイプのキー。 |
value | 測定値。タイプのメトリックタイプが定める形式に従います。 |
timestamp | 発生日時（UTC）。過去 7 日以内である必要があります。 |
attributes | 任意のキー/値メタデータ。タイプが宣言した属性キーに限られます。 |
帰属の単位はセッションです。レコードはプッシュ先のセッションに属し、信頼できる大人向けの画面はプロダクトごとにプレイヤー 1 人あたり 1 つのセッションを参照します。そのため、デバイスごとに新しいセッションを作るのではなく、すでに保持しているセッションに対してそのプレイヤーのアクティビティをプッシュしてください。
アクティビティタイプ
アクティビティタイプとは、「このプロダクトはこの種類の出来事を、この方法で測定して報告する」という宣言です。タイプは Compliance Studio でプロダクトごとに設定します。そのため、タイプの追加は統合プロジェクトではなく設定変更です。アクティビティタイプをご覧ください。
各タイプはメトリックタイプを固定し、それがプロダクトからプッシュされるすべての value の形式を決めます。
| メトリックタイプ | 値の形式 | 例 |
|---|---|---|
duration | seconds | 機能の利用時間 |
currency | amount（最小単位）と currency（ISO 4217） | 購入やその他の金額 |
count | count | 送信メッセージ数などの個別の出来事 |
gauge | number | 達成率などの小数を含む値 |
boolean | bool | 起きたか起きなかったかの事象 |
value がタイプのメトリックタイプと一致しないレコードは拒否されます。プロダクトが宣言していない type のレコードも同様です。
k-ID はアクティビティをどう使うか
アクティビティは、信頼できる大人が目にする画面に反映されます。Family Connect では、リンクされた大人が子どものプレイするプロダクトを開き、そのプロダクトのアクティビティを専用のタブで確認します。また、リンクされた大人にはそのプロダクトの内容をまとめたダイジェストメールが定期的に届きます。既定では毎週で、頻度は本人が変更できます。いずれも生のレコードではなく集計済みのアクティビティを参照します。
アクティビティではないもの
この境界は意図的なものであり、明示しておく価値があります。
- k-ID はアクティビティを保存し集計します。その内容を解釈したり、モデレートしたりはしません。
- アクティビティの取り込みは、子どもをブロックしたり、権限を変更したり、介入を発動したりしません。スクリーンタイムの制限など、子どもの行動に対して作用する機能は別のものであり、アクティビティを参照します。
- アクティビティは受信専用です。アクティビティの Webhook イベントはありません。プロダクトが k-ID にプッシュし、レスポンスでレコードごとの結果を受け取ります。
スクリーンタイムのレポートはアクティビティの取り込みと同じ形です。アプリが利用状況を k-ID に報告するのに保護者の設定は不要で、保護者向けのコントロールはその上に載る別の任意のレイヤーです。スクリーンタイムの機能フラグを参照してください。
プライバシーと属性
属性は、信頼できる大人に内訳として見せたい観点、たとえばゲームのどのモードで時間が使われたかを表すためのものです。汎用のペイロードではありません。
そこから 2 つのルールが導かれます。まず、タイプは受け入れる属性キーを宣言し、それ以外のキーを含むレコードは拒否されます。次に、個人データに見える属性値は、そのまま拒否されます。個人データそのものではなく、自社システムで解決できる不透明な識別子を送信してください。
保持期間
k-ID は個々のアクティビティレコードを 90 日間保持します。信頼できる大人向けの画面が参照する集計済みアクティビティは、最長 2 年間保持されます。セッションまたはプレイヤーを消去すると、それに帰属するアクティビティも消去されます。
テストとライブ
アクティビティはプロダクト設定の他の部分と同じように動作します。プロダクトエディターで宣言したアクティビティタイプは、環境にプッシュするまでローカルのままであり、エンドポイントは API キーのモードが指す設定を提供します。タイプを宣言し、テストにプッシュし、テスト API キーで検証してからライブに公開してください。テストと公開をご覧ください。
次のステップ
- 使用状況の報告：アクティビティレコード、スクリーンタイムの使用状況、完了した購入のプッシュ、項目ごとの結果の処理、エンドツーエンドの検証。
- アクティビティタイプ：Compliance Studio でのタイプの宣言。
/activity/push：エンドポイントリファレンス。