Webhook - カスタムリクエスト送信 - Trimouテンプレートエンジンガイド

詳細については、Trimou 2.3.0 ドキュメントを参照してください。

前提条件

• Webhook - アクションパラメータ
• Webhook - テンプレート変数ガイド

Webhooks

Webhookを構成する際、訪問プロファイルには訪問と訪問属性があり、必要な出力にマッピングする必要があります。すべてのデータタイプがマッピング可能である訪問プロファイルの例を以下に示します：

{
    "badges": [
        "Test Badge"
     ],
    "dates": {
        "Test Date [dat]": 1600128000000
    },
    "flags": { --booleans
        "Test Boolean [bln]": true
    },
    "metrics": { --numbers
        "Lifetime visit count": 12
    },
    "metric_sets": { --tallies
        "Test Tally [tly]": {
            "A": 1,
            "B": 2,
            "C": 3
        }
    },
    "properties": { --strings
        "Test String [str]": "Hello"
    },
    "property_sets": { --sets of strings
        "Test Set of Strings [ss]": [
            "A",
            "B",
            "C"
        ]
    },
    "property_lists": { --arrays of strings
        "Test Array Strings [arrs]": [
            "A",
            "A",
            "B"
        ]
    },
    "metric_lists": { --arrays of numbers
        "Test Array Numbers [arrn]": [
            1.0,
            2.0,
            3.0
        ]
    },
    "flag_lists": { --arrays of booleans
        "Test Array Booleans [arrb]": [
            true,
            true,
            false
        ]
    }
}

Trimouテンプレートで使用したい入力訪問プロファイルのすべての属性をマッピングします。マッピングされた属性の値はTrimouレンダリングエンジンで利用可能になります。

テンプレート変数を構成する際にマッピング可能なデータタイプを以下に示します：

構文

以下のセクションの構文例は、訪問プロファイルを参照しています。

変数の置換

変数名はそのデータ値のプレースホルダーです。変数置換は、この値を二重中括弧で参照します。例えば {{var}} です。

次の例では、文字列変数 {{str}} がその値 Hello で置換されます。

次の例では、数値の配列 {{arrn}} の最初の値を、インデックスを指定して参照します。

セクション

