> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom Tag を使用してイベントをカスタマイズする

> カスタム タグを使用してイベントをカスタマイズする方法について学びます。カスタム タグは、スタジオが API リクエストにオプションで含めることができるキーと値のペアのコレクションです。

# PlayStream イベントでカスタム タグを使用する

カスタム タグは、スタジオがすべての API リクエストにオプションで含めることができるキーと値のペアのコレクションです。これらは、標準の PlayStream イベントをよりスタジオ固有のメタデータ (たとえば、ビルド番号、外部トレース識別子など) で強化するのに役立ちます。

カスタム タグは、PlayStream イベントの使用方法を拡張します。基本的な PlayStream スキーマは固定であり、拡張性がありませんが、共通のメトリックと分析の構築を可能にしました。スキーマの固定的な性質により、ゲーム スタジオが効率的で経済的な方法でデータをカスタマイズしたり、特定のデータ ポイントを収集したりする能力が制限されていました。カスタム タグは、スキーマを拡張してより大きな柔軟性と機能を実現する方法を提供します。

## カスタム タグで何ができるか?

カスタム タグを使用して達成できることはたくさんあります。以下にいくつかの提案を示しますが、使用時にはより創造的になってください。

### 自動化

PlayStream メタデータは、特定のイベントをトリガーする条件として機能します。タスクを達成する必要がある場合、PlayFab のお客様は「\[カスタム タグ] が xyz 要件を満たす場合、アクション A を発動する」というルールを設定できます。

CloudScript をカスタム タグと統合して自動化を実現できます。CloudScript の [アクションとルール](/services/playfab/data-analytics/acting-data/action-rules-overview) を使用すると、特定の基準に基づいてイベントを自動的に発動できます。

たとえば、ゲーム スタジオがゲームのパフォーマンス マーケティングに投資しており、新しいプレイヤーを獲得するためにさまざまなマーケティング キャンペーンを実行している場合、プレイヤーを獲得したマーケティング キャンペーンを追跡し、そのキャンペーン ID をすべての PlayStream イベントに追加できます。その後、そのキャンペーン ID を使用してプロセスを自動化できます。たとえば、広告が「サインアップで 1,000 の無料ゴールド コイン」と約束した場合、「new player」イベントを送信し、マーケティング キャンペーンを使用してプレイヤーに与えるインセンティブを決定します。例: 「マーケティング キャンペーンが 'FREE\_GOLD\_COINS' の場合、プレイヤーに 1,000 のゴールド コインを与える」。

### テレメトリ

PlayStream メタデータは、データ収集と分析を支援できます。たとえば、非 PlayFab サービスから PlayStream イベント データの一部としてカスタム タグを送信し、データ パイプラインを流れるときにそれを追跡できます。
すでに独自の分析システム (たとえば、何らかの識別子に基づく) を持っている場合、PlayStream イベントの一部としてカスタム タグでその識別子を渡すことで、新しいデータを簡単に統合およびマージできます。

キャンペーン ID やその他の分析識別子を含めて収益を分析し、どのキャンペーンが最高の新規プレイヤー獲得、収益源、顧客価値を生み出したかを判断できます。

## データ フロー

カスタム タグが API リクエストから受信されると、データは PlayStream イベントの一部になり、PlayStream パイプラインを流れて PlayFab のバックエンド データ ウェアハウスである Kusto に保存されます。

## 制限事項

* カスタム タグには次の制限があります:
  * 10 個以下のキーと値のペア
  * 各キー文字列は 64 utf8 文字以下でなければなりません。
  * 各値文字列は 128 utf8 文字以下でなければなりません。
  * API 呼び出しでのみサポートされます (つまり、Game Manager UI ではサポートされていません)。

## 入門

以下のサンプル リクエストは、JSON リクエストにカスタム タグを追加する方法を示しています。
`CustomTags` はデータ パイプラインを流れる関連する PlayStream イベントに従い、後でこのデータにアクセスして実行可能および分析目的に使用できます。

### サンプル リクエスト

```json theme={null}
POST https://titleId.playfabapi.com/Server/WritePlayerEvent
{
  "PlayFabId": "{{PlayFabId}}",
  "EventName": "player_defeated_enemy",
  "Timestamp": "2016-03-07T00:00:00Z",
  "Body": {
    "Enemy": "guardian",
    "Damage": 5,
    "Coordinates": {
      "X": 123.4,
      "Y": 543.2
    }
  },
  "CustomTags": {
    "correlation_id": "123abc",
    "build_number": "1.0.0.0",
    "platform": "iOS"
  }
}
```

### サンプル レスポンス

カスタム タグを追加しても、エンドポイントへの呼び出しから受信するレスポンスは変わりません。`CustomTag ノード` を追加した後のレスポンスは、ノードが存在しない場合に受信するレスポンスと同一です。


## Related topics

- [タッチ コントロール構築のデザイナーズ ガイド](/ja-jp/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-tak-designers-guide.md)
- [Economy (レガシー) のクイックスタート](/ja-jp/services/playfab/economy-monetization/economy/quickstart.md)
- [タッチ操作プレビューのカスタマイズ](/ja-jp/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-customize-preview.md)
- [PowerShell/API を使用したビルドのデプロイ](/ja-jp/services/playfab/multiplayer/servers/deploy-using-powershell-api.md)
- [タッチ アダプテーション レイアウトのプレビュー](/ja-jp/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-preview-layouts.md)
