アクションパラメータ | Webhookコネクタ

コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法の一般的な指示については、コネクタの管理を参照してください。

コネクタを追加した後、以下の構成を行います：

基本認証 - ユーザー名
APIエンドポイントが基本認証を必要とする場合は、ユーザー名を入力します
基本認証 - パスワード
APIエンドポイントが基本認証を必要とする場合は、パスワードを入力します

コネクタの構成が完了したら、完了をクリックします。

アクション構成 - パラメータとオプション

続行をクリックして、コネクタアクションを構成します。アクションの名前を入力し、ドロップダウンメニューからアクションタイプを選択します。

以下のセクションでは、各アクションのパラメータとオプションの構成方法について説明します。

アクション - HTTPリクエスト経由でイベントデータを送信

パラメータ

パラメータ	説明
Method	必須。リクエストメソッドを選択します。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リクエスト経由で訪問データを送信

パラメータ

パラメータ	説明
Method	必須。リクエストメソッドを選択します。GETが選択された場合、訪問データは`data`キーを持つ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リクエスト経由でカスタマイズデータを送信（高度）

カスタムリクエストが複雑なペイロード（ネストされたJSONやXMLなど）を必要とする場合、テンプレートオプションを使用して、ベンダーのエンドポイントが必要とする形式のペイロードを構築します。カスタムリクエストのテンプレート使用についての詳細は、カスタムリクエストの送信 - テンプレート変数ガイドを参照してください。

パラメータ

パラメータ	説明
Method	必須。リクエストメソッドを選択します。詳細については、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`の場合は、値を名前にマッピングします。それ以外の場合は、テンプレート名を参照し、Bodyオプションのみを選択します。
テンプレート変数	テンプレートのデータ入力としてテンプレート変数を提供します。詳細については、テンプレート変数ガイドを参照してください。ネストされたテンプレート変数はドット表記法で名前を付けます。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から作成されます。
テンプレート	URL、URLパラメータ、ヘッダー、またはボディデータのいずれかで参照されるテンプレートを提供します。詳細については、テンプレートガイドを参照してください。テンプレートは、名前でサポートされているフィールドに二重中括弧で注入されます。例：`{{SomeTemplateName}}`。OAuthを使用する場合、テンプレート変数`{{webhook_access_token}}`は認証リクエストによって返されるトークンを参照します。

アクション - HTTPリクエスト経由でバッチ化されたカスタマイズデータを送信（高度）

Traceを使用するときはバッチ処理が無視されます。

バッチ制限

このアクションは、ベンダーへの大量データ転送をサポートするためにバッチリクエストを使用します。リクエストは、以下の3つの閾値のいずれかが満たされるまでキューに入れられます：

リクエストの最大数：100
最古のリクエストからの時間（Time to Live、TTL）：1から60分間
リクエストの最大サイズ：16 MB

パラメータ

パラメータ	説明
Method	必須。リクエストメソッドを選択します。詳細については、Webhook Send Custom Request Guideを参照してください。
URL	必須。リクエストを送信するURLを提供します。テンプレートサポート：テンプレート名を参照してURLを生成します。
Body Content Type	利用可能なタイプを選択するか、カスタム値を提供します。すべてのタイプはUTF-8でエンコードされ、ヘッダーとして追加されます。例：`Content-Type: text/plain; charset=UTF-8` ボディデータが提供されている場合、コンテンツタイプが必要です。
Body Data	メッセージボディを構築するためのデータを提供します。テンプレートサポート：テンプレート名を参照してボディデータを生成します。ボディコンテンツタイプが`multipart/form-data`または`application/x-www-form-urlencoded`の場合は、名前に値をマップします。それ以外の場合は、テンプレート名を参照し、`Body`オプションのみを選択します。
Prefix	Body Dataの前にあるリクエストの非反復部分。JSON配列のプレフィックスは開き括弧(`[`)です。`Custom [`をPrefixにマップします。例： `[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ]`
Joiner	Body Data内の個々のデータ項目を区切る文字または文字列。JSONオブジェクトのジョイナーはカンマ(`,`)です。`Custom ,`をJoinerにマップします。例： `[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ]`
Suffix	Body Dataの後にあるリクエストの非反復部分。JSON配列のプレフィックスは閉じ括弧(`]`)です。`Custom ]`をSuffixにマップします。例： `[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ]`
Record Count Maximum	レコード数の最大値。
Time To Live (minutes)	生存時間（分）。
URL Parameters	URLに追加するパラメータを提供します。テンプレートサポート：テンプレート名を参照してパラメータ値を生成します。
Headers	HTTPヘッダー値をヘッダー名にマップします。テンプレートサポート：テンプレート名を参照してヘッダー値を生成します。
Cookies	クッキー値をクッキー名にマップします。クッキーは単一のHTTPヘッダー値として追加されます。例：`Cookie: name1=value1; name2=value2`。テンプレートサポート：テンプレート名を参照してクッキー値を生成します。
Template Variables	テンプレートのデータ入力としてテンプレート変数を提供します。詳細については、Template Variables Guideを参照してください。ネストしたテンプレート変数はドット表記法で名前を付けます。例：`items.name` ネストしたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
Templates	URL、URLパラメータ、ヘッダ、またはBody Dataで参照されるテンプレートを提供します。詳細については、Templates Guideを参照してください。テンプレートは、サポートされるフィールドに二重中括弧で名前を付けて注入されます。例：`{{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
    }
}