事件

以下是內建的 PlayStream 事件，這些事件會由 PlayFab 遊戲服務 API 自動產生並寫入事件管線。除了這些事件之外，您也可以使用 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 的非作用中修訂已成為作用中的 ‘live’ 版本。
• 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
  此事件會在刪除遊戲統計資料時觸發。