Skip to content

アナリティクスプロパティを宣言する ​

カスタムイベントのプロパティは、最初は observed として届きます。プロパティを宣言すると安定した型が付き、ゴールの述語から使えるようになります。宣言済みの enum プロパティは、アナリティクスとファネルの内訳にも使えます。

コンソールは宣言済みプロパティを表示しますが、作成はできません。エージェント、CLI、または API を使ってください。

1. プロパティを送る ​

そのプロパティを載せたカスタムイベントを、少なくとも 1 件 POST します。例:

javascript
track('select_plan', { plan: 'pro' });

track の完全な例は アナリティクスイベントを収集する を参照してください。

2. 観測プロパティを確認する ​

text
acme-marketing の観測済みアナリティクスプロパティを確認して、
推定された型、カーディナリティ、推奨、安全なサンプルを見せて。

エージェントは edge_property_check を実行します。PII 検出器に一致したサンプルは元の値ではなく (blocked) と表示されます。enum を選ぶ前に異なる値の件数を確認してください。注文 ID のように上限のない値は、内訳として役に立ちません。

3. 宣言する ​

value_type は enum、string、int、bool です。enum では allowed_values が必須です。

text
acme-marketing の plan を、starter、pro、enterprise の値を持つ
enum として宣言して。
bash
edge api POST /v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38/properties/plan/declare --input - <<'EOF'
{
        "value_type": "enum",
        "allowed_values": ["starter", "pro", "enterprise"]
      }
EOF
bash
curl -s -X POST \
  https://api.edge.deca-dev.com/v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38/properties/plan/declare \
  -H "Authorization: Bearer $EDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "value_type": "enum",
        "allowed_values": ["starter", "pro", "enterprise"]
      }'

エージェントは edge_property_declare を実行します。宣言はメタデータだけです。保持されている過去の値は、古いイベントを書き直さずに照会できるようになります。

宣言を維持する ​

edge_property_update または PATCH /v1/distributions/{id}/properties/{key} で次を変更できます。

  • value_type と allowed_values
  • max_cardinality
  • on_violation: truncate または drop_value

プロパティのアーカイブは edge_property_archive、または同じ HTTP パスへの DELETE です。アーカイブすると宣言済みプロパティとしては使えなくなりますが、過去のイベントは消えません。予約済みの収益プロパティはアーカイブできません。

使う ​

Analytics コンソールの Properties ビューに、宣言済みプロパティが表示されます。enum プロパティは内訳として選べ、宣言済みプロパティは コンバージョンゴール から参照できます。

次に読む ​