メインコンテンツに移動

6件の投稿件のタグ「webhooks」を含む

すべてのタグを見る

年齢確認の結果にベンダー名が含まれるようになりました

Verification.ResultウェブフックとGET /age-verification/get-statusが、確認メソッドを実行したベンダーを示すproviderを返すようになりました。

新機能

  • ウェブフックとエンドポイントの両方にprovider methodが存在する場合は常に含まれるため、完了した確認について、どのベンダーが結果を出したのかがわかります。
  • メソッドからベンダーは一意に決まりません。 age-estimation-scanは複数のベンダーが提供しており、credit-cardは決済が確認の代わりになった場合にレコードマーチャントを示します。providerはご自身のログや分析に利用し、アクセス制御の判断には使用しないでください。
  • それ以外に変更はありません。 他のフィールドの形式と存在条件はこれまでどおりです。

ドキュメント

保護者のメールアドレス変更を知らせる新しいウェブフック

保護者はk-IDアカウントのメールアドレスを変更できます。新しいSession.ApproverEmailUpdateウェブフックが、その変更をあなたのプロダクトに知らせます。

新機能

  • Session.ApproverEmailUpdate 保護者がメールアドレスの変更を確定したときに、子どものセッションごとに1件ずつ発行されます。これにより、そのプレイヤーに紐づけて保存している保護者のメールアドレスをサーバー側で更新できます。ペイロードにはid(セッション)、productIdoldEmailnewEmailが含まれます。
  • セッションはそれ以外の点では変更されません。 ACTIVEのまま、同じsessionIdと権限を保持し、子どもは中断なく利用を続けられます。プレイヤーを年齢確認や同意のフローに戻さないでください。
  • アクティブなセッションを持つ子どものみが対象です。 あなたのプロダクトにアクティブなセッションがない子どもには移す対象がないため、イベントは発行されません。その子どもが後からセッションを取得する場合、そのセッションは新しいアドレスに対して作成されます。
  • エンドポイントごとにオプトインが必要です。 Compliance StudioのプロダクトのDeveloper Settingsページで、対象のウェブフックエンドポイントにSession.ApproverEmailUpdateを選択してください。選択しない限り、k-IDは配信も試みずエラーも返さずにイベントを破棄します。この項目は、組織で保護者のメールアドレス変更が有効になっている場合にのみ一覧に表示されます。

ドキュメント

トランザクションと支払いによる確認のガイド

トランザクションと支払いによる確認が、開発者ハブで完全にドキュメント化されました。

新機能

  • トランザクション。 プロダクトは子どもの購入をk-IDに報告し、k-IDはそれをリンクされた保護者に、Family Connectの子どもごとの購入ビューとして、また定期的なアクティビティのダイジェストとして提示します。請求の前に保護者を介在させたい場合には、購入の承認リクエストが先にその承認を求め、結果はTransaction.PurchaseApprovalResultウェブフックとして届きます。どちらの部分も、Compliance Studioでプロダクトごとに設定します。
  • 支払いによる確認。 完了したカード決済は、保護者の同意ステップの代わりになり、クレジットカード確認方法を1対1で反映します。その方法がセッションに対して有効な場面でまったく同じように尊重され、クレジットカードの資金のみが対象で、それ以外のあらゆる場面では保護者が標準の検証済み保護者同意フローをこれまでどおり完了します。

ドキュメント

検証済み保護者リンク、スクリーンタイム、アクティビティ取り込みのガイド

3つのペアレンタルコントロール機能が、開発者ハブで完全にドキュメント化されました。検証済み保護者リンク、スクリーンタイム、アクティビティの取り込みです。

新機能

  • 検証済み保護者リンク(VPL)。 プレイヤーは自分の保護者をプロダクトに招待できます。保護者が本人確認を完了すると、そのプレイヤーのコントロール(例えばスクリーンタイム)を確認し設定できるようになります。VPLはゲートではなくリンクです。何もブロックされず、保護者が承諾したかどうかにかかわらずプロダクトは動作し続けます。Session.Unlinkウェブフックが、どちらかの側がリンクを解除したことを知らせます。VPLはデベロッパー組織単位で有効化されます。
  • スクリーンタイム。 保護者はFamily Connectで、子どもの1日の制限、静かな時間、休憩リマインダーを設定します。プロダクトは利用状況を報告し、k-IDが返す判定に従います。k-IDはルールを保持し、子どもごと・1日ごとに利用時間を数え、スケジュールを評価します。各制限の前には警告イベントが届くため、プレイヤーは保存できる区切りに到達できます。また、子どもはスクリーンタイムの延長をリクエストして、より多くの時間を求めることができます。
  • アクティビティの取り込み。 プロダクトは、Compliance Studioでプロダクトごとに宣言したアクティビティタイプに対してレコードをプッシュすることで、子どもの行動を報告します。k-IDはそれらのレコードを保存・集計し、Family Connectで信頼できる大人が読む画面(定期的なダイジェストメールを含む)に反映します。アクティビティは受信専用です。

