PlayFab 的 PlayStream 事件模型参考

以下是由 PlayFab Game Services API 自动生成并写入事件管道的内置 PlayStream 事件。除这些事件外，你还可以使用 WriteEvents API 创建自己的自定义事件。 每种事件类型都有一组属性，作为事件数据的一部分被包含在事件发送到的任何地方。你可以在 Game Manager 的 PlayStream 选项卡中查看这些属性，并根据它们的值构建触发操作的规则。

​

AdPlacement

• player_ad_closed
  玩家关闭广告时触发此事件。
• player_ad_ended
  玩家结束广告时触发此事件。
• player_ad_opened
  玩家打开广告时触发此事件。
• player_ad_rewarded
  玩家获得广告奖励时触发此事件。
• player_ad_started
  玩家开始广告时触发此事件。

​

Addons

• title_addon_changed
  游戏加载项更改时触发此事件。

​

ApiAccessPolicy

• title_api_settings_changed
  游戏的 API 功能设置更改时触发此事件。
• title_permission_policy_changed
  游戏的权限策略发生更新时触发此事件。

​

CloudScript

• entity_executed_cloud_script
  执行 Entity CloudScript 函数时可选择性地触发此事件，可以通过使用 GeneratePlayStreamEvent 选项调用 ExecuteCloudScript API，或者通过勾选”Publish results as a PlayStream Event”框的 PlayStream 事件操作触发。
• player_executed_cloudscript
  执行 CloudScript 函数时可选择性地触发此事件，可以通过使用 GeneratePlayStreamEvent 选项调用 ExecuteCloudScript API，或者通过勾选”Publish results as a PlayStream Event”框的 PlayStream 事件操作触发。
• player_triggered_action_executed_cloudscript
  当 CloudScript 函数作为 PlayStream 操作的结果运行，并勾选了”Publish results as a PlayStream Event”框时触发此事件。
• title_added_cloudscript
  当有新的 CloudScript 上传到 PlayFab 时触发此事件。
• title_published_cloudscript
  非活动版本的 CloudScript 已成为活动的”实时”版本。
• title_scheduled_cloudscript_executed
  当 CloudScript 函数由计划任务运行时触发此事件。
• cloudscript_executed
  执行 CloudScript 函数时触发此事件。

​

DeveloperIdentity

• studio_created
  创建工作室时触发此事件。
• studio_user_added 用户接受工作室邀请时触发此事件。
• studio_user_invited
  邀请用户加入工作室时触发此事件。
• studio_user_removed
  用户从工作室中移除时触发此事件。

​

Experimentation

• exclusion_group_created 创建排除组时触发此事件。
• exclusion_group_deleted 删除排除组时触发此事件。
• exclusion_group_updated 更新排除组时触发此事件。
• experiment_created 创建实验时触发此事件。
• experiment_deleted 删除实验时触发此事件。
• experiment_start_requested 请求启动实验时触发此事件。
• experiment_stop_requested 请求停止实验时触发此事件。
• experiment_updated 更新实验时触发此事件。
• player_experiment_variants_changed 玩家的实验变体发生变化时触发此事件。

​

Extension

• title_aborted_task
  任务实例被中止时触发此事件。
• title_completed_task
  计划任务完成时触发此事件
• title_created_task
  创建任务时触发此事件。
• title_deleted_task
  删除任务时触发此事件。
• title_exceeded_limit
  游戏超出服务限额并收到错误时触发此事件。
• title_limit_changed
  游戏更改服务限额时触发此事件。
• title_started_task
  任务被计划运行时触发此事件。
• title_updated_task
  更新任务时触发此事件。
• export_completed
  导出操作完成时触发此事件。

​

Functions

• function_executed
  执行函数时触发此事件。
• function_registered
  注册函数时触发此事件。
• function_unregistered
  取消注册函数时触发此事件。
• player_triggered_action_executed_function
  当函数作为 PlayStream 操作的结果运行时触发此事件。
• title_scheduled_function_executed
  当函数由计划任务运行时触发此事件。

​

Groups

• group_created 创建实体组时触发此事件。
• 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
  更新实体组时触发此事件。
• members_added
  向组添加成员时触发此事件。
• members_removed
  从组中移除成员时触发此事件。
• members_role_updated
  组中成员的角色更新时触发此事件。
• player_updated_membership
  玩家的成员资格更新时触发此事件。
