アクションパラメータ
この記事では、Webhookコネクタアクションの構成方法について説明します。
コネクタマーケットプレイスに移動して、新しいコネクタを追加します。コネクタを追加する一般的な手順については、コネクタの管理を参照してください。
コネクタを追加した後、以下の構成を構成します:
- 基本認証 - ユーザー名
APIエンドポイントが基本認証を要求する場合はユーザー名を入力 - 基本認証 - パスワード
APIエンドポイントが基本認証を要求する場合はパスワードを入力
コネクタの構成が完了したら、完了をクリックします。
アクション構成 - パラメータとオプション
続行をクリックしてコネクタアクションを構成します。アクションの名前を入力し、ドロップダウンメニューからアクションタイプを選択します。
次のセクションでは、各アクションのパラメータとオプションの構成方法について説明します。
アクション - HTTPリクエストを介してイベントデータを送信
パラメータ
パラメータ | 説明 |
---|---|
メソッド | 必須。 リクエストメソッドを選択します。GETが選択された場合、イベントデータはJSON URLエンコードされたクエリ文字列パラメータとしてdata キーで配信されます。 |
URL | 必須。 リクエストを送信するURLを提供します。テンプレートサポート:テンプレート名を参照してURLを生成します。 |
URLパラメータ | URLに追加するパラメータを提供します。テンプレートサポート:テンプレート名を参照してパラメータ値を生成します。 |
ヘッダー | HTTPヘッダー値をヘッダー名にマッピングします。テンプレートサポート:テンプレート名を参照してヘッダー値を生成します。 |
クッキー | クッキー値をクッキー名にマッピングします。クッキーは単一のHTTPヘッダー値として追加されます。例:Cookie: name1=value1; name2=value2 。テンプレートサポート:テンプレート名を参照してクッキー値を生成します。 |
本文コンテンツタイプ | 利用可能なタイプを選択するか、カスタム値を提供します。すべてのタイプはUTF-8エンコードされ、ヘッダーとして追加されます。例:Content-Type: text/plain; charset=UTF-8 。本文データが提供される場合、コンテンツタイプは必須です。 |
テンプレート変数 | テンプレートのデータ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数を名前付けします。例:items.name 。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 |
テンプレート | URL、URLパラメータ、ヘッダー、または本文データで参照されるテンプレートを提供します。詳細については、コネクタテンプレートについてを参照してください。テンプレートは名前でサポートされるフィールドに二重中括弧で注入されます。例:{{SomeTemplateName}} 。OAuthを使用する場合、テンプレート変数{{webhook_access_token}} は認証リクエストによって返されるトークンを参照します。 |
属性名の印刷 | 属性名が更新されると、ペイロードの名前が更新を反映します。 |
リダイレクション | メソッドがGETの場合のみリダイレクションを許可します。 |
アクション - HTTPリクエストを介して訪問データを送信
パラメータ
パラメータ | 説明 |
---|---|
メソッド | 必須。 リクエストメソッドを選択します。GETが選択された場合、訪問データはJSON URLエンコードされたクエリ文字列パラメータとしてdata キーで配信されます。 |
URL | 必須。 リクエストを送信するURLを提供します。テンプレートサポート:テンプレート名を参照してURLを生成します。 |
URLパラメータ | URLに追加するパラメータを提供します。テンプレートサポート:テンプレート名を参照してパラメータ値を生成します。 |
ヘッダー | HTTPヘッダー値をヘッダー名にマッピングします。テンプレートサポート:テンプレート名を参照してヘッダー値を生成します。 |
クッキー | クッキー値をクッキー名にマッピングします。クッキーは単一のHTTPヘッダー値として追加されます。例:Cookie: name1=value1; name2=value2 。テンプレートサポート:テンプレート名を参照してクッキー値を生成します。 |
本文コンテンツタイプ | 利用可能なタイプを選択するか、カスタム値を提供します。すべてのタイプはUTF-8エンコードされ、ヘッダーとして追加されます。例:Content-Type: text/plain; charset=UTF-8 。本文データが提供される場合、コンテンツタイプは必須です。 |
テンプレート変数 | テンプレートのデータ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数を名前付けします。例:items.name 。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 |
テンプレート | URL、URLパラメータ、ヘッダー、または本文データで参照されるテンプレートを提供します。詳細については、コネクタテンプレートについてを参照してください。テンプレートは名前でサポートされるフィールドに二重中括弧で注入されます。例:{{SomeTemplateName}} 。OAuthを使用する場合、テンプレート変数{{webhook_access_token}} は認証リクエストによって返されるトークンを参照します。 |
現在の訪問データを含む | 現在の訪問データを含める場合はこのボックスをチェックします。 |
属性名の印刷 | 属性名が更新されると、ペイロードの名前が更新を反映します。 |
リダイレクション | メソッドがGETの場合のみリダイレクションを許可します。 |
アクション - HTTPリクエストを介してカスタマイズされたデータを送信(高度)
カスタムリクエストが複雑なペイロード、例えばネストされたJSONやXMLを必要とする場合、テンプレートオプションを使用してベンダーのエンドポイントに必要な形式のペイロードを構築します。詳細については、コネクターテンプレート変数を参照してください。
パラメータ
パラメータ | 説明 |
---|---|
メソッド | 必須。 リクエストメソッドを選択します。詳細については、Webhookカスタムリクエストガイドを参照してください。 |
URL | 必須。 リクエストを送信するURLを提供します。テンプレートサポート:テンプレート名を参照してURLを生成します。 |
URLパラメータ | オプション。URLに追加するパラメータを提供します。テンプレートサポート:テンプレート名を参照してパラメータ値を生成します。 |
ヘッダー | HTTPヘッダー値をヘッダー名にマッピングします。テンプレートサポート:テンプレート名を参照してヘッダー値を生成します。 |
クッキー | クッキー値をクッキー名にマッピングします。クッキーは単一のHTTPヘッダー値として追加されます。例:Cookie: name1=value1; name2=value2 。テンプレートサポート:テンプレート名を参照してクッキー値を生成します。 |
本文コンテンツタイプ | 利用可能なタイプを選択するか、カスタム値を提供します。すべてのタイプはUTF-8エンコードされ、ヘッダーとして追加されます。例:Content-Type: text/plain; charset=UTF-8 。本文データが提供される場合、コンテンツタイプは必須です。 |
本文データ | メッセージ本文を構築するためのデータを提供します。テンプレートサポート:テンプレート名を参照して本文データを生成します。本文コンテンツタイプがmultipart/form-data またはapplication/x-www-form-urlencoded の場合は、値を名前にマッピングします。それ以外の場合は、テンプレート名を参照して本文オプションのみを選択します。 |
テンプレート変数 | テンプレートのデータ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数を名前付けします。例:items.name 。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 |
テンプレート | URL、URLパラメータ、ヘッダー、または本文データで参照されるテンプレートを提供します。詳細については、コネクタテンプレートについてを参照してください。テンプレートは名前でサポートされるフィールドに二重中括弧で注入されます。例:{{SomeTemplateName}} 。OAuthを使用する場合、テンプレート変数{{webhook_access_token}} は認証リクエストによって返されるトークンを参照します。 |
アクション - HTTPリクエストを介してバッチ処理されたカスタマイズデータを送信(高度)
カスタムリクエストが複雑なペイロード、例えばネストされたJSONやXMLを必要とする場合、テンプレートオプションを使用してベンダーのエンドポイントに必要な形式のペイロードを構築します。カスタムリクエスト用のテンプレートを使用する方法の詳細については、カスタムリクエスト - テンプレート変数ガイドを参照してください。
Traceを使用する場合、バッチ処理は無視されます。
バッチ制限
このアクションは、ベンダーへの大量データ転送をサポートするためにバッチリクエストを使用します。リクエストは、以下のいずれかの閾値に達するまでキューに入れられます:
- リクエストの最大数:100
- 最も古いリクエストからの経過時間(生存時間、TTL):1分から60分の間
- リクエストの最大サイズ:16 MB
パラメータ
パラメータ | 説明 |
---|---|
メソッド | 必須。 リクエストメソッドを選択します。詳細については、Webhook送信カスタムリクエストガイドを参照してください。 |
URL | 必須。 リクエストを送信するURLを提供します。テンプレートサポート:テンプレート名を参照してURLを生成します。 |
ボディコンテンツタイプ | 利用可能なタイプを選択するか、カスタム値を提供します。すべてのタイプはUTF-8でエンコードされ、ヘッダーとして追加されます。例:Content-Type: text/plain; charset=UTF-8 ボディデータが提供されている場合、コンテンツタイプは必須です。 |
ボディデータ | メッセージボディを構築するためのデータを提供します。テンプレートサポート:テンプレート名を参照してボディデータを生成します。ボディコンテンツタイプがmultipart/form-data またはapplication/x-www-form-urlencoded の場合は、値を名前にマッピングします。それ以外の場合は、テンプレート名を参照してBody オプションのみを選択します。 |
プレフィックス | ボディデータの前に繰り返されないリクエストの部分です。JSON配列のプレフィックスは開き括弧([ )です。例としてCustom [ をプレフィックスにマッピングします。例:[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ] |
ジョイナー | ボディデータ内の個々のデータ項目を分離する文字または文字列です。JSONオブジェクトのジョイナーはカンマ(, )です。例としてCustom , をジョイナーにマッピングします。例:[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ] |
サフィックス | ボディデータの後に繰り返されないリクエストの部分です。JSON配列のプレフィックスは閉じ括弧(] )です。例としてCustom ] をサフィックスにマッピングします。例:[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers: true } ] |
レコード数の最大値 | 最大レコード数。 |
生存時間(分) | 分単位の生存時間。 |
URLパラメータ | URLに追加するパラメータを提供します。テンプレートサポート:テンプレート名を参照してパラメータ値を生成します。 |
ヘッダー | HTTPヘッダー値をヘッダー名にマッピングします。テンプレートサポート:テンプレート名を参照してヘッダー値を生成します。 |
クッキー | クッキー値をクッキー名にマッピングします。クッキーは単一のHTTPヘッダー値として追加されます。例:Cookie: name1=value1; name2=value2 。テンプレートサポート:テンプレート名を参照してクッキー値を生成します。 |
テンプレート変数 | テンプレートにデータ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数を名前付けします。例:items.name 。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。 |
テンプレート | URL、URLパラメータ、ヘッダー、またはボディデータで参照されるテンプレートを提供します。詳細については、コネクタテンプレートについてを参照してください。テンプレートは名前で二重中括弧によってサポートされるフィールドに注入されます。例:{{SomeTemplateName}} 。OAuthを使用する場合、テンプレート変数{{webhook_access_token}} は認証リクエストによって返されるトークンを参照します。 |
イベントデータJSON
イベントに含まれる予想されるJSONペイロードには、イベントの一部であるすべての標準属性と、イベントを送信したプラットフォームに固有の追加属性が含まれます。例えば、ウェブサイトから受信したイベントにはDOMおよびクッキー属性が含まれ、モバイルデバイスから受信したイベントにはデバイスおよびキャリア属性が含まれます。
イベントデータJSONオブジェクトの形式例:
{
"account": "tealium",
"profile": "main",
"env": "prod",
"data": {
"dom": {
"referrer": "",
"domain": "tealium.com",
"title": "Tealium | Customer Data Hub and Enterprise Tag Management",
"query_string": "",
"url": "http://tealium.com/",
"pathname": "/"
},
"udo": {
"tealium_event": "page_view",
"page_name": "Tealium | Customer Data Hub and Enterprise Tag Management",
"page_type": "home",
"device_type": "desktop"
},
"firstparty_tealium_cookies": {
"trace_id": "",
"s_fid": "3EF757DF6253B144-0D0194366CD4479B",
"utag_main_ses_id": 1383677957942,
"s_cc": "true",
"utag_main__st": 1383678970903,
"TID": "2cff51e585ed4a5a9330324d5dbc6bb7",
"s_sq": "[[B]]"
}
},
"post_time": 1500999541000,
"useragent": "PostmanRuntime/6.1.6",
"event_id": "1a1ee055-1456-46f8-ab4d-779628c05dd4",
"visitor_id": "1a1ee055145646f8ab4d779628c05dd4"
}
訪問データJSON
訪問に関連するすべての適用可能な訪問属性を含む訪問の予想されるJSONペイロードです。データオブジェクトは属性タイプ別に整理されています。属性が割り当てられていない場合、訪問オブジェクトには表示されません。現在の訪問に関するデータもcurrent_visit
キーの下に含まれます。
訪問データJSONオブジェクトの形式例:
{
"metrics": {
"Weeks since first visit": 0.0,
"Lifetime visit count": 1.0,
"Lifetime event count": 1.0,
"Total direct visits": 1.0
},
"dates": {
"Last visit": 1500999541000,
"last_visit_start_ts": 1500999541000,
"First visit": 1500999541000
},
"properties": {
"profile": "main",
"visitor_id": "1a1ee055145646f8ab4d779628c05dd4",
"account": "tealium"
},
"flags": {
"Is Registered": false
},
"audiences": [
"New Users"
],
"badges": [
"Product Browser"
],
"preloaded": false,
"creation_ts": 1500999541000,
"_id": "1a1ee055145646f8ab4d779628c05dd4",
"_partition": 0,
"shard_token": 0,
"current_visit": {
"metrics": {
"Event count": 1.0
},
"dates": {
"Visit start": 1500999541000,
"last_event_ts": 1500999541000
},
"properties": {
"Active browser type": "Chrome",
"Active operating system": "MacOS",
"Active browser version": "53",
"Active platform": "browser",
"Active device": "other"
},
"flags": {
"Direct visit": true
},
"property_sets": {
"Active devices": [
"other"
],
"Active browser versions": [
"53"
],
"Active operating systems": [
"MacOS"
],
"Active platforms": [
"browser"
],
"Active browser types": [
"Chrome"
]
},
"creation_ts": 1500999541000,
"_id": "9a20caf81d4adc55cfb958da81a513feff62e3324e9f840ed8bf28ca8a39a37d",
"shard_token": 0,
"_dc_ttl_": 60000,
"total_event_count": 1,
"events_compressed": false
},
"_dctrace": [
"local_visitor_processor_visitor_processor"
],
"new_visitor": true,
"audiences_joined_at": {
"tealium_main_101": 1500999542434
}
}
最終更新日 :: 2025年June月13日