コンバータ設定リファレンス

このリファレンスでは、Amazon S3 インポートと Google Cloud Storage (GCS) コンバータ設定の例と演算子について説明しています。 詳細については、S3 ガイドまたは GCS ガイドをご覧ください。

skip_user_properties_sync

クラウドストレージソースのインポートの多くは履歴データのバッチアップロードであるため、履歴イベントの最新のユーザープロパティを同期することは意味をなさない場合があります。 このため、Amplitude はデフォルトで trueに設定されています。 $skip_user_properties_syncユーザープロパティをイベントに含めるには、コンバータでfalse に設定してください。

の詳細については、$skip_user_properties_sync『データバックフィルガイド』を参照してください。

ignoreEventFlag

計算されたブール値条件に基づいて、イベントの取り込みを選択的にスキップするために使用します。ignoreEventFlag ignoreEventFlagフィールド名（例："$ignore"）に設定し、DataLang のブール式を使用してconvertToAmplitudeFuncそのフィールドを定義します。 フィールドが特定のイベントに対して true と評価されると、Amplitude はそのイベントをエラーとみなさずにスキップします。 評価結果が false の場合や、存在しない場合、Amplitude は通常どおりイベントを取り込みます。

このオプションは、ソースデータに内部テストイベント、ボットトラフィック、特定のイベントタイプなど、フィルタリングしたいイベントが含まれている場合に、ファイルを上流で前処理することなく便利です。

例：特定のイベントタイプを除外する

次の例では、event_type または page_view であるイベントをスキップしますsession_start。

{
  "converterConfig": {
    "ignoreEventFlag": "$ignore",
    "convertToAmplitudeFunc": {
      "event_type": "event_type",
      "user_id": "user_id",
      "$ignore": ["or",
        ["equals", ["path", "event_type"], ["value", "page_view"]],
        ["equals", ["path", "event_type"], ["value", "session_start"]]
      ]
    }
  }
}

この例では：

• "ignoreEventFlag": "$ignore"は、Amplitudeに対し、変換されたイベント内で$ignore という名前のフィールドを探すよう指示します。
• convertToAmplitudeFunc の "$ignore" では、or および equals 演算子を使用してブール式を定義しています。
• event_typeがpage_viewまたはsession_startの場合、$ignoreはtrueと評価され、Amplitudeはイベントをスキップします。
• Amplitude は他のすべてのイベントを正常に取り込みます。

任意のブール演算子または演算子の組み合わせを使用して条件を作成できます。

convertToAmplitudeFunc

convertToAmplitudeFunc の変換ルールは、Amplitudeでイベントを構築する方法をインジェストサービスに指示します。

コンバータの例 convertToAmplitudeFunc

{
    "config_name": ["Event sample converter"],
    "converterConfig": {
        "fileType": "parquet",
        "compressionType": "none",
        "convertToAmplitudeFunc": {
          "event_type": "action",
          "user_id": "user",
          "device_id": "device",
          "event_properties": {
              "business_id_encid": "business_id"
          },
          "user_properties": {
              "utm_channel_category": "utm_channel_c",
              "utm_channel_source": "utm_channel_s"
          },
          "time": "epoch",
          "session_id": "session_id",
          "app_version": "app_version"
        }
    },
    "keyValidatorConfig": {
        "filterPattern": "folder1/folder2/ds=202011[1-2][0-9]/.*\\.parquet"
    }
}

構築されたイベントの例

{
  "event_type": "watch tv",
  "user_id": "john",
  "device_id": "host1",
  "event_properties": {
    "business_id_encid": "123"
      },
      "user_properties": {
        "utm_channel_category": "discovery",
        "utm_channel_source": "network"
      },
      "time": "1645066434189",
      "session_id": "1",
      "app_version": "1"
}

イベント内の値は convertToAmplitudeFunc で指定されたフィールドから取得されます。 たとえば、event_typeフィールドwatch tvの値は、取り込まれたデータ ファイル内の「action」フィールドから取得されます。event_type値が ["value":"$identify"]または ["value":"$groupidentify"] ではないため、Amplitude は HTTP V2 API でイベントを取り込むのと同じ方法でイベントを取り込みます。

オペレータ

リスト演算子

リスト演算子を使用する

ソースの説明がリストの場合、リスト内の最初の項目は関数を指定する文字列でなければなりません。 リストの残りの部分は関数のパラメータです。 「|」文字は、繰り返さない引数と繰り返し引数を区切ります。「|」の後の引数はすべて繰り返し使用可能であり、何回でも指定できます。 引数のリスト全体は、任意の複数引数演算子に存在する必要があります（3つの引数のうち1つだけを指定することはできません。3つすべてを含める必要があります）。

ブール演算子

これらの演算子はブール型の JsonPrimitive を返すため、condおよび ifelseと一緒に使用できます。

整数演算子と浮動小数点演算子

以下の演算子は、型 Float の JsonPrimitive を返す演算子を除いて、型 Integer の JsonPrimitive を返します。add

JSON 演算子

ユーザープロパティ操作

コンバータは、Identify API と同じユーザープロパティ演算子をサポートしています。 詳細については、Identify に関するドキュメントを参照してください。