開始 {{#var}} と終了 {{/var}} タグに囲まれたコンテンツのセクションは、指定されたキーのオブジェクトが見つかった場合にレンダリングされます。これには Boolean の値 true、空でない Iterable、空でない配列が含まれます。

次の例では、Boolean 変数 bln が true であるため、コンテンツがレンダリングされます。変数が false だった場合、コンテンツはレンダリングされません。

次の例では、文字列の配列 arrs が空でないため、配列の要素ごとに一度ずつ、合計三回コンテンツがレンダリングされます。変数が false だった場合、コンテンツはレンダリングされません。

反転セクション

開始 {{^var}} と終了 {{/var}} タグに囲まれたコンテンツのセクションは、コンテキスト内でオブジェクトが見つからない場合にレンダリングされます。これには Boolean の値 false、要素のない Iterable、空の配列が含まれます。

次の例では、bln が true であるため、コンテンツはレンダリングされません。変数が false だった場合、コンテンツはレンダリングされます。

次の例では、訪問プロファイルで定義されていない変数 missing のため、コンテンツがレンダリングされます。

繰り返し

Trimouは配列を繰り返し処理するためのいくつかのヘルパー関数を提供します。繰り返し内のネストされた属性は名前で参照されます。Trimouは、それらが属するコンテキストと親（繰り返し要素）を決定します。

以下は、Trimouの組み込み繰り返しヘルパーです：

• iter.index（最初の要素はインデックス 1 で始まります）
• iter.isFirst
• iter.isLast
• iter.hasNext

次の例では、ブール値の配列を変数 object.arrb にマッピングし、配列を繰り返し処理する方法を示しています：

テンプレート

{
  "MyData": [
  {{#object.arrb}}
  {
    "idx": {{iter.index}},
    {{#iter.isFirst}}"first": true,{{/iter.isFirst}}
    {{#iter.isLast}}"last": true,{{/iter.isLast}}
    "val": {{.}}
  }{{#iter.hasNext}},{{/iter.hasNext}}
  {{/object.arrb}}
  ]
}

• {{#object.arrb}} と {{/object.arrb}} は配列を繰り返し処理します。
• {{iter.index}} は現在の繰り返しインデックスで、1から始まります。
• {{#iter.isFirst}}"first": true,{{/iter.isFirst}} は最初の繰り返しであればテキスト内をレンダリングします。
• {{#iter.isLast}}"last": true,{{/iter.isLast}} は最後の繰り返しであればテキスト内をレンダリングします。
• {{#iter.hasNext}}, {{/iter.hasNext}} は繰り返しにさらに要素がある場合（iterHasNext が true の場合）コンマをレンダリングします。
• {{.}} は配列を繰り返し処理する際に配列値を参照します。

レンダリングされた値

{
  "MyData": [
    {
      "idx": 1,
      "first": true,
      "val": true,
    },
    {
      "idx": 2,
      "val": true,
    },
    {
      "idx": 3,
      "last": true,
      "val": false,
    }
  ]
}

集計を繰り返し処理するには、イテレータ entrySet を使用し、key と value を参照します：

テンプレート

{
  "MyTally": {
    {{#each tly.entrySet}}
      "{{key}}": "{{value.toInteger}}"{{#iter.hasNext}},{{/iter.hasNext}}
    {{/each}}
  }
}

レンダリングされた値

"MyTally": {
    "A": "1",
    "B": "2",
    "C": "3"
}

ヘルパー関数

テンプレートは、Tealiumが提供するヘルパー関数を通じて追加のカスタム機能を提供します。これにより、データの変換が容易になり、望ましいドキュメント形式の生成が容易になります。

castIntegers

このヘルパーは、コレクションの出力を整数値に強制します。toJson と共に使用できます。

encodeBase64

コンテンツをbase64でエンコードします。

encodeUrl

コンテンツをURLエンコードします。

escapeHtml

HTMLドキュメントで使用するために値をエスケープします。

escapeJson

JSONオブジェクト/配列で使用するために値をエスケープします。

escapeXml

XMLドキュメントで使用するために値をエスケープします。

formatDate

指定されたパターンに従って日付変数をフォーマットします。パターンの構文はJavaのSimple Dateフォーマットに対応しています。全ての表記一覧については、Java Simple Date Format documentationを参照してください。

hash

HMACジェネレーターは、秘密鍵を使用してハッシュベースのメッセージ認証コード（HMAC）を計算します。HMACは、メッセージの性質を認証するのに役立つ小さなデータセットであり、メッセージの完全性と真正性を保護します。

秘密鍵は、HMACを計算するために使用される情報の一意の部分であり、メッセージの送信者と受信者の両方によって知られています。この鍵は使用するアルゴリズムによって長さが異なります。

次の例では、testKey、timestamp、ip、langがTrimouテンプレートで有効な入力変数として存在すると仮定しています。

if

変数が存在し、内容がある場合に内容を出力します。次の例では、langがTrimouテンプレートで有効な入力変数として存在すると仮定しています。

isEq

値が等しい場合に内容を出力します。

isNotEq

値が等しくない場合に内容を出力します。

join

リストをオプションのジョイナーを使用して文字列に変換します。empty_listが空のリストであると仮定します。

jsonMinify

有効なJSONを含むコンテンツが提供された場合、それを最小化します（すべての空白を削除します）。コンテンツが有効なJSONでない場合、変更なしで元の値が表示されます。

md5

コンテンツのMD5ハッシュを計算します。

sha1

コンテンツのSHA1ハッシュを計算します。

sha256

コンテンツのSHA256ハッシュを計算します。

substring

指定されたstartインデックスから始まり、指定されたendインデックス-1で終わる部分文字列を出力します。

substringAfter

指定されたセパレータ文字列の後の部分文字列を出力します。

substringAfterLast

指定されたセパレータ文字列の最後の出現後の部分文字列を出力します。

substringBefore

指定されたセパレータ文字列の前の部分文字列を出力します。

substringBeforeLast

指定されたセパレータ文字列の最後の出現前の部分文字列を出力します。

substringBetween

指定されたopenとclose文字列の間の部分文字列を出力します。

sum

リストまたは合計のすべての値を合計します。

toInteger

変数の値を整数に変換します。

toJson

変数をJSON形式で出力します。

toList

JSON形式の配列文字列を配列に変換して、追加の操作を行います。

arrn: ["1","2","2"]の場合:

toTimestamp

日付変数の値をUnix秒タイムスタンプ形式に変換します。

toTimestampMs

日付変数の値をUnixミリ秒タイムスタンプ形式に変換します。

unixTimestamp

Unixエポックからの秒数でコネクタの発火時間を表示します。これは認証ヘッダーに便利です。オプションで、指定されたパターンに従って日付変数をフォーマットすることができます。パターンの構文はJavaのSimple Dateフォーマットに対応しています。完全な表のリストについては、Java Simple Date Formatのドキュメントを参照してください。

unixTimestampMs

Unixエポックからのミリ秒数でコネクタの発火時間を表示します。これは認証ヘッダーに便利です。オプションで、指定されたパターンに従って日付変数をフォーマットすることができます。パターンの構文はJavaのSimple Dateフォーマットに対応しています。完全な表のリストについては、Java Simple Date Formatのドキュメントを参照してください。

unless

パラメータが存在しないか内容がない場合にコンテンツを表示します。これはifの逆です。

uuid

ランダムに生成されたUUIDを表示します。これは、リソースを識別するためや分散システムでの一意性を保証するために一般的に使用される、全世界で一意の識別子です。