ドキュメント

FAILステータスのWebhookイベントにageCategoryが含まれるようになりました

年齢データが利用可能な場合、Verification.Result WebhookイベントのFAILステータスイベントにageCategoryフィールドが含まれるように更新しました。

新機能

FAILステータスイベントでのageCategory

ageCategoryフィールドは、次の条件を満たす場合、Verification.Result WebhookイベントのFAILステータスに含まれるようになりました:

  • failureReasonage-criteria-not-met
  • 年齢データが利用可能(age.lowage.highの両方が存在)

これにより、年齢基準を満たさないために検証が失敗した場合でも、ユーザーの年齢カテゴリに関するより完全な情報が提供され、明確なアクセス制御の境界を維持しながら、より優れた分析とログ記録が可能になります。

ドキュメントの更新

Verification.Resultドキュメントがこの変更を反映するように更新されました:

  • フィールドテーブル: FAILステータスでageCategoryが存在するタイミングを明確にするために説明を更新
  • 主な違いテーブル: WebhookイベントとAPIエンドポイントでageCategoryが存在するタイミングを明確化
  • FAILステータスのフィールド存在ルール: 特定の条件でageCategoryを「場合によって含まれる」として表示するように更新
  • 完全なフィールドマトリックス: WebhookのFAILステータスでageCategoryを「sometimes²」として表示するように更新
  • ペイロードの例: 新しい動作を示すためにFAILステータスの例にageCategoryを追加
  • 実装チェックリスト: FAILステータスでageCategoryを処理するためのガイダンスを更新
  • 実装ノート: PASSとFAILの両方のステータスでのageCategoryの動作を明確化

重要な注意事項

  • アクセス制御: FAILステータスイベントでageCategoryが存在する場合でも、アクセス制御の決定に決して使用しないでください。アクセスを決定するには、常にstatusフィールドを使用してください。
  • 一貫性: この更新はWebhookイベントとAPIエンドポイントの応答の両方に適用されます
  • 言語サポート: すべての言語バージョン(英語、日本語、簡体字中国語、韓国語)が更新されました

次のステップ

  • 更新されたVerification.Resultドキュメントを確認してください
  • 必要に応じて、FAILステータスイベントでageCategoryを処理するように統合を更新してください
  • 覚えておいてください: ステータスがFAILの場合、フィールドが存在する場合でも、アクセス制御にageCategoryを使用しないでください。分析、ログ記録、または情報提供の目的でのみ使用してください。

エッジケース処理の例

年齢確認ガイドに包括的なエッジケース処理の例を追加し、フィールド存在ルールを明確にするために検証イベント契約を更新しました。

新機能

エッジケース処理の例

ウォーターフォールフローガイドに、検証エッジケースを処理するための詳細なコード例が追加されました。各例は、誤った処理パターンと正しい処理パターンの両方を示しています。

新しい例には以下が含まれます:

  • 部分的な試行(最大試行回数超過): ユーザーが確定的な年齢決定なしにすべての確認試行を使い果たした場合のmax-attempts-exceeded失敗理由の適切な処理
  • 不審な活動の検出: 適切なレート制限とセキュリティ対策を含む、fraudulent-activity-detected失敗理由のセキュリティ重視の処理
  • 完全なエッジケースハンドラ: すべてのパターンを一緒に示す包括的なTypeScriptの例

すべての例は、完全なフィールド存在ルールについて検証イベント契約に直接リンクしています。

検証イベント契約の更新

検証イベント契約が更新され、フィールド存在ルールが明確になりました:

  • ageageCategoryはPASSステータスの場合常に存在: PASSをもたらすすべての確認方法は、年齢情報と年齢カテゴリの両方を提供します。PASSステータスの結果を処理する際は、条件チェックなしでこれらのフィールドに安全にアクセスできます。
  • 年齢範囲の明確化: 確認方法によって正確な年齢が提供されない場合、age.lowは確認に必要な閾値の最小年齢となり、age.highは100となります。

更新されたドキュメント