Endpointsセッション

セッションを取得する

`sessionId`、またはプロダクトとあわせた `kuid` で指定した、既存のセッションを返します。 `etag` を指定すると条件付き取得になります。そのetagの発行後に変更があった場合のみセッションが返され、変更がない場合は `NOT_MODIFIED` が返されます。セッション全体を取得し直すのではなく、etagを使ってポーリングしてください。 `ACTIVE` はプレイヤーがプロダクトの要件を満たしていることを意味し、レスポンスには現在有効な権限が含まれます。 etagはレスポンス全体を対象としており、プロダクトと管轄区域の設定から導出される `permissions`、`ageStatus`、`ageCategory` も含みます。そのため、セッション自体が更新されていなくても、設定を変更するとetagは変わります。 A session that has ended returns HTTP 400 with `NOT_FOUND`, as if it never existed. A session ends when a parent removes access in Family Connect or when you delete it with `/session/delete`. Each one sends a `Session.Delete` webhook whose `revocation` object says who ended the session (`actor`) and why (`reason`). These values are open sets.

GET
/session/get
AuthorizationBearer <token>

In: header

Query Parameters

sessionId?string

プレイヤーセッションのセッションID

Match^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$
Formatuuid
kuid?string

プレイヤーのk-IDユーザーID。

Match^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$
Formatuuid
etag?string

以前のセッション応答のetag

Response Body

application/json

application/json

curl -X GET "https://example.com/session/get"
{  "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672",  "kuid": "12b9fa0e-6d6d-4903-a1fc-f2233027b71d",  "ageStatus": "LEGAL_ADULT",  "ageCategory": "adult",  "etag": "e889efb9e8a985308e82bed78c5aef7f37f50cf36b7337bf654980d0bab7a574",  "status": "ACTIVE",  "dateOfBirth": "2005-04-15",  "jurisdiction": "US-CA",  "managedBy": "PLAYER",  "permissions": [    {      "name": "text-chat-public",      "enabled": false,      "managedBy": "GUARDIAN"    },    {      "name": "text-chat-private",      "enabled": true,      "managedBy": "PLAYER"    },    {      "name": "forums",      "enabled": false,      "managedBy": "PROHIBITED"    }  ],  "allowances": [    {      "name": "3516-7b2e",      "numericalValue": 5,      "type": "numerical"    },    {      "name": "63d3-90ac",      "selectionValue": "733c-ca11",      "type": "selection"    }  ]}

セッションを削除する POST

セッションIDを指定してプレイヤーセッションを削除します。対象のセッションは呼び出し元のプロダクトに属している必要があります。 デフォルトでは論理削除です。セッションは revoked としてマークされ、以後クエリできなくなり、プレイヤーIDは再利用可能になりますが、レコード自体は保持されます。 **この操作は取り消せません。** `hardDelete` に `true` を指定した場合は、セッションとそれに含まれる同意情報を完全に削除します。元に戻すことはできません。ハード削除を明示的に有効化されたデベロッパーのみが利用できます。 A delete here sends a `Session.Delete` webhook with a `revocation` of `actor: developer` and `reason: deleted-by-developer`, or `erased-by-developer` for a hard delete. Treat every `Session.Delete` as "no session", and accept actors and reasons you don't know.

保護者管理セッション権限を更新する POST

セッションのうち、保護者が管理できる権限を更新します。 プロダクトが保護者に公開していない権限は、エラーにはならず無視されます。そのため、リクエストで指定した権限より少ない数だけが変更される場合があります。レスポンスは更新後の権限セットです。リクエストがそのまま適用されたと想定せず、レスポンスを確認してください。