テンプレートを使用して高度なコネクタリクエストを作成する方法について説明します。
概要
コネクタテンプレートとテンプレート変数を使用すると、コネクタ用のカスタムAPIリクエストを作成できます。これらを使用して、JSONやXMLなど、ベンダーのエンドポイントで必要とされる形式のペイロードを動的に生成できます。
テンプレートはAPIリクエストの構造を定義し、テンプレート変数は動的な値を提供します。
以下は、テンプレート変数にマッピングされた属性の例です。
これらの変数の値の例を次に示します。
email = "user@example.com"
orderTotal = 9.99
orderID = "0123456789"
以下は、これらの変数を使用するテンプレートの例です。
{
"order": {
"customerEmail": "{{email}}",
"total": {{orderTotal}},
"id": "{{orderID}}"
}
}
以下は、変数のプレースホルダーがその値に置き換えられた、レンダリング済みのテンプレートです。
{
"order": {
"customerEmail": "user@example.com",
"total": 9.99,
"id": "0123456789"
}
}
テンプレート
テンプレートは、APIリクエストの設計図です。受信側のエンドポイントで必要とされる構造と形式を指定します。
リクエストの各コンポーネントには個別のテンプレートが用意されているため、ベンダーAPIの要件に正確に対応できます。
- ヘッダー:認証トークン、メディアタイプ、ベンダーが必要とするカスタムヘッダーなどのリクエストヘッダーを構成します。
- URL:エンドポイントURLをカスタマイズします。テンプレート変数を使用して、ホスト名またはパスの動的パラメータを置き換えます。送信するデータに応じてエンドポイントやリソースパスが変わる場合に便利です。
- URLパラメータ:エンドポイントにクエリ文字列を動的に追加します。このテンプレートを使用して、URLのクエリ文字列パラメータ全体を追加または変更します。このテンプレートの結果はURLテンプレートの結果と組み合わされ、最終的なリクエストエンドポイントURLが作成されます。
- 本文:リクエスト用のカスタムペイロード本文を作成します。
- カスタム:独自のテンプレートを作成して名前を付け、リクエストの任意の部分にマッピングします。
コネクタでは、URL、クエリパラメータ、ヘッダー、本文に動的な値が必要になる場合があります。以下の例は、各テンプレートタイプの使用方法を示しています。
URL
URLテンプレートは、送信リクエストのURLエンドポイントを構成します。テンプレートでレンダリングされる値には、https://からクエリ文字列の?までのすべてを含める必要があります。クエリ文字列を構成する方法については、URLパラメータを参照してください。
このURLテンプレートは、パスのアカウントID部分を動的に構成します。このオプションは、データソースのリージョン、サイト、または環境に応じてベンダーが異なるエンドポイントを必要とする場合に役立ちます。この例では、アカウントIDの値を持つ属性からテンプレート変数accountIDへのマッピングが必要です。
https://api.example.com/track/{{accountID}}/
URLパラメータ
URLパラメータテンプレートは、送信リクエストのURLエンドポイントに対するクエリ文字列を構成します。テンプレートでレンダリングされた値は、クエリ文字列文字?を使用してリクエストのURLに結合されます。
このURLパラメータテンプレートは、動的なorder_idパラメータと静的なsourceパラメータを含むクエリ文字列を作成します。
order_id={{orderID}}&source=tealium
このテンプレートを前述のURLテンプレートとともに使用した場合、最終的にレンダリングされるURLは次のようになります。
https://api.example.com/track/ABC123/?order_id=0123456789&source=tealium
ヘッダー
ヘッダーテンプレートは、送信リクエストのヘッダーに追加されます。このテンプレートを使用して、認証やベンダーエンドポイントのその他の特別な要件に必要なカスタムヘッダーを追加します。
このヘッダーテンプレートは、動的に作成されたハッシュを使用してリクエストのセキュリティを維持するためのカスタムヘッダーを指定します。この例では、マッピングされた属性または別のカスタムテンプレートから構成されるテンプレート変数secretHashが必要です。
X-Secret: {{secretHash}}
本文テンプレート
本文テンプレートは、リクエストペイロードを構成します。
この本文テンプレートは、ユーザーのメールアドレス、注文合計、商品リストの動的な値を含むJSONペイロードを作成します。
{
"order": {
"customerEmail": "{{email}}",
"total": {{orderTotal}},
"id": "{{orderID}}"
}
}
テンプレート変数
テンプレート変数は、テンプレートに動的データを提供する属性マッピングです。
たとえば、動的な注文ID値をテンプレートに含めるには、属性order_idをorderIDという名前のテンプレート変数にマッピングします。次に、テンプレート内で注文ID値を表示する位置に{{orderID}}を記述します。
詳細については、コネクターテンプレート変数を参照してください。
構文
以下の例は、テンプレート変数を参照し、テンプレート内に制御構造を作成するための構文を示しています。
変数
変数は、テンプレート内で置き換えられる値を表します。変数の値を参照するには、変数名を二重波かっこで囲みます(例:{{var}})。
以下の例では、テンプレート変数{{str}}がその値Helloに置き換えられます。
| テンプレート | レンダリングされた値 |
|---|---|
{{str}} world | Hello world |
配列
以下の例では、インデックスを指定して参照することで、数値配列{{arrn}}の先頭の値を取得します。
| テンプレート | レンダリングされた値 |
|---|---|
The first value is {{arrn.0}} | The first value is 1.0 |
The second value is {{arrn.1}} | The second value is 2.0 |
The third value is {{arrn.2}} | The third value is 3.0 |
セクション
{{#var}} {{/var}}タグで囲まれたコンテンツのセクションは、指定されたキーに対応するオブジェクトが見つかった場合にレンダリングされます。これには、値がtrueのブール値、空ではない集計値、空ではない配列が含まれます。
以下の例では、ブール変数blnがtrueであるため、コンテンツがレンダリングされます。値がfalseの場合、コンテンツはレンダリングされません。
| テンプレート | レンダリングされた値 |
|---|---|
{{#bln}}Section of content{{/bln}} | Section of content |
以下の例では、文字列配列arrsが空ではないため、配列の各要素について1回ずつ、コンテンツが3回レンダリングされます。配列が空の場合、コンテンツはレンダリングされません。
| テンプレート | レンダリングされた値 |
|---|---|
{{#arrs}}Section of content.{{/arrs}} | Section of content.Section of content.Section of content. |
反転セクション
{{^var}} {{/var}}タグで囲まれたコンテンツのセクションは、コンテキスト内にオブジェクトが見つからない場合にレンダリングされます。これには、値がfalseのブール値、空の集計値、空の配列が含まれます。
以下の例では、blnがtrueであるため、コンテンツはレンダリングされません。値がfalseの場合は、コンテンツがレンダリングされます。
| テンプレート | レンダリングされた値 |
|---|---|
Section of {{^bln}}content{{/bln}} | Section of |
以下の例では、変数missingが定義されていないため、コンテンツがレンダリングされます。
| テンプレート | レンダリングされた値 |
|---|---|
{{^missing}}Section of content{{/missing}} | Section of content |
反復処理
テンプレートには、配列を反復処理するためのヘルパー関数が複数用意されています。
以下の組み込み反復処理ヘルパーがサポートされています。
iter.index(最初の要素のインデックスは1)iter.isFirstiter.isLastiter.hasNext
単一配列の例
次の例では、ブール値の配列を変数 arrb にマッピングし、その配列を反復処理する方法を示します。
テンプレート
{
"MyData": [
{{#arrb}}
{
"idx": {{iter.index}},
{{#iter.isFirst}}"first": true,{{/iter.isFirst}}
{{#iter.isLast}}"last": true,{{/iter.isLast}}
"val": {{.}}
}{{#iter.hasNext}},{{/iter.hasNext}}
{{/arrb}}
]
}
| 構文 | 説明 |
|---|---|
{{#arrb}} ... {{/arrb}} | 配列を反復処理します。 |
{{iter.index}} | 1から始まる現在の反復インデックスです。 |
{{#iter.isFirst}} "first": true, {{/iter.isFirst}} | 最初の反復の場合にレンダリングされます。 |
{{#iter.isLast}} "last": true, {{/iter.isLast}} | 最後の反復の場合にレンダリングされます。 |
{{#iter.hasNext}}, {{/iter.hasNext}} | 反復に次の要素がある場合にカンマをレンダリングします。 |
{{.}} | 現在の配列値をレンダリングします。 |
レンダリングされた値
{
"MyData": [
{
"idx": 1,
"first": true,
"val": true,
},
{
"idx": 2,
"val": true,
},
{
"idx": 3,
"last": true,
"val": false,
}
]
}
tally属性は反復処理をサポートしています。次の例では、tallyを変数 tly にマッピングし、entrySet を使用してtallyの各項目を反復処理します。tally内の各項目について、key と value を参照します。
テンプレート
{
"MyTally": {
{{#each tly.entrySet}}
"{{key}}": {{value.toInteger}}{{#iter.hasNext}},{{/iter.hasNext}}
{{/each}}
}
}
レンダリングされた値
"MyTally": {
"A": "1",
"B": "2",
"C": "3"
}
整列配列の例
整列配列は、同じ長さを持つ配列のグループです。これを使用すると、各反復処理で同じインデックス位置にある各配列の対応する要素を参照できます。
整列配列を、同じプレフィックスで始まり、その後にドットと個々の配列名が続く名前にマッピングします。たとえば、次のスクリーンショットは、prods.(name) にマッピングされたすべての商品配列を示しています。

その後、prods オブジェクトも配列であるかのように反復処理し、その内部の配列を名前で参照できます。
{{#prods}}
{
"price": {{prices}},
"currency": "{{currency}}",
"quantity": {{quantities}}
}{{#iter.hasNext}},{{/iter.hasNext}}
{{/prods}}
属性の入力値が次の場合:
- 最新のカート商品価格:
[83, 23.49] - 最新のカート商品数量:
[1, 2] - 最新のカート商品通貨:
["GBP", "GBP"]
出力は次のようになります。
"products": [
{
"price": 83,
"currency": "GBP",
"quantity": 1
},
{
"price": 23.49,
"currency": "GBP",
"quantity": 2
}
]
上記の product_quantities の例のように、属性を複数回マッピングすることもできます。これにより、prods オブジェクトの外部で配列を個別に使用できます。
"total_quantity": {{product_quantities.sum}}
これにより、次の出力が生成されます。
"total_quantity": 3
最後に、整列配列の反復処理メソッドはCDH配列型でのみ機能することに注意してください。Event Streamingで利用できる、Tag Managementからインポートされた「Any」データ型では機能しません。これらを使用するには、CDH配列型に変換する必要があります。
受信データが常に配列であることが分かっている場合は、既存のTealium iQ属性をサーバー側CDHから削除し、CDH配列属性として再追加できます。
データが常に配列であるか不明な場合、またはTealium iQ属性に対するCDHの依存関係が多すぎる場合は、次のようにEvent Streamingのエンリッチメントを使用して、受信データが配列であるときにTealium iQ属性の配列コピーを作成できます。

ヘルパー関数
テンプレートに追加機能を提供するため、複数のヘルパー関数がサポートされています。
詳細については、テンプレートヘルパー関数を参照してください。
リファレンス
コネクターテンプレートは、MustacheをベースとするJavaテンプレートエンジンのTrimou上に構築されています。
最終更新日 :: 2026年November月18日