PlayFab 的 PlayStream 事件模型參考

這些是由 PlayFab 遊戲服務 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
  當實體 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

• api_rate_limit_alert
  當 API 呼叫者接近或達到速率限制時，可能會觸發此事件。
• 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
  當遊戲統計資料刪除時，就會觸發此事件。