PlayStream 事件模型参考
这些是 PlayFab 游戏服务 API 自动生成并写入事件管道的内置 PlayStream 事件。 除了这些事件,还可以使用 WriteEvents API 创建自己的自定义事件。
每个事件类型都有一组包含在事件数据(无论发送到何处)中的属性。 可以在游戏管理器的“PlayStream”选项卡中查看这些属性和生成规则,以便根据操作的值触发操作。
常规
entity_created
创建实体时触发此事件。entity_executed_cloud_script
在执行实体 CloudScript 函数时,可以选择触发此事件,方法是使用 GeneratePlayStreamEvent 选项调用 ExecuteCloudScript API,或者由选中“将结果发布为 PlayStream 事件”框的 PlayStream 事件操作触发。entity_files_set
文件附加到实体时会触发此事件。entity_language_updated
与实体关联的语言发生更改时会触发此事件。entity_logged_in
实体登录时会触发此事件。entity_objects_set
对象附加到实体时会触发此事件。entity_virtual_currency_balances_changed
实体的虚拟货币余额发生更改时会触发此事件。group_created 创建实体组时会触发此事件。
group_deleted
删除实体组时会触发此事件。group_members_added
将成员添加到实体组时会触发此事件。group_members_removed
从实体组中删除成员时会触发此事件。group_role_created
为组创建角色时会触发此事件。group_role_deleted
从组中删除角色时会触发此事件。group_role_members_added
将实体列表添加到组中的角色时会触发此事件。group_role_members_removed
从组中的角色中删除实体列表时会触发此事件。group_role_updated
在组中更新角色时会触发此事件。group_updated
更新实体组时会触发此事件。matchmaking_match_found
一组票证一起匹配时会触发此事件。matchmaking_ticket_completed
匹配票证达到完成状态时会触发此事件。matchmaking_user_ticket_completed
此事件将发送到已完成票证中的每个用户。matchmaking_user_ticket_invite
创建具有受邀用户的票证时会触发此事件。 事件将发送给受邀用户。multiplayer_server_build_deleted
删除多人游戏服务器生成时会触发此事件。multiplayer_server_build_region_status_changed
多人游戏服务器的生成区域状态发生更改时会触发此事件。multiplayer_server_build_region_updated
更新多人游戏服务器生成区域时会触发此事件。multiplayer_server_certificate_deleted
删除多人游戏服务器证书时会触发此事件。multiplayer_server_certificate_uploaded
上传多人游戏服务器证书时会触发此事件。multiplayer_server_create_build_initiated
启动多人游戏服务器生成时会触发此事件。multiplayer_server_game_asset_deleted
删除多人游戏服务器游戏资产时会触发此事件。multiplayer_server_requested
请求关闭多人游戏服务器时会触发此事件。multiplayer_server_state_changed
多人游戏服务器的状态发生更改时会触发此事件。multiplayer_server_vm_assigned
将虚拟机分配到多人游戏服务器版本时会触发此事件。multiplayer_server_vm_remote_user_created
创建多人游戏服务器虚拟机远程用户时会触发此事件。multiplayer_server_vm_remote_user_deleted
删除多人游戏服务器虚拟机远程用户时会触发此事件。multiplayer_server_vm_unassignment_started
从多人游戏服务器版本取消分配虚拟机时会触发此事件。multiplayer_server_vm_unhealthy
发现虚拟机运行不正常时会触发此事件。studio_created
创建工作室时会触发此事件。studio_user_added 用户接受工作室邀请时会触发此事件。
studio_user_invited
用户被邀请加入工作室时会触发此事件。studio_user_removed
从工作室中删除用户时会触发此事件。tenancy_connector_onboard
加入租户连接器时会触发此事件。studio_tier_updated
更新工作室层时会触发此事件。
目录
item_created
创建商品时触发此事件。item_deleted
删除商品时触发此事件。item_moderation_state_changed
当商品审查状态发生更改时,将触发此事件。item_publish_requested
启动发布时触发此事件。item_reported
报告商品时会触发此事件。item_updated
更新商品时会触发此事件。review_reported
报告审阅时触发此事件。reviews_takedown_requested
请求删除审阅时会触发的事件。
角色
character_consumed_item
角色使用其物品栏中的物品时会触发此事件。character_created
首次创建角色时会触发此事件。character_inventory_item_added
向某个角色授予物品时会触发此事件。character_statistic_changed
更改角色统计信息时会触发此事件。character_statistic_deleted
删除角色统计信息时会触发此事件。character_vc_item_purchased
角色使用虚拟货币进行购买时会触发此事件。character_virtual_currency_balance_changed
角色的虚拟货币余额更改时会触发此事件。
物品栏
items_added
将商品添加到清单时引发的事件。items_deleted
从清单中删除商品时引发的事件。items_purchased
从清单中购买商品时引发的事件。items_redeemed
从清单中兑换商品时引发的事件。items_subtracted
从清单中减去商品时引发的事件。items_transferred
在将商品转移到清单或从清单转移时引发的事件。items_updated
在清单中更新商品时引发的事件。
合作伙伴
display_name_filtered
按社区筛选筛选显示名称时会触发此事件。player_display_name_filtered
仅当存在事件的关联玩家 EntityId 时,才会在按社区筛选显示名称时触发此事件。player_photon_session_authenticated
当玩家连接到 Photon Cloud 应用程序并使用 Photon 自定义身份验证通过 PlayFab 进行身份验证时,会触发此事件。
玩家
auth_token_validated
单击电子邮件确认链接时会触发此事件。title_deleted_master_player
完成 GDPR 删除时会触发此事件。player_action_executed
当链接到分段更改的操作或在玩家上执行事件规则时,会触发此事件。player_ad_campaign_attribution
当玩家与付费购置活动匹配时,此事件由属性跟踪加载项触发。player_ad_closed
玩家关闭广告时会触发此事件。player_added_title
玩家为游戏创建新帐户时会触发此事件。 注意:每个游戏触发一次此事件,而不是每个发布者触发一次。player_ad_ended
玩家完成广告时会触发此事件。player_ad_opened
玩家打开广告时会触发此事件。player_ad_rewarded
玩家收到广告奖励时会触发此事件。player_ad_activity_valued
记录广告视图的报告值时会触发事件player_ad_started
玩家启动广告时会触发此事件。player_banned
禁止玩家时会触发此事件。player_changed_avatar
玩家的头像 URL 发生更改时会触发此事件。player_completed_password_reset
当玩家通过访问发送给他们的链接 URL 并选择新密码来完成密码重置过程时,会触发此事件。player_consumed_item
玩家使用其物品栏中的物品时会触发此事件。player_created
首次创建玩家帐户时会触发此事件。 注意:每个发布者仅触发此事件一次,而不是每个游戏触发一次。player_data_exported
导出玩家数据时会触发此事件。player_device_info
此事件在玩家登录后根据游戏的设置触发一次。player_displayname_changed
玩家的显示名称发生更改时会触发此事件。player_executed_cloudscript
在执行 CloudScript 函数时,可以选择触发此事件,方法是使用 GeneratePlayStreamEvent 选项调用 ExecuteCloudScript API,或者由选中“将结果发布为 PlayStream 事件”框的 PlayStream 事件操作触发。player_inventory_item_added
向玩家授予物品时会触发此事件。player_linked_account
当新的身份验证方法链接到玩家的帐户时,会触发此事件。player_logged_in
玩家登录时会触发此事件。player_password_reset_link_sent
向玩家发送重置其密码的链接时会触发此事件。player_paid_for_purchase
付款流程的第二步完成(即支付购买费用)时会触发此事件。player_ranked_on_leaderboard_version
当排行榜版本更改(例如排行榜统计版本递增)时,将针对排行榜上排名靠前的玩家触发此事件。 生成事件的排行榜条目的最大数目由“已发送的排行榜版本更改热门事件”标题限制控制。player_realmoney_purchase
当玩家进行实际购买并产生游戏收入时,会触发此事件。player_receipt_validation
当玩家尝试进行真实货币购买并且正在验证购买收据时,会触发此事件。player_redeemed_coupon
玩家兑换优惠券时会触发此事件。player_registered_push_notifications
玩家注册推送通知时会触发此事件。player_removed_title
删除游戏的玩家帐户时会触发此事件。 注意:每个游戏触发一次此事件,而不是每个发布者触发一次。player_reported_as_abusive
当玩家被另一个玩家举报滥用行为时,会触发此事件。player_set_profile_property
当 PlayFab 对玩家档案进行内部调整时,会触发此事件。player_started_purchase
玩家开始购买时会触发此事件。player_statistic_changed
玩家统计信息发生更改时会触发此事件。player_statistic_deleted
删除玩家统计信息时会触发此事件。player_tag_added
将标记添加到玩家档案时会触发此事件。player_tag_removed
从玩家档案中删除标记时会触发此事件。player_triggered_action_executed_cloudscript
当作为 PlayStream 操作的结果运行 CloudScript 函数,并选中“将结果发布为 PlayStream 事件”框时,会触发此事件。player_unlinked_account
身份验证方法与玩家帐户取消链接时会触发此事件。player_updated_contact_email
玩家更新其档案中的联系人电子邮件时会触发此事件。player_vc_item_purchased
玩家使用虚拟货币进行购买时会触发此事件。player_verified_contact_email
验证玩家的联系人电子邮件时会触发此事件。player_virtual_currency_balance_changed
玩家的虚拟货币余额更改时会触发此事件。sent_push_notification
发送推送通知或无法向玩家发送推送通知时,会触发此事件。sent_email
向玩家发送电子邮件或无法发送电子邮件时,会触发此事件。
会话
client_focus_change
每当应用程序进入或退出玩家设备聚焦时,都会触发此事件。client_session_start
新的客户端会话启动时会触发此事件。
游戏
title_aborted_task
中止任务实例时会触发此事件。title_added_cloudscript
将新的 CloudScript 上传到 PlayFab 时会触发此事件。title_api_settings_changed
游戏的 API 功能设置发生更改时会触发此事件。title_catalog_updated
更改目录时会触发此事件。title_client_rate_limited_alert
当单个 IP 地址对 PlayFab 生成过多的 API 调用并受到限制时,会触发此事件。title_completed_task
计划任务完成时会触发此事件title_created_task
创建任务时会触发此事件。title_deleted
删除游戏片头时会触发此事件。title_deleted_task
删除任务时会触发此事件。title_exceeded_limit
当游戏超出服务限制并收到错误时,会触发此事件。title_high_error_rate_alert
当游戏遇到高错误率时,会触发此事件。title_initiated_player_password_reset
当游戏为玩家启动帐户恢复过程时,会触发此事件。title_limit_changed
当游戏更改服务限制时,会触发此事件。title_news_updated
创建或更新标题新闻时会触发此事件。title_permission_policy_changed
当游戏的权限策略发生更新时,会触发此事件。title_profile_view_constraints_changed
当更改游戏的档案视图约束时,会触发此事件。title_published_cloudscript
CloudScript 的非活动修订已进入活动“实时”版本。title_queue_config_updated
更改队列配置时会触发此事件。title_requested_limit_change
游戏请求服务限制更改时会触发此事件。title_saved_survey
保存游戏调查时会触发此事件。title_scheduled_cloudscript_executed
计划任务运行 CloudScript 函数时会触发此事件。title_secret_key_changed
游戏添加或更新密钥时会触发此事件title_started_task
计划运行任务时会触发此事件。title_statistic_version_changed
当统计信息的版本更改,导致其排行榜重置时,会触发此事件。title_store_updated
更改存储时会触发此事件。title_updated_task
更新任务时会触发此事件。