• role_updated
  更新角色时触发此事件。

​

Telemetry

• apikey_activated
  激活 API 密钥时触发此事件。
• apikey_created
  创建 API 密钥时触发此事件。
• apikey_deactivated
  停用 API 密钥时触发此事件。
• apikey_deleted
  删除 API 密钥时触发此事件。

​

TitleCommunications

• player_registered_push_notifications
  玩家注册推送通知时触发此事件。
• sent_email
  向玩家发送电子邮件或发送失败时触发此事件。
• sent_push_notification
  向玩家发送推送通知或发送失败时触发此事件。
• email_sent
  发送电子邮件时触发此事件。
• push_notification_sent
  发送推送通知时触发此事件。

​

General

• entity_virtual_currency_balances_changed
  实体的虚拟货币余额发生变化时触发此事件。
• tenancy_connector_onboard
  加载租户连接器时触发此事件。
• studio_tier_updated
  工作室层级更新时触发此事件。

​

Matchmaking

• title_queue_config_updated
  队列配置更改时触发此事件。
• match_found
  找到匹配时触发此事件。
• ticket_completed
  票据完成时触发此事件。
• user_ticket_invited
  用户被邀请加入票据时触发此事件。

​

Multiplayer Servers

• build_alias_created
  创建多人服务器构建别名时触发此事件。
• build_alias_deleted
  删除多人服务器构建别名时触发此事件。
• build_alias_updated
  更新多人服务器构建别名时触发此事件。
• build_deleted
  删除多人服务器构建时触发此事件。
• build_region_status_changed
  多人服务器构建区域状态更改时触发此事件。
• build_region_updated
  更新多人服务器构建区域时触发此事件。
• build_region_utilization
  显示每个区域中构建的服务器利用率时触发此事件。
• certificate_deleted
  删除多人服务器证书时触发此事件。
• certificate_uploaded
  上传多人服务器证书时触发此事件。
• crash_detected
  在正在终止的服务器上找到崩溃转储时触发此事件。
• create_build_initiated
  发起多人服务器构建时触发此事件。
• enabled_for_title
  游戏启用 PlayFab 服务器时触发此事件
• game_asset_deleted
  删除多人服务器游戏资产时触发此事件。
• monitoring_output_saved
  监视应用程序的输出已保存并可以下载时触发此事件。
• secret_added
  添加多人服务器机密时触发此事件。
• secret_deleted
  删除多人服务器机密时触发此事件。
• server_requested
  请求多人服务器时触发此事件。
• server_state_changed
  多人服务器状态更改时触发此事件。
• vm_assigned
  将虚拟机分配到多人服务器构建时触发此事件。
• vm_game_certificates_deployed
  在游戏虚拟机中部署游戏证书时触发此事件。
• vm_remote_user_created
  创建多人服务器虚拟机远程用户时触发此事件。
• vm_remote_user_deleted
  删除多人服务器虚拟机远程用户时触发此事件。
• vm_state_change
  多人虚拟机状态更改时触发此事件。
• vm_unassignment_started
  从多人服务器构建取消分配虚拟机时触发此事件。
• vm_unhealthy
  发现虚拟机不健康时触发此事件。

​

CatalogV1

• title_catalog_updated
  目录更改时触发此事件。
• title_store_updated
  商店更改时触发此事件。

​

CatalogV2

• item_created
  创建物品时触发此事件。
• item_deleted
  删除物品时触发此事件。
• item_moderation_state_changed
  物品审核状态更改时触发此事件。
• item_publish_requested
  开始发布时触发此事件。
• item_purchased
  购买物品时触发此事件。
• item_reported
  举报物品时触发此事件。
• item_updated
  更新物品时触发此事件。
• review_reported
  举报评价时触发此事件。
• reviews_takedown_requested
  请求删除评价时触发此事件。

​

Character

• character_consumed_item
  角色从其库存中消耗物品时触发此事件。
• character_inventory_item_added
  向角色授予物品时触发此事件。
• character_vc_item_purchased
  角色使用虚拟货币购买时触发此事件。
• character_virtual_currency_balance_changed
  角色的虚拟货币余额发生变化时触发此事件。

​

Inventory

• items_added
  向库存添加物品时引发的事件。
• items_clawback_completed
  物品追回操作完成时触发此事件。
• items_clawback_reversal_completed
  物品追回撤销操作完成时触发此事件。
