> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# player_banned

> player_banned event.

当玩家被封禁时，将触发此事件。

## 属性

| 名称            | 类型       | 描述                              |
| :------------ | :------- | :------------------------------ |
| BanExpiration | DateTime | 封禁的到期时间。如果是永久封禁，则该值为 null。      |
| BanId         | String   | 封禁的 ID。如果玩家之前曾被封禁，可用于跟踪唯一的封禁记录。 |
| BanReason     | String   | 玩家被封禁的原因。                       |
| PermanentBan  | Boolean  | 此封禁是否为永久封禁。                     |
| TitleId       | String   | 此玩家事件适用的 title 的 ID。            |

## 常用属性

所有 V1 PlayStream 事件都格式化为 JSON 对象，并共享以下常用属性：

| 名称             | 类型                                                                          | 描述                                                                                                                                                                                |
| :------------- | :-------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| EntityId       | String                                                                      | 此事件适用的实体（title、player 等）的标识符。                                                                                                                                                     |
| EntityType     | String                                                                      | 此事件适用的实体类型（player、title 等）。如果希望 PlayFab 对此实体执行操作，则 EntityType 必须为 'player'、'character' 或 'title'。当前 PlayFab 尚未解析的任何实体类型都必须加上命名空间前缀（例如 'com.mygame.guild'），因为 PlayFab 可能随时开始解析根实体。 |
| EventId        | String                                                                      | PlayFab 为此事件分配的唯一标识符。                                                                                                                                                             |
| EventName      | String                                                                      | 此事件的名称。                                                                                                                                                                           |
| EventNamespace | String                                                                      | 为此事件分配的命名空间。例如：'com.myprogram.ads'                                                                                                                                                |
| Source         | String                                                                      | 此 PlayStream 事件的源的名称；如果事件源自我方，则为 PlayFab。                                                                                                                                         |
| SourceType     | [SourceType](/services/playfab/api-references/events/data-types/sourcetype) | 此事件的源类型（PlayFab 合作伙伴、其他后端或来自 PlayFab API）。                                                                                                                                        |
| Timestamp      | DateTime                                                                    | 与此事件关联的时间（UTC）。                                                                                                                                                                   |