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

前提条件

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

概要

Trimouは、JSON入力とテンプレート定義に基づいてドキュメントのレンダリングを可能にするオープンソースのテンプレートエンジンです。このガイドでは、一般的な構文と、Tealium AudienceStreamに特有の拡張について説明します。

詳細は、Trimou 2.3.0 ドキュメンテーションを参照してください。

Webhooks

AudienceStreamで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,
            1.0,
            2.0
        ]
    },
    "flag_lists": { --arrays of booleans
        "Test Array Booleans [arrb]": [
            true,
            true,
            false
        ]
    }
}

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

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

構文

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

変数の置換

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

以下の例では、String変数{{str}}がその値Helloで置換されます。

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

セクション

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

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

以下の例では、Stringsの配列arrsが空でないため、コンテンツが3回レンダリングされます。それぞれの配列要素に対して1回ずつです。変数がfalseであった場合、コンテンツはレンダリングされません。

反転セクション

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

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

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

反復

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

上記の例では、文字列のセットを変数"object.ss"に、文字列の配列を変数"object.arrs"に、数値の配列を変数"object.arrn"に、最後にブール値の配列を変数"object.arrb"にマッピングしました。これにより、Trimouを使用してこれらの属性をまとめて反復処理し、変数"object"を反復処理することで、それらを整列した配列として扱うことができます。以下の例を参照してください。

以下は、Trimouの組み込み反復ヘルパーです：

• iter.index (最初の要素はインデックス1にあります)

• iter.isFirst

• iter.isLast

• iter.hasNext

• {{#object}} と{{/object}} は、私たちが"object.“というプレフィックスをつけた4つの変数を反復処理していることを意味します。

• {{iter.index}} は現在の反復インデックスで、1から始まります。

• {{#iter.isFirst}}"first":"true",{{/iter.isFirst}} は、最初の反復であれば内部のテキストをレンダリングします

• {{#iter.isLast}}"last":"true",{{/iter.isLast}} は、最後の反復であれば内部のテキストをレンダリングします

• {{ss}}は{{#object}}内部で、私たちがこの位置の文字列のセットのアイテムを参照していることを意味します。なぜなら、私たちは文字列のセットを"object.ss"にマッピングしたからです。

• 同様に、{{arrs}},{{arrn}} および{{arrb}}はそれぞれ、文字列の配列、数値の配列、ブール値の配列を参照します

• {{#iter.hasNext}}, {{/iter.hasNext}} は、反復が他の要素を持っている場合（iterHasNextがtrueである場合）にカンマをレンダリングします

テンプレート

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

レンダリングされた値

"MyData": [{
    "idx": 1,
    "first": "true",
    "ss": "A",
    "arrs": "A",
    "arrn": "1.0",
    "arrb": "true",
}, {
    "idx": 2,
    "ss": "B",
    "arrs": "A",
    "arrn": "1.0",
    "arrb": "true",
}, {
    "idx": 3,
    "last": "true",
    "ss": "C",
    "arrs": "B",
    "arrn": "2.0",
    "arrb": "false",
}]

集計を反復処理するためには（上記の例では、集計を"tly"にマッピングしました）、entrySetと呼ばれる特別なイテレータを使用できます。これを使用すると、以下の例のように、キーと値を参照できます。

テンプレート

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

レンダリングされた値

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

ヘルパー関数

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

castIntegers

Customer Data Hubは、さまざまな数値を小数で保存します。このヘルパーは、コレクションの出力を整数値に強制します。toJsonと一緒に使用できます。

encodeBase64

内容をbase64でエンコードします。

encodeUrl

URLの内容をエンコードします。

escapeHtml

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

escapeJson

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

escapeXml

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

formatDate

指定されたパターンに従って日付変数をフォーマットします。パターンの構文はJavaのSimple Date formattingに対応しています。完全なテーブルリストについては、Java Simple Date Format documentationを参照してください。

hash

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

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

次の例では、testKey , timestamp , ip および lang がTrimouテンプレートの有効な入力変数として存在することを前提としています。

if

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

isEq

値が等しい場合に内容を表示します。

isNotEq

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

join

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 documentationを参照してください。

unixTimestampMs

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

unless

パラメータが存在しないか、内容がない場合に内容を表示します。

uuid

ランダムに生成されたUUIDを表示します。ノンスの作成に便利です。