• items_deleted
  从库存中删除物品时引发的事件。
• items_expired
  库存中的物品过期时触发此事件。
• items_purchased
  从库存中购买物品时引发的事件。
• items_redeemed
  兑换物品到库存时引发的事件。
• items_subtracted
  从库存中减去物品时引发的事件。
• items_transferred
  物品被转入或转出库存时引发的事件。
• items_updated
  库存中的物品更新时引发的事件。
• marketplace_transaction_redeemed
  兑换市场交易时触发此事件。

​

GameSave

• gamesave_version_finalized
  当游戏存档版本在所有文件完全上传后完成最终确定时触发此事件。
• gamesave_version_marked_known_good
  游戏存档版本被标记为已知良好时触发此事件。

​

Networking

• client_authentication_completed
  客户端身份验证完成时触发此事件。
• client_connected_to_network
  客户端连接到网络时触发此事件。
• client_initialization_completed
  客户端初始化完成时触发此事件。
• client_network_created
  创建客户端网络时触发此事件。
• client_network_destroyed
  销毁客户端网络时触发此事件。
• client_network_information_received
  收到客户端网络信息时触发此事件。
• client_request_failed
  客户端请求失败时触发此事件。
• data_received_by_clients
  客户端接收到数据时触发此事件。
• data_sent_by_clients
  客户端发送数据时触发此事件。
• moderation_service_request_count
  报告审核服务请求计数时触发此事件。
• player_disconnected_from_network
  玩家从网络断开连接时触发此事件。
• unity_client_initialization_completed
  Unity 客户端初始化完成时触发此事件。
• unreal_client_initialization_completed
  Unreal 客户端初始化完成时触发此事件。

​

Partner

• display_name_filtered
  当显示名称被 community sift 过滤时触发此事件。
• player_display_name_filtered
  仅当事件存在关联的玩家 EntityId 时，才会在显示名称被 community sift 过滤时触发此事件。
• player_photon_session_authenticated
  当玩家连接到 Photon Cloud 应用程序并使用 Photon 自定义身份验证进行 PlayFab 身份验证时触发此事件。

​

Player

• player_action_executed
  当与分段更改或事件规则关联的操作在玩家上执行时触发此事件。
• player_ad_campaign_attribution
  当归因跟踪加载项将玩家与付费获取活动匹配时触发此事件。
• player_consumed_item
  玩家从其库存中消耗物品时触发此事件。
• player_inventory_item_added
  向玩家授予物品时触发此事件。
• player_paid_for_purchase
  支付过程的第二步完成、支付购买时触发此事件。
• player_realmoney_purchase
  玩家进行真实货币购买并为游戏产生收入时触发此事件。
• player_receipt_validation
  玩家尝试进行真实货币购买并且购买收据正在验证时触发此事件。
• player_redeemed_coupon
  玩家兑换优惠券时触发此事件。
• player_set_profile_property
  PlayFab 对玩家个人资料进行内部调整时触发此事件。
• player_started_purchase
  玩家开始购买时触发此事件。
• player_vc_item_purchased
  玩家使用虚拟货币购买时触发此事件。
• player_virtual_currency_balance_changed
  玩家的虚拟货币余额发生变化时触发此事件。

​

PlayerIdentity

• auth_token_validated
  点击电子邮件确认链接时触发此事件。
• character_created
  首次创建角色时触发此事件。
• entity_created
  创建实体时触发此事件。
• entity_logged_in
  实体登录时触发此事件。
• player_added_title
  玩家为游戏创建新帐户时触发此事件。注意：此事件按游戏触发一次，而不是按发布者触发一次。
• player_banned
  玩家被封禁时触发此事件。
• player_changed_avatar
  玩家的头像 URL 更改时触发此事件。
• player_completed_password_reset
  玩家通过访问发送给他们的链接 URL 并选择新密码完成密码重置流程时触发此事件。
• player_created
  首次创建玩家帐户时触发此事件。注意：此事件按发布者触发一次，而不是按游戏触发一次。
• player_data_exported
  导出玩家数据时触发此事件。
• player_device_info
  根据你的游戏设置，玩家登录后触发一次此事件。
• player_displayname_changed
  玩家的显示名称更改时触发此事件。
• player_linked_account
  将新的身份验证方法链接到玩家帐户时触发此事件。
• player_logged_in
  玩家登录时触发此事件。
