メインコンテンツへスキップ
POST
Write Character Event

承認

X-SecretKey
string
header
必須

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

ボディ

application/json

This API is designed to write a multitude of different event types into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any character-based event. The created event will be locked to the authenticated title.

This API is designed to write a multitude of different event types into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any character-based event. The created event will be locked to the authenticated title.

CharacterId
string
必須

Unique PlayFab assigned ID for a specific character owned by a user

EventName
string
必須

The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).

PlayFabId
string
必須

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Body
object

Custom event properties. Each property consists of a name (string) and a value (JSON object).

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Timestamp
string

The time (in UTC) associated with this event. The value defaults to the current time.

レスポンス

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
例:
最終更新日 2026年10月6日