メインコンテンツに移動

アクティビティタイプ

アクティビティタイプは、プロダクトが k-ID に報告する出来事の 1 種類と、その測定方法を宣言するものです。プロダクトは宣言済みのタイプに対してレコードをプッシュし、k-ID はそれ以外を指定したレコードを拒否します。タイプの宣言は自分で行う設定変更なので、新しい種類のアクティビティを追加するのに k-ID のエンジニアは必要ありません。

概念についてはアクティビティを、API についてはアクティビティの取り込みをご覧ください。

アクティビティタブを開く​

プロダクトエディターでプロダクトを開き、アクティビティタブを選択します。このタブには、そのプロダクトのアクティビティタイプと、組織でスクリーンタイムを利用できる場合はスクリーンタイムの設定が含まれます。

アクティビティを利用するには、k-ID に連絡してこの機能を組織で有効化してもらってください。

タイプを宣言する​

  1. アクティビティタブで、アクティビティタイプを追加を選択します。新しい項目が表示され、保存するまでアクションが必要と表示されます。

  2. ラベルを入力します。これは信頼できる大人が Family Connect で目にする、人が読むための名前です。コードのためではなく保護者のために、chat_time_v2 ではなくチャットの利用時間のように記述してください。最大 128 文字です。

  3. メトリックタイプを選択します。これにより、そのタイプでプロダクトがプッシュするすべての値の形式が決まります。

    選択肢プロダクトがプッシュする value
    時間（秒）{ "seconds": 1800 }
    通貨（最小単位 + ISO）{ "amount": 999, "currency": "USD" }
    カウント（整数）{ "count": 7 }
    ゲージ（浮動小数）{ "number": 0.85 }
    ブール{ "bool": true }

  4. 必要に応じて許可された属性キーを追加します。ここに追加したキーは、このタイプのレコードに付与できるキーになります。キーは小文字で始まり、小文字、数字、アンダースコアのみを含み、最大 64 文字、1 タイプあたり最大 32 個です。

  5. 保存を選択します。

警告

メトリックタイプは変更できません。すでにそのタイプで保存されたレコードはその形式で検証されているため、タイプの作成後は変更できません。別の形式が必要な場合は、新しいタイプを作成してください。

プロダクトからタイプを参照する​

各アクティビティタイプにはキーがあり、プロダクトはレコードの type フィールドにそのキーを送信します。

キーはタイプを追加したときに k-ID が生成する UUID です。ユーザーが選ぶことも編集することもできません。タイプを保存すると、ラベルフィールドの横にコピー用のコントロールが表示されます。これを使ってキーをコピーし、その値を統合に貼り付けてください。

ヒント

ラベルから推測したり入力し直したりせず、毎回 Compliance Studio からキーをコピーしてください。キーは生成された UUID であり、組み立て直す値ではありません。

1 つだけ予約済みのキーがあります。screentime_usage は k-ID のスクリーンタイムのエンドポイントに属し、そこから利用セグメントが記録されます。プロダクトがこのキーでレコードをプッシュすることはありません。

編集と削除​

タイプのラベルと許可された属性キーは、作成後に変更できます。いずれも、変更が環境に反映された後にプッシュされたレコードから有効になります。

許可された属性キーを削除すると、そのキーを含むレコードは attribute_key_not_allowed の理由で拒否されるようになります。先に統合側からキーを外し、その後でタイプから削除してください。

タイプを削除すると宣言がなくなるため、そのキーでプッシュされたレコードは unknown_type の理由で拒否されるようになります。削除する前に、そのタイプのプッシュを停止してください。

上限​

項目上限
プロダクトあたりのアクティビティタイプ50
タイプあたりの許可された属性キー32
ラベルの長さ128 文字
属性キーの長さ64 文字

変更の公開​

アクティビティタイプは、プロダクト設定の他の部分と同じ流れをたどります。追加したタイプはプッシュするまでローカルのままであり、各環境はそこにプッシュされた設定を提供します。テストにプッシュしてテスト API キーで検証し、その後ライブに公開してください。テストと公開をご覧ください。

API キーが対象とする環境にまだ届いていないタイプを指定したレコードは unknown_type で拒否されます。新しいタイプが機能しないように見える原因として最も多いのがこれです。