• player_password_reset_link_sent
  向玩家发送重置密码的链接时触发此事件。
• player_removed_title
  移除游戏的玩家帐户时触发此事件。注意：此事件按游戏触发一次，而不是按发布者触发一次。
• player_reported_as_abusive
  玩家被其他玩家举报为滥用行为时触发此事件。
• player_tag_added
  向玩家个人资料添加标签时触发此事件。
• player_tag_removed
  从玩家个人资料中移除标签时触发此事件。
• player_unlinked_account
  从玩家帐户取消链接身份验证方法时触发此事件。
• player_updated_contact_email
  玩家更新其个人资料上的联系电子邮件时触发此事件。
• player_verified_contact_email
  为玩家验证联系电子邮件时触发此事件。
• title_deleted_master_player
  GDPR 删除完成时触发此事件。
• title_initiated_player_password_reset
  游戏为玩家发起帐户恢复流程时触发此事件。
• title_profile_view_constraints_changed
  游戏的个人资料查看约束更改时触发此事件。
• entity_deleted
  删除实体时触发此事件。
• logged_in_to_title
  用户登录游戏时触发此事件。
• player_authenticated
  玩家通过身份验证时触发此事件。
• player_custom_properties_changed
  玩家的自定义属性更改时触发此事件。
• player_identity_link_added
  添加玩家身份链接时触发此事件。
• player_identity_link_removed
  移除玩家身份链接时触发此事件。
• player_updated_login_email
  玩家更新其登录电子邮件时触发此事件。

​

PlayerProfile

• entity_files_set
  将文件附加到实体时触发此事件。
• entity_language_updated
  与实体关联的语言更改时触发此事件。
• entity_objects_set
  将对象附加到实体时触发此事件。
• access_policy_updated
  更新访问策略时触发此事件。
• avatar_url_updated
  头像 URL 更新时触发此事件。
• contact_email_updated
  联系电子邮件更新时触发此事件。
• files_changed
  文件更改时触发此事件。
• language_updated
  语言设置更新时触发此事件。
• objects_updated
  对象更新时触发此事件。

​

PlayStream

• action_executed
  执行操作时发出此事件。
• action_failed
  操作执行失败时发出此事件。

​

Segmentation

• segment_entered
  个人资料进入分段时触发此事件。
• segment_exited
  个人资料退出分段时触发此事件。
• api_operation
  为汇总在调用分段 CRUD API 期间采取的操作而触发此事件。

​

Session

• client_focus_change
  每次应用程序在玩家设备上进入或退出焦点时触发此事件。
• client_session_start
  新的客户端会话开始时触发此事件。

​

Title

• title_client_rate_limited_alert
  单个 IP 地址对 PlayFab 生成过多 API 调用并受到限制时触发此事件。
• title_high_error_rate_alert
  游戏发生高错误率时触发此事件。
• title_requested_limit_change
  游戏请求服务限额更改时触发此事件。
• title_saved_survey
  保存游戏调查时触发此事件。

​

TitleData

• title_news_updated
  创建或更新游戏新闻时触发此事件。
• title_secret_key_changed
  游戏添加或更新密钥时触发此事件
• title_activated
  激活游戏时触发此事件。
• title_data_override_deleted
  删除游戏数据覆盖时触发此事件。
• title_data_updated
  更新游戏数据时触发此事件。
• title_deactivated
  停用游戏时触发此事件。

​

TargetedConfiguration

• player_churn_prediction_changed
  玩家的流失预测更改时触发此事件。

​

Statistics

• statistic_updated
  统计信息更新时触发此事件。

​

Leaderboards

• character_statistic_changed
  角色统计信息更改时触发此事件。
• character_statistic_deleted
  角色统计信息删除时触发此事件。
• entity_rank_on_leaderboard_version_ended
  排行榜版本重置时触发此事件
• leaderboard_version_ended
  排行榜版本重置时触发此事件
• player_ranked_on_leaderboard_version
  当排行榜版本更改时触发此事件，为排名靠前的玩家（最多不超过”Leaderboard version change top rank events sent”设置定义的限制）生成事件。
• player_statistic_changed
  玩家统计信息更改时触发此事件。
• player_statistic_deleted
  玩家统计信息删除时触发此事件。
• title_statistic_version_changed
  统计信息版本更改并导致其排行榜重置时触发此事件。
• title_statistic_deleted
  删除游戏统计信息时触发此事件。