メインコンテンツに移動

17件の投稿件のタグ「api」を含む

すべてのタグを見る

ウィジェットURLエンドポイントの法的文書オプション

ホストされたウィジェットURLエンドポイントで、呼び出しごとに法的文書のバリアントを指定できるようになりました。これは/age-gate/checkですでに利用可能なoptionsオブジェクトと同じです。これを使用すると、ウィジェットの同意フローで、プロダクトのデフォルトの代わりにプラットフォーム固有の利用規約、プライバシーポリシー、追加の法的リンク（例：Xbox、PlayStation、Steam）を表示できます。

新機能​

APIリファレンス（OpenAPI）​

  • /widget/generate-age-gate-url、/widget/generate-e2e-url、/widget/generate-direct-notices-url に、termsOfServiceDocument、privacyPolicyDocument、additionalLegalLinks を含む options オブジェクトが記載されました。各値は設定済みの追加法的リンクのVariant IDです。省略された文書はプロダクトのデフォルトにフォールバックします。
  • /widget/generate-direct-notices-url に options オブジェクトが追加されました（以前は jurisdiction のみを受け付けていました）。

CDK: セッションと権限​

  • 法的文書とデータ通知の提示: termsOfServiceDocument、privacyPolicyDocument、additionalLegalLinks がk-ID API全体で法的文書バリアントを指定する標準的なフィールド名であること、および各エンドポイントでの配置（年齢ゲートチェックとウィジェットURLエンドポイントでは options、/session/upgrade では materialChange）を記載しました。

Compliance Studio​

  • 追加の法的リンク: Variant IDのガイダンスが、/age-gate/check だけでなくウィジェットURLエンドポイントも指すようになりました。

ドキュメント​

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

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

新機能​

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

ドキュメント​

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

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

新機能​

  • Session.ApproverEmailUpdate。 保護者がメールアドレスの変更を確定したときに、子どものセッションごとに1件ずつ発行されます。これにより、そのプレイヤーに紐づけて保存している保護者のメールアドレスをサーバー側で更新できます。ペイロードにはid（セッション）、productId、oldEmail、newEmailが含まれます。
  • セッションはそれ以外の点では変更されません。 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で信頼できる大人が読む画面（定期的なダイジェストメールを含む）に反映します。アクティビティは受信専用です。

ドキュメント​

/session/delete の新しいモードで必須プロダクトの依存関係を保護

/session/delete が、削除対象のセッションに依存する他のプロダクトを保護（またはまとめて削除）できるようになりました。

新機能​

  • POST /session/delete の essentialDependencies。 あるプロダクトが他のプロダクトにとって*必須（essential）*として構成されている場合、そのセッションを削除すると、これまでは依存するプロダクトのセッションが、依拠していた同意の基盤を失ったまま静かに残されていました。新しいフィールドを使うと、デフォルトの取り消しと hardDelete の両方のパスで、代わりの動作を選択できます。
  • block は依存プロダクトを孤立させる代わりに削除を拒否します。 プレイヤーが削除対象のプロダクトに依存するアクティブなプロダクトをまだ保持している間、呼び出しは ESSENTIAL_DEPENDENTS_EXIST を返し、依存プロダクトのIDを明示します。有効化は不要です。
  • cascade は依存するセッションも削除し、その後に指定されたセッションを削除します。各セッションには独自のWebhookが送信され、ハード削除の場合は削除記録も個別に作成されます。指定していないセッションを削除するため、開発者ごとのオプトインです（有効化せずに送信すると FEATURE_DISABLED が返されます）。また、クライアントアクセストークンではなくサーバーサイドのAPIキーが必要です。
  • 既存のすべての呼び出しは影響を受けません。 フィールドを省略するか ignore を送信すると、/session/delete は従来どおりの動作を維持し、今後も変わりません。これはデフォルト変更の前段階ではなく、安定したオプトイン機能です。

ドキュメント​

メール年齢推定専用の年齢確認エンドポイント

メール年齢推定のみを方式として年齢確認を実行するための専用エンドポイント /age-verification/perform-email-age-estimation が追加されました。これは、既存の単一方式エンドポイント（ID、AgeKey、ConnectID）と並ぶものです。

新機能​

  • POST /age-verification/perform-email-age-estimation。 自動的な方式選択をバイパスし、メール年齢推定のみでユーザーを確認します。他の単一方式エンドポイントと同じリクエスト形式（jurisdiction、subject、criteria、および任意の options.redirectUrl / options.locale）を受け取り、id、url、shortUrl を返します。subject.email フィールドは任意です。省略した場合、ユーザーはホストされた確認ページでメールアドレスを入力します。
  • 18歳以上のシグナル。 メール年齢推定は、正確な年齢推定ではなく18歳以上のシグナルです。対象者が18歳以上であることのみを確認でき、それより若い年齢帯を区別することはできないため、リクエストの基準をこの能力に合わせることはお客様の責任です。
  • ステータスと結果は変更なし。 これまでどおり /age-verification/get-status をポーリングするか、Verification.Result webhook を処理してください。

ドキュメント​

Permanently erase a session with a new flag on /session/delete

/session/delete can now permanently erase a session instead of only revoking it.

What's new​

  • hardDelete on POST /session/delete. Set to true to permanently delete a player session and its embedded consent, scoped to the calling product. Unlike the default revoke (which is internally retained), this physically removes the record and can't be undone.
  • Opt-in per developer. Available only to developers explicitly enabled for hard delete. Setting hardDelete: true without enablement returns FEATURE_DISABLED.
  • Every existing call is unaffected. Omitting hardDelete, or setting it to false, behaves exactly as /session/delete always has: a reversible revoke.
  • In-flight challenges are failed too. Any pending challenge tied to that exact session is set to FAIL, scoped to that session only (other sessions for the same player are untouched).

Documentation​

クレジットカード専用の年齢確認エンドポイント

クレジットカードのみを方式として年齢確認を実行するための専用エンドポイント /age-verification/perform-credit-card-verification が追加されました。これは、既存の単一方式エンドポイント（ID、AgeKey、ConnectID）と並ぶものです。

新機能​

  • POST /age-verification/perform-credit-card-verification。 自動的な方式選択をバイパスし、クレジットカードのみでユーザーを確認します。他の単一方式エンドポイントと同じリクエスト形式（jurisdiction、subject、criteria、および任意の options.redirectUrl / options.locale）を受け取り、id、url、shortUrl を返します。
  • 成人（18歳以上）の保証。 クレジットカード確認は、正確な年齢推定ではなく成人であることの保証シグナルです。カードの所有が成人に限定されている法域に最も適しています。
  • ステータスと結果は変更なし。 これまでどおり /age-verification/get-status をポーリングするか、Verification.Result webhook を処理してください。結果は確認 method として credit-card を報告します。

ドキュメント​

自動年齢保証フロー向けのリダイレクトURL

/age-gate/check が、自動年齢保証チャレンジの完了後にk-IDが遷移するリダイレクトURLを受け入れるようになりました。これは、iframeベースの結果ハンドラーを使用できないトップレベルのブラウザハンドオフ（k-IDへ遷移して戻るモバイルwebviewなど）を想定したものです。

新機能​

  • options.playerAgeAssurance.redirectUrl。 /age-gate/check に http(s) URLまたはカスタムスキームのモバイルディープリンク（例：myapp://age-gate/return）を渡します。プレイヤーが CHALLENGE_AGE_GATE_AGE_ASSURANCE フローを完了または閉じると、k-IDはそのURLに challengeId、productId、sessionId（PASS の場合）、status（PASS または FAIL）をクエリパラメータとして付加してリダイレクトします。URL上の既存のクエリパラメータは保持されます。
  • スコープ。 このオプションは CHALLENGE_AGE_GATE_AGE_ASSURANCE に対してのみ有効です。CHALLENGE_PARENTAL_CONSENT は影響を受けず、引き続き信頼できる大人のフローを通じて返されます。
  • 結果はサーバー側で確認してください。 リダイレクトのクエリパラメータはUXのヒントです。アクセスを許可する前に、Challenge.StateChange webhook または /challenge/get-status を信頼できる情報源として扱ってください。

ドキュメント​