Telemetry Key の使用
Game Manager のData セクションの下にある Telemetry Keys タブから、タイトルに構成されているキーを管理できます。
キーを作成したら、HTTP ヘッダー X-TelemetryKey を介して含めることで、WriteTelemetryEvents を呼び出すときにゲーム クライアントから使用できます:
呼び出し元は Telemetry Key または Entity Token のいずれかを提供する必要があります。両方が提供された場合、Telemetry Key は無視され、リクエストは提供されていないかのように処理されます。
制限事項
Telemetry Key を使用する際に、次の制限が適用されます:- タイトルは最大 5 つの Telemetry Key を構成できます。
- Telemetry Key は、WriteTelemetryEvents API を介してテレメトリ イベントを送信するためだけに使用できます。WriteEvents API を介して PlayStream イベントを送信するためには使用できません。
- Insights Retention を 30 日を超えて設定しているタイトルは、現時点では Telemetry Key を構成できません。
イベントのエンティティの指定
PlayFab イベントは、Entity プロパティを介してイベントのサブジェクトを示します。Entity Token 認証を使用してテレメトリを送信するとき、このフィールドはサインインしているエンティティに関する情報で自動的に入力されます。ただし、Telemetry Key を使用すると、サインインしているエンティティはありません。したがって、Telemetry Key を使用して送信されるテレメトリ イベントでは、PlayFab の組み込みエンティティ をサブジェクトとして指定することは許可されていません。
Telemetry Key を使用するときでも、テレメトリ イベントを何らかのサブジェクト (たとえば、ゲームで使用されるカスタム プレイヤー識別子) に関連付けたい場合があります。それを行うには、クライアントでイベントを形成するときに 外部 エンティティを指定できます。
外部エンティティは、単に type を external に設定して指定するエンティティです。これらは PlayFab のエンティティ システムの正式な部分ではありません。この文脈では、テレメトリ イベントをシステムで意味のあるサブジェクト識別子に関連付けるための便利なメカニズムを提供するためだけに使用されます。
コードでイベントを形成するときに外部エンティティをサブジェクトとして指定するには、次のようにする必要があります:
- イベントの
Entity.typeフィールドをexternal(大文字と小文字の区別あり) に設定します。 - イベントの
Entity.idフィールドをカスタム サブジェクト識別子に設定します (最大 64 文字)。
イベントの
OriginInfo.Key プロパティには、イベントの取り込みに使用されたキーの名前が含まれます。複数の Telemetry Key を構成している場合、このプロパティを使用してイベントの取り込みに使用されたキーを確認できます。