アクションパラメーター
この記事では、Webhookコネクタのアクションの構成方法について説明します。
コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタを追加する方法の詳細については、コネクタの管理を参照してください。
コネクタを追加した後、次の構成を構成します:
- 基本認証 - ユーザー名
APIエンドポイントが基本認証を必要とする場合は、ユーザー名を入力します。 - 基本認証 - パスワード
APIエンドポイントが基本認証を必要とする場合は、パスワードを入力します。
コネクタの構成が完了したら、完了をクリックします。
アクション構成 - パラメーターとオプション
コネクタのアクションを構成するために、続行をクリックします。アクションの名前を入力し、ドロップダウンメニューからアクションのタイプを選択します。
以下のセクションでは、各アクションのパラメーターとオプションの構成方法について説明します。
アクション - HTTPリクエストを使用してイベントデータを送信
パラメーター
パラメーター | 説明 |
---|---|
メソッド | 必須。 リクエストメソッドを選択します。GETが選択された場合、イベントデータはJSON URLエンコードされたクエリ文字列パラメーターとしてデータキーで配信されます。 |
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 Send Custom Request Guideを参照してください。 |
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などの複雑なペイロードが必要な場合、ベンダーのエンドポイントで必要な形式のペイロードを構築するためにテンプレートオプションを使用します。カスタムリクエストにテンプレートを使用する詳細については、カスタムリクエストの送信 - テンプレート変数ガイドを参照してください。
バッチ制限
このアクションでは、ベンダーへの高容量データ転送をサポートするためにバッチリクエストを使用します。リクエストは、次の3つの閾値のいずれかが満たされるまでキューに入れられます:
- 最大リクエスト数:100
- 最も古いリクエストからの経過時間の最大値:60分
- リクエストの最大サイズ:16 MB
パラメーター
パラメーター | 説明 |
---|---|
メソッド | 必須。 リクエストメソッドを選択します。詳細については、Webhook Send Custom Request Guideを参照してください。 |
URL | 必須。 リクエストを送信するURLを指定します。テンプレートサポート:テンプレートからURLを生成するためのテンプレート名を参照します。 |
ボディのコンテンツタイプ | 使用可能なタイプを選択するか、カスタム値を指定します。すべてのタイプはUTF-8でエンコードされ、ヘッダーとして追加されます。例:Content-Type: text/plain; charset=UTF-8 。ボディデータが提供される場合は、コンテンツタイプが必要です。 |
ボディデータ | メッセージボディを構築するためのデータを提供します。テンプレートサポート:テンプレートからボディデータを生成するためのテンプレート名を参照します。ボディのコンテンツタイプがmultipart/form-data またはapplication/x-www-form-urlencoded の場合は、値を名前にマッピングします。それ以外の場合は、テンプレート名を参照してボディオプションのみを選択します。 |
プレフィックス | リクエストのボディデータの前に繰り返ししない部分を指定します。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
}
}
最終更新日 :: 2024年March月29日