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 を呼び出すか、PlayStream イベント アクションで「結果を PlayStream イベントとして公開する」ボックスをオンにした場合にトリガーされます。
• player_executed_cloudscript
  CloudScript 関数が実行されたときに、GeneratePlayStreamEvent オプションを指定して ExecuteCloudScript API を呼び出すか、PlayStream イベント アクションで「結果を PlayStream イベントとして公開する」ボックスをオンにした場合にトリガーされます。
• player_triggered_action_executed_cloudscript
  PlayStream アクションの結果として CloudScript 関数が実行され、「結果を PlayStream イベントとして公開する」ボックスがオンだった場合にトリガーされます。
• 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
  ゲーム セーブ バージョンが 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
  支払いプロセスの 2 番目のステップが完了し、購入代金が支払われたときにトリガーされます。
• 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
  プレイヤーがタイトルの新しいアカウントを作成したときにトリガーされます。注: このイベントは、パブリッシャーごとではなくタイトルごとに 1 回トリガーされます。
• player_banned
  プレイヤーが BAN されたときにトリガーされます。
• player_changed_avatar
  プレイヤーのアバター URL が変更されたときにトリガーされます。
• player_completed_password_reset
  プレイヤーが送信されたリンク URL にアクセスし、新しいパスワードを選択してパスワード リセット プロセスを完了したときにトリガーされます。
• player_created
  プレイヤー アカウントが初めて作成されたときにトリガーされます。注: このイベントは、タイトルごとではなくパブリッシャーごとに 1 回だけトリガーされます。
• player_data_exported
  プレイヤーのデータがエクスポートされたときにトリガーされます。
• player_device_info
  タイトルの設定に基づいて、プレイヤーがログインした後に 1 回トリガーされます。
• player_displayname_changed
  プレイヤーの表示名が変更されたときにトリガーされます。
• player_linked_account
  プレイヤーのアカウントに新しい認証方法がリンクされたときにトリガーされます。
• player_logged_in
  プレイヤーがログインしたときにトリガーされます。
• player_password_reset_link_sent
  パスワードをリセットするためのリンクがプレイヤーに送信されたときにトリガーされます。
• player_removed_title
  タイトルのプレイヤー アカウントが削除されたときにトリガーされます。注: このイベントは、パブリッシャーごとではなくタイトルごとに 1 回トリガーされます。
• 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
  プレイヤー ID リンクが追加されたときにトリガーされます。
• player_identity_link_removed
  プレイヤー ID リンクが削除されたときにトリガーされます。
• 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
  タイトルの統計が削除されたときにトリガーされます。