エンドポイント仕様

この記事では、HTTPリクエストを送信する任意のアプリケーションで使用される直接HTTPエンドポイントの仕様について説明します。

Tealium Collect URL

Tealium Collectは以下のルートURLに位置しています：

https://collect.tealiumiq.com/event

レート制限

Tealium Collect APIは、最大100リクエスト/秒のレート制限をサポートしています。

ビジネスニーズがより高い呼び出し制限を必要とする場合は、Tealiumアカウントマネージャーに連絡してください。

標準パラメータ

Tealium Collectは、各リクエストに以下の標準パラメータをサポートしています：

• tealium_account: あなたのTealiumアカウントの名前。
• tealium_profile: あなたのTealiumプロファイルの名前。デフォルトはmainです。
• tealium_datasource: オプション。Customer Data Hubからのデータソースキー。詳細については、データソースについてを参照してください。
• tealium_event: 推奨。トラッキング目的のイベント名。
• tealium_visitor_id: AudienceStream用に必須。イベントに関連付けられた訪問の一意の識別子（訪問識別子セクションを参照）。データのソースによっては、この識別子は訪問が使用しているデバイスに関連付けられた匿名のGUID（グローバル一意識別子）であるか、訪問の既知のユーザー識別子に基づいている場合があります。
• tealium_trace_id: オプション。Traceで使用します。

リクエストの形式は使用されるHTTPメソッドによって異なります。以下の例では、プレースホルダー値は次の形式で中括弧で表されています：{VALUE}。

カスタムイベントパラメータ

追跡ニーズに応じて、追加のイベント属性はカスタムパラメータとして送信されます。これらのパラメータもCustomer Data Hubでイベント属性として定義する必要があります。イベント属性についての詳細は、属性についてを参照してください。

訪問識別子

AudienceStreamは、以下の組み合わせを使用して訪問を追跡します：

• 匿名ID: 訪問を匿名で追跡するために通常使用されるID（例えば、デバイスやブラウザから）。既知の訪問の場合、ユーザー識別子に基づいた値を使用できます。
• ユーザー識別子: 訪問が既知の場合に送信されます。特定のデバイスではなく、ユーザーを識別する値に基づいています。

匿名ID

匿名IDは、AudienceStreamが訪問をイベントや訪問間で関連付けるために使用する匿名識別子です。この値はGUIDであり、訪問に対して一貫性がある必要があります。この値は、サーバーサイドプロファイルごとに一意でなければなりません。

匿名IDのキー名はtealium_visitor_idです。

ビジネスケースに応じて、匿名値または既知のユーザー識別子に基づいた値を使用できます。

匿名値

Tealium iQ Tag Managementを使用してAPIコールをサーバー間で送信し、匿名訪問プロファイルをエンリッチする場合、tealium_visitor_idの値はutag_main_v_idクッキーの値と一致する必要があります。utag.jsの組み込み変数についての詳細は、JavaScript (Web) > Data Layerを参照してください。

Adobe LaunchまたはGoogle Tag Managerを使用している場合、値はTEALクッキーのv部分と一致する必要があります。

既知の訪問サーバー間

訪問ID属性（例えばemail_address）の値が存在する場合に既知の訪問のデータを送信するとき、以下のものを連結して含めます：

• アカウント

• プロファイル
  プロファイル名を含めることで、tealium_visitor_idが各サーバーサイドプロファイルに固有であることを確実にします。これは、同じ訪問プロファイルが地域内の複数のサーバーサイドプロファイルに送信される場合に重要です。

• 訪問ID属性IDと値

  訪問ID属性IDは、属性リストの属性名の隣または展開された詳細内で見つけることができます。詳細については、属性についてを参照してください。

• tealium_visitor_idパラメータ内の値

例えば、以下の値の場合：

• アカウント名：my-account
• プロファイル：main
• 訪問ID属性ID：7688
• 伝えたい顧客番号の値：45653454

これらの値を以下の方法で連結します：

tealium_visitor_id":"__my-account_main__7688_45653454__"

tealium_visitor_idが正しくフォーマットされていることを確認してから進めてください。フォーマットが正しくないパラメータはAudienceStreamでエラーを引き起こし、適切に追跡されない可能性があります。

例 JSON：

{
    "tealium_account"    : "my-account",
    "tealium_profile"    : "main",
    "tealium_event"      : "user_login",
    "email_address"      : "user@example.com",
    "customer_number"    : "45653454", 
    "tealium_visitor_id" : "__my-account_main__7688_45653454__"
}

匿名訪問であっても既知の訪問であっても、APIコールに一貫したtealium_visitor_idが含まれていない場合、各イベントは新しい訪問を生成し、訪問のスティッチングが不可能になります。

ユーザー識別子

AudienceStreamを使用する場合、トラッキングコールに既知のユーザー識別子（例えば、email_addressやlogin_id）を渡すことができます。

ユーザー識別子は、EventStreamを使用してベンダーコネクタにIDを提供する必要がある場合にも必要です。

AudienceStreamでは、これらのユーザー識別子は訪問ID属性をエンリッチするために使用されます。

訪問の切り替え

ファーストパーティクッキーが利用できない場合、サーバーサイドは次の優先順位で受信データを使用して訪問のIDを決定します：

• TAPIDクッキー、別名tealium_thirdparty_visitor_id
• tealium_visitor_id
• utag_main v_id、別名tealium_firstparty_visitor_id

AudienceStreamは、訪問プロファイルを使用するためにTAPIDのIDを他のIDより優先するため、同じデバイス上の複数のユーザーを追跡する際に問題を引き起こす可能性があります。

たとえば、ユーザーがログインしてそのIDがTAPIDに追加された場合、そのデバイスのすべての匿名ユーザーのトラフィックはそのユーザーに記録されます。別のユーザーがそのデバイスにログインした場合、匿名クッキーがクリアされていないと仮定すると、AudienceStreamは引き続き最初のユーザーにアクティビティを記録します。訪問が共有スマートテレビや公共のキオスクを使用する場合、これにより訪問プロファイルのデータが汚染される可能性があります。

エンドポイントがイベント内のtealium_visitor_idおよびtealium_thirdparty_visitor_id値を処理する方法を制御するためのパラメータを以下に示します：

• tealium_override_tapid値は、tealium_delete_3rd_party_vid_cookiesパラメータがクッキーを削除するのを防ぎます。
• TAPIDからaccount/profile情報を削除するとそのクッキーが空になる場合、クライアントからそのクッキーを削除するためにset-cookie maxAge=0が返されます。

ボットフィルタリング

Tealiumのサーバーサイド製品を通じて収集されたデータの正確性を維持するためには、サーバーサイドのボットフィルタリングが不可欠です。

ボットトラフィックとは、サイトやアプリへの非人間による訪問を指します。Tealiumのサーバーサイド製品は、各イベントのユーザーエージェントを既知のボットのリストと比較することにより、ボットトラフィックを自動的にフィルタリングします。フィルタリングされたイベントは処理されず、使用量にはカウントされません。

ボットとして認識されるユーザーエージェントの完全なリストについては、サーバーサイドボットフィルタリングを参照してください。

方法

ブラウザからCollect APIトラフィックを送信する場合、GETメソッドはリクエストのHTTPリファラーURLに基づいてページURLを構成し、これには現在のページのホスト名のみが含まれます。GETメソッドでは、現在のページのクエリパラメーターやパス名は含まれません。この情報を含めるには、POSTメソッドを使用してください。

GET

GETメソッドは、指定されたリソースからデータを要求するために使用されます。エンドポイントのクエリ文字列にキーと値のペアを使用してデータを渡し、HTMLベースの実装と互換性を持たせるために1x1の透明GIFを返します。

curlを使用した例：

curl -i -X GET "https://collect.tealiumiq.com/event?tealium_account={ACCOUNT}&tealium_profile={PROFILE}&tealium_event=user_login&email_address=user@example.com"

POST

POSTメソッドは、データをサーバーに送信してリソースを作成/更新するために使用されます。リクエストヘッダーをContent-Type: application/jsonに構成し、ペイロードを有効なJSON文字列としてフォーマットする必要があります。

user_loginイベントの例：

{
    "tealium_account"   : "ACCOUNT",
    "tealium_profile"   : "PROFILE",
    "tealium_event"     : "EVENT_NAME",
    "email_address"     : "EMAIL_ADDRESS"
}

curlを使用した例：

curl -X POST -H 'Content-type: application/json'
--data '{"tealium_account":"{ACCOUNT}","tealium_profile":"{PROFILE}","tealium_event":"user_login","email_address":"user@example.com"}'
https://collect.tealiumiq.com/event

ステータスコード

以下の表は、TealiumのHTTPレスポンスステータスコードをまとめたものです：

400 Bad Requestステータスコードは、以下のいずれかが真である場合に発生します：

• JSONキーにピリオドが含まれている、無効である、または1MBを超える。
• ファイルタイプパラメーターにjsonまたはjavascript以外の値が含まれている。
• account、profile、およびdatalayer_idの組み合わせが250文字を超えるか、制限された文字を含んでいる。
• tealium_accountまたはtealium_profileが欠落しているか、誤植がある。
• リクエストボディが空です。

必要なtealium_accountまたはtealium_profileパラメータ値が欠落している場合の400 Bad Requestレスポンスの例を、X-Errorヘッダーで示します：

> GET /event?tealium_account=jentest-as&tealium_profile=&tealium_visitor_id=sendgeteventhttps@testing.com&tealium_datasource=utc2cj&customer_city=Honolulu&customer_state=Hawaii&Flag=true&Number=45&String=ascent&String_Array=[hello,howareyou,whatsup,yoyoyo]&Number_Array=[2.222,3.000,19.12,28.3]&Flag_Array=[true,false,false,true]&Combo_Array=[1,salutations,2324,world,22jjfssl]&Array_of_Array=[[1,2,3],heyworld]&myvariable=unicorns HTTP/1.1
> Host: qa21-collect.tealiumiq.com
> User-Agent: curl/7.54.0
> Accept: */*
>
< HTTP/1.1 400 Bad Request
< Cache-Control: no-transform,private,no-cache,no-store,max-age=0,s-maxage=0
< Content-Type: application/json
< Date: Wed, 23 Oct 2019 17:10:51 GMT
< Expires: Wed, 23 Oct 2019 17:10:51 GMT
< P3P: policyref="/w3c/p3p.xml", CP="NOI DSP COR NID CUR ADM DEV OUR BUS"
< Pragma: no-cache
< Vary: Origin
< X-Error: Missing required tealium_account or tealium_profile param value
< X-Region: us-east-1
< X-ServerID: uconnect_i-9a157d19
< X-ULVer: 1.0.331-SNAPSHOT
< X-UUID: d4fc78d1-8204-412c-a6cb-57869d2370a7
< Content-Length: 0
< Connection: keep-alive

例

HTMLの例

Tealium Collectは、HTML内の<img>タグで参照されます。ブラウザキャッシュのため、ランダムに生成された値を含む追加パラメーターであるキャッシュバスターを含めることが重要です。以下の例を参照してください：

var cb=Math.random()*100000000000;

この変数はTealium Collectピクセルのクエリ文字列に追加されます：

<img height="1" width="1" style="display:none" src="//collect.tealiumiq.com/event?tealium_account={ACCOUNT}&tealium_profile={PROFILE}&tealium_event=user_login&email_address=user@example.com&cb=' + cb + '"/>

JavaScriptの例

Tealium Collectはクロスドメインリクエストをサポートしており、以下の例のように、あなたのウェブサイトから私たちのドメインへPOSTを送信することができます：

var event = {
    "tealium_account" : "ACCOUNT",
    "tealium_profile" : "PROFILE",
    "tealium_event"   : "EVENT_NAME",
    "email_address"   : "EMAIL_ADDRESS"};
var xhr = new XMLHttpRequest();
xhr.open("POST", "https://collect.tealiumiq.com/event");
xhr.send(JSON.stringify(event));

レスポンスヘッダーには以下が含まれます：

Access-Control-Allow-Origin: [http://your_domain.com](http://your_domain.com)