年齢ゲートを表示すべきかどうかをチェックする
管轄区域が年齢ゲートに求める要件を返します。プレイヤーの年齢が分かる前に年齢ゲートを構築できます。 プレイヤーが最初にアクセスした時点で呼び出してください。レスポンスには、年齢ゲートを表示する必要があるかどうか、その管轄区域で意味を持つ年齢、年齢保証が必要かどうか、および承認されている年齢収集方法が含まれます。
Authorization
api-key In: header
Query Parameters
プレイヤーの管轄区域。ISO 3166-1 alpha-2の国コードまたはISO 3166-2の細分区コードです。
^[A-z]{2}(-[A-z0-9]{1,3})?$年齢シグナルを提供するプラットフォーム。
Value in
- "k-id"
- "meta-horizon"
- "apple-ios"
- "google-play"
- "xbox"
プラットフォームから報告される最小年齢(年単位)。
プラットフォームから報告される最大年齢(年単位)。
プラットフォーム固有の年齢カテゴリ(例: "digital-youth"、"13-15"、"teen")。
プラットフォームからの宣言タイプ(例: Apple AgeRangeDeclaration または Google userStatus)。
k-idプラットフォームシグナル用の検証ID。
^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/age-gate/get-requirements?jurisdiction=US-CA"{ "shouldDisplay": true, "ageAssuranceRequired": true, "digitalConsentAge": 13, "civilAge": 18, "minimumAge": 0, "effectiveMinimumAge": 0, "accessAge": 0, "approvedAgeCollectionMethods": [ "date-of-birth", "age-slider", "platform-account" ], "permissions": [ { "name": "loot-boxes-paid-gameplay-impacting", "verifiedAgeThreshold": 18 } ]}{ "error": "INVALID_INPUT", "errorMessage": "Invalid jurisdiction"}年齢ゲートをチェックする。 POST
年齢ゲートのチェックを実行し、プレイヤーがゲームに入れるかどうかを判定します。必要な場合は年齢チャレンジを作成します。 プレイヤーの管轄区域とあわせて、`dateOfBirth`、`age`、`kuid` のいずれか1つだけを指定してください。1つも指定しない場合、または複数を指定した場合は不正なリクエストになります。`kuid` を指定した場合は、保護者が登録済みの年齢が使用され、作成されるセッションまたはチャレンジはそのユーザーに紐付けられます。 レスポンスの `status` が次の操作を決めます。`PASS` はセッションが返され、プレイヤーはそのまま続行できます。`CHALLENGE` はチャレンジが返され、先に完了させる必要があります。`PROHIBITED` はプレイヤーがプロダクトの最低年齢に達していないため、いずれも返されません。 返されたチャレンジのワンタイムパスワードには有効期限があります。表示する直前に `/challenge/generate-otp` を呼び出し、チャレンジが進行中になるまで定期的に再生成してください。
カテゴリに対応する年齢範囲を取得する POST
プラットフォームから提供された年齢カテゴリーを、指定した管轄区域で該当する年齢範囲に変換します。 管轄区域と、提供元プラットフォームおよびそのカテゴリーを示す `platform` の年齢シグナルを指定してください。各プラットフォームは独自の粗いカテゴリーを定義しているため、k-IDがそのカテゴリーを、当該管轄区域のルールにおいてプレイヤーが該当しうる年齢範囲に対応付けます。