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

# イベントリファレンス

> Profound Pixel のイベント、フィールド、使用方法

## 標準イベント

Profound Pixel は次の標準イベントを認識します。各イベントでは、任意のフィールドのセットを指定できます。各セットで指定できる内容については、[フィールドセット](#field-sets)を参照してください。

| イベント | 送信するタイミング | フィールドセット |
| - | - | - |
| `page_viewed` | 訪問者がページを閲覧したとき | `contents` |
| `contents_viewed` | 訪問者が製品、リスティング、記事、その他のコンテンツ単位を閲覧したとき | `contents` |
| `items_added` | 訪問者がカートや選択リストにアイテムを追加したとき | `contents` |
| `checkout_started` | 訪問者がチェックアウトを開始したとき | `contents` |
| `order_created` | 購入が完了したとき | `contents` |
| `subscription_created` | 有料サブスクリプションが開始されたとき | `plan_enrollment` |
| `trial_started` | 無料トライアルが開始されたとき | `plan_enrollment` |
| `lead_created` | 訪問者がリードフォームを送信したとき、または問い合わせをリクエストしたとき | `customer_action` |
| `registration_completed` | 訪問者がアカウント登録またはイベント登録を完了したとき | `customer_action` |
| `appointment_scheduled` | 訪問者がミーティング、デモ、相談を予約したとき | `customer_action` |

### フィールドセット

| フィールドセット | 認識されるフィールド |
| - | - |
| `contents` | `amount`、`currency`、`contents[]` |
| `plan_enrollment` | `plan_id`、`amount`、`currency`、`contents[]` |
| `customer_action` | `amount`、`currency` |

<Accordion title="contents セットのプロパティ">
  | プロパティ | 型 | 必須 | 説明 |
  | - | - | - | - |
  | `amount` | number | いいえ | 指定した通貨の補助単位(米ドルの場合はセント)で表した整数。たとえば、\$129.99 = `12999` です。必ず `currency` と組み合わせて指定してください |
  | `currency` | string | `amount` がある場合は必須 | `USD` などの [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 通貨コード |
  | `contents[]` | array | いいえ | イベントに関係するアイテムのリスト。各エントリーには `id`、`name`、`content_type`、`quantity`(整数)、`amount`、`currency` を指定します |

  ```javascript Example event theme={null}
    pfq('track', 'order_created', {
      amount: 12999, currency: 'USD',
      contents: [
        {
          id: 'SKU123',
          name: 'Widget',
          content_type: 'product',
          quantity: 1,
          amount: 12999,
          currency: 'USD'
        }
      ]
    });
  ```
</Accordion>

<Accordion title="plan_enrollment セットのプロパティ">
  | プロパティ | 型 | 必須 | 説明 |
  | - | - | - | - |
  | `plan_id` | string | いいえ | 社内のプラン識別子 |
  | `amount` | number | いいえ | 指定した通貨の補助単位(米ドルの場合はセント)で表した整数。たとえば、\$129.99 = `12999` です。必ず `currency` と組み合わせて指定してください。 |
  | `currency` | string | `amount` がある場合は必須 | `USD` などの [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 通貨コード |
  | `contents[]` | array | いいえ | イベントに関係するアイテムのリスト。各エントリーには `id`、`name`、`content_type`、`quantity`(整数)、`amount`、`currency` を指定します |

  ```javascript Example event theme={null}
    pfq('track', 'subscription_created', {
      plan_id: 'pro-monthly',
      amount: 4900,
      currency: 'USD',
      contents: [
        {
          id: 'pro-monthly',
          name: 'Pro plan, monthly billing',
          content_type: 'plan',
          quantity: 1,
          amount: 4900,
          currency: 'USD'
        }
      ]
    });
  ```
</Accordion>

<Accordion title="customer_action セットのプロパティ">
  | プロパティ | 型 | 必須 | 説明 |
  | - | - | - | - |
  | `amount` | number | いいえ | 指定した通貨の補助単位(米ドルの場合はセント)で表した整数。たとえば、\$129.99 = `12999` です。必ず `currency` と組み合わせて指定してください。 |
  | `currency` | string | `amount` がある場合は必須 | `USD` などの [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 通貨コード。 |

  ```javascript Example event theme={null}
    pfq('track', 'lead_created', {
      amount: 50000,
      currency: 'USD',
      form: 'contact-sales'
    });
  ```
</Accordion>

### カスタムプロパティ

認識されるフィールドに加えて、独自のカスタムプロパティ(`order_id` や `product_id` など)を追加できます。制限は 2 つあり、1 イベントあたり最大 128 個のプロパティ、1 リクエストボディあたり最大 64 KiB です。いずれかの制限を超えたイベントは、`400` エラーで拒否されます。

## カスタムイベント

標準セットに含まれないものについては、カスタムイベントを送信します。任意のイベント名と任意のプロパティを指定して `pfq('trackCustom', …)` を呼び出します。

```javascript theme={null}
  pfq('trackCustom', 'requested_demo', { plan: 'enterprise' });
```

イベント名の最大長は 128 文字です。推奨される命名規則は、小文字、数字、アンダースコアまたはダッシュを使用し、[標準イベント](#standard-events)名と一致しない名前にすることです。これにより、レポートでカスタムイベントを簡単に区別できます。

<Warning>
  **イベントで顧客の個人データを送信しないでください。** これには、メールアドレス、電話番号、氏名、政府発行の ID、支払いデータ、住所、および健康情報、金融口座の詳細、生体情報などの特別な種類のデータが含まれます。安全対策として、Profound は個人データのキーを除外し、個人データと思われる値を編集・除去します。
</Warning>

## イベントを独自のユーザー ID に関連付ける

コンバージョンを自社システムのレコードと照合する必要がある場合は、顧客のログイン後、イベントが送信される前に、社内の識別子を指定して `identify` 呼び出しを行います。

```javascript theme={null}
  pfq('identify', {
    external_user_id: 'u_123',
    external_account_id: 'acct_456'
  });
```

次のフィールドを指定できます。

| フィールド | 型 | 必須 |
| - | - | - |
| `external_user_id` | string | いいえ |
| `external_account_id` | string | いいえ |

その他のフィールドは警告なく無視されます。

ピクセルは、同意シグナルによって送信が許可されるまで ID をメモリに保持し、その後に続くイベントに付与します。

<Warning>
  送信するのは社内 ID のみにし、顧客の氏名、メールアドレス、電話番号、その他の識別子は絶対に送信しないでください。`identify` フィールドに個人データが含まれていると、イベント全体が `400` エラーで拒否されます。
</Warning>