__________________________________________________________________________________________________________________
本項の目的:
- 3rdパーティクッキーピクセル方式からサーバー間通信方式(S2S)への切り替え方法についてご案内いたします。
__________________________________________________________________________________________________________________
目次
概要
このガイドでは既存の3rdパーティピクセル方式での計測からサーバー間計測方式(S2S)への切り替えに必要な手順をご案内いたします。
本番計測を中断することなく切替を行うため、切替に問題がないことの確認が取れるまでは、現在動作している3rdパーティピクセル方式での計測に並行して追加する形でS2Sのテストを行ってください。
S2S方式ではPOSTまたはGETを介したPartnerizeトラッキングAPIへの直接の安全なHTTP呼び出しによって実現します。S2S方式では広告主のウェブページにタグを置かないため、ユーザーのブラウザ操作の影響を受けず、また、3rdパーティクッキーの使用もないため、セキュリティと精度が向上し、信頼性の高い計測を行うことが可能になります。
事前準備 :
このガイドに従って作業を進める前に以下項目についてご確認ください :
- 現在3rdパーティクッキーピクセル方式でのPartnerizeの計測を行われていること。
- Partnerizeタグへの切替も併せて検討したこと。
- もし現在、タグマネージャーツールのPartnerizeテンプレートやeコマースプラットフォーム連携(例. Google Tag manager, Shopify, Magento)での計測を行われており、計測方法の更新を望まれる場合はintegrations.support@partnerize.com にご連絡ください。
__________________________________________________________________________________________________________________
実装の流れ
ステージ | 概要 | 担当 |
1. clickrefの1stパーティストレージへの格納処理の実装 (広告主様) | ランディングページ(LP)にPartnerizeから送付されるclickrefを1stパーティストレージに格納する処理を実装します。 | 広告主様 |
2. S2S方式でのテストコンバージョン処理の実装 | 「TEST-」をつけたS2S方式のテストコンバージョンAPIの送信処理を、現在使用されている3rdパーティピクセルタグには変更を加えず別に追加する形で実装します。 | 広告主様 |
3. Partnerizeへの実装完了連絡 | 実装完了後、Partnerizeにご連絡ください。 | 広告主様 |
4 .「TEST-」データの確認 | 本番計測と「TEST-」をつけたS2Sのテストコンバージョンからのデータを比較し、確認を行います。 | Partnerize |
5. S2S方式の本番反映 | S2S方式を本番反映するよう実装してください。 | Partnerize |
6. 本番切替後確認 |
S2S方式の計測が本番環境で正しく行われているか確認してください。 |
広告主様 & Partnerize |
__________________________________________________________________________________________________________________
実装手順
Step 1 - clickrefの1stパーティストレージへの格納処理の実装 (広告主様)
Partnerizeのリンクを使用したランディングページへの遷移時にPartnerize ID(clickref)を付与する設定を行います。
- E.g) https://www.brand-site.com?clickref=ABC1234
広告主はclickrefの値を1stパーティストレージに格納する必要があります。このclickrefを購入/申込完了時にPartnerizeにコンバージョン情報の一つとして送り返すことで、どのパートナーからの流入で発生した成果かを判定することが可能となります。
- E.g) https://www.brand-site.com?clickref=DEF456
clickrefは常に最新のものを格納するよう処理を実装することで、最新の流入経路となったパートナーに対して成果を払うとこが可能となります。
❗注:
- clickrefの1stパーティストレージの格納処理は、本番の計測の切り替えを行うまでの期間としてクッキー有効期限として指定した日数行っておくことを推奨しています。クッキー有効期限の保持期間を設けることで、切替により3rdパーティクッキーを使用した流入からの成果の計測漏れを防ぎます。
- clickrefはPartnerizeが発行するクリック毎のIDとなっており、クリックに関わる情報と紐づいています。(流入元パートナー、使用されたクリエイティブ、対象キャンペーン、クリック日時、等)
__________________________________________________________________________________________________________________
Step 2 - S2S方式でのテストコンバージョン処理の実装 (広告主様)
3rdパーティピクセル方式からS2S方式への切り替えに問題がないことを確認するため、まずは「TEST-」をつけた形でテストコンバージョンを送信できるように実装します。このテストコンバージョンの実装時は、現在動作している3rdパーティピクセルに変更を加えることなく、新規に追加する形で実装を行ってください。
❗重要 : 以下切替の実装にあたり、現在動作している3rdパーティタグの削除/変更は行わないでください❗
TEST- S2S コンバージョンAPI実装例:
現在動作している3rdパーティピクセルが下記であった場合:
<img src="https://prf.hn/conversion/campaign:XXXXXXX/conversionref:CONVERSIONREF[category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY]" height="1" width="2" />
テストS2SコンバージョンのURLは以下のようになります。
https://prf.hn/conversion/campaign:TEST-XXXXXXX/tmethod:2/tplatform:2/clickref:TEST-CLICKREF/tracking_mode:api/conversion_time:YYYY-MM-DD+hh:mm/device:DEVICE/context:CONTEXT/conversionref:CONVERSIONREF/[category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY]
使用可能文字について
-
/
,#
,+
,\
,"
の記号はURLエンコードをしていない場合、予期せぬ変換が起こる可能性があります。 - スラッシュ ( / ) , コロン ( : ) , 角括弧 ( [ ] ) はPartnerizeシステムにおいて予約後となっており、値として使用しないようにしてください。
- 半角数字とアルファベット以外の文字/記号を使用する場合はURLエンコードを使用するようにしてください。
- 例) 半角スペースはURLエンコードを行うと
%20
となります。conversionref:test 001
をURLエンコードした値はconversionref:test%20001
となります。
- 例) 半角スペースはURLエンコードを行うと
- 金額を設定する
value
パラメータの値は、通過記号と桁区切りのカンマを除外し設定してください。- 例) "$1,980.99" の場合、 "1980.99" と設定してください。
追加/変更点について
3rdパーティピクセルタグのsrcに設定したURLから以下のパラメータの追加/変更を行なっています。
パラメータ:値 | 概要 | 必須可否 |
tracking_mode:api |
このパラメータを使用することで、成果登録成功時に登録が行われたconversion ID が GET/POSTリクエストのレスポンスにて返されます。 ❗注 : テストコンバージョンを使用している際は実際の登録は行われないため、conversion IDは作成されません。
|
必須 |
campaign:TEST-XXXXXXX | テストコンバージョンではcampiangIDの前に「TEST-」を追加することで実際の登録が行われないようにします。 | 必須 |
tmethod:TMEDHOD |
コンバージョン計測の方式を設定します。 S2S計測のため必ず「2」を設定してください。 tmethod:2
ID - Tracking Method |
任意 |
tplatform:TPLATFORM |
コンバージョン計測のプラットフォームを設定します。 S2S計測のため必ず「2」を設定してください。 tplatform:2
ID - Platform |
任意 |
clickref:TEST-CLICKREF |
広告主ランディングページで受け取り、1stパーティストレージに格納した最新のclickrefをコンバージョンAPIのパラメータとして追加します。
❗注: campaign と同様、clickrefの値の前にも「TEST-」 を追加してください。
❗ワンポイント: 広告主側のデータベースに購入/申込情報にclickref情報を追加することでより信頼性のおける計測方法となり、推奨しています。 |
必須 |
conversion_time:YYYY-MM-DD+hh:mm |
conversion_time を追加することで、広告主側の購入/申込日時とPartnerizeに登録されるコンバージョン日時を一致させることができます。 リアルタイム送信ができない場合にconversion_timeを使用し、コンバージョン日時の指定を行うことも可能です。 conversion_timeを使用しない場合は、S2S通信が行われた日時でコンバージョン日時の登録が行われます。
❗注: ・日時の指定はUTC時間で指定する必要があります。 ・日時フォーマットのオプションとして YYYY-MM-DD%20HH:MM:SS の形式で送信することも可能です。
|
必須 |
device:DEVICE |
ユーザーが使用したデバイスを設定します。
|
N |
context:CONTEXT |
ユーザーのコンテキストを設定します。
|
N |
❗NOTE:
- もし現在行われている計測方法や計測項目について不明な場合はPartnerize インテグレーションチーム (integrations.support@partnerize.com )にお問い合わせください。
- 切り替えによる計測漏れを防ぐため、必ず上記の手順に従って実装を行ってください。
__________________________________________________________________________________________________________________
Step 3 -Partnerizeへの実装完了連絡(広告主様)
Step2の実装の完了後、Partnerizeにご連絡下さい。
広告主様からPartnerizeへ下記2つの呼び出しが同時に行われるようになります。
- 既存の本番コンバージョン(v1)
- S2Sからのテストコンバージョン (v2)
3rdパーティクッキーピクセル (v1) により引き続き本番計測が行われ、「TEST-」がついたS2Sからのテストコンバージョンが同時に送付されます。S2Sからのテストコンバージョンは実際の登録は行われませんがPartnerizeチームはログから送信された情報を確認することができます。
__________________________________________________________________________________________________________________
Step 4 - 「TEST-」データの確認 (Partnerize)
Partnerizeは3rdパーティピクセルからの本番計測されたデータとS2Sからのテストコンバージョンのデータを確認し、切り替えに問題がないことを確認します。
確認内容は下記となります :
- 既存の計測が引き続き問題なく行われているかどうか
- 既存タグからの送信数と比較して、S2Sからのテストコンバージョンの送信数が問題ないかどうか
- フォーマットやパラメータに問題がないかどうか
- テストコンバージョンに正しい「clickref」の値 が設定されているかどうか
- その他、切り替えにあたり環境設定に問題がないか社内確認を行います
__________________________________________________________________________________________________________________
Step 5 - S2S方式の本番反映 (広告主様)
Partnerizeチームは切り替えに問題がないことを確認し、clickref保持の実装からクッキー有効期限の期間が経過後、切り替え手順についてご連絡いたします。
広告主様側で下記の作業が必要になります :
- S2Sのテストコンバージョンから「/campaign:」と「/clickref:」 から「TEST-」を削除
- 既存3rdパーティピクセルタグの削除
修正前例
https://prf.hn/conversion/campaign:TEST-XXXXXXX/tmethod:2/tplatform:2/clickref:TEST-CLICKREF/tracking_mode:api/device:DEVICE/context:CONTEXT/conversionref:CONVERSIONREF/[category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY]
修正後例
https://prf.hn/conversion/campaign:XXXXXXX/tmethod:2/tplatform:2/clickref:CLICKREF/tracking_mode:api/device:DEVICE/context:CONTEXT/conversionref:CONVERSIONREF/tmethod:2/tplatform:2/[category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY]
切り替え後しばらくの間、何か問題が起きた際のため既存3rdパーティピクセルタグをすぐに戻せるような形で残しておくことを推奨しています。
❗注:
- 上記の変更後、Partnerizeへご連絡ください。
- clickrefの格納処理を実装してから本番切替までの期間をクッキー有効期限と同様とすることを推奨しています。クッキー有効期限内の流入の成果の計測漏れを防ぐことができます。
__________________________________________________________________________________________________________________
Step 5b - S2Sコンバージョンの送信タイミング
S2Sのコンバージョンは通常「clickref」の値が存在する場合に送信するよう設定します。もし、別途Partnerizeのクーポンコンバージョン機能(https://help.phgsupport.com/hc/en-us/articles/4405844671377 )を使用したい場合は、「voucher」パラメータにクーポンのIDを設定する必要があります。
クーポンコンバージョン機能では、クリックを使用しない計測の概念も導入されており、クリックリンクなしでの計測も可能としています。ただし、クリックリンクを使用しない計測を行う場合は、「clickref」の有無に関わらず、全ての申込/購入に対して送信を行う必要があります。
「clickref」パラメータは「.../clickref:/...」のように値なしで送信することが可能です。
❗注: コンバージョンデータを全ての申込/購入時に送信したとしても、Partnerizeで計測が行われるものはPartnerへの紐付けができるデータのみとなります。
__________________________________________________________________________________________________________________
Step 6 - 本番切替後確認 (広告主 / Partnerize)
広告主とPartnerizeの両社にて、本番切替後の計測に問題がないかを確認します。
__________________________________________________________________________________________________________________
その他
現在、完了ページから直接ピクセルを起動するのではなく、サードパーティのコンテナソリューションを使用して条件付きでピクセルを起動している場合は、以下の注意事項をお読みください :
サードパーティコンテナソリューションの代表的な使用例としては、以下のようなものがあります。
- 複数のオンラインチャネルのトラフィックソースを分析
- 計測の重複を避けるために、条件付きでピクセルを使用(他のアフィリエイトネットワークのピクセルと一緒に使用される可能性があるため
コンテナソリューションはピクセルに大きく依存しているため、S2S方式では、このサードパーティツールをバイパスします。これは、S2S計測ソリューションがコントロールできない直接のHTTPインタラクションを伴うためです。現在ご使用されている計測について確認を行い、Partnerizeインテグレーションチームにご確認ください。
コンバージョンデータの送信がユーザーのブラウザから送信されなくなるため、Partnerize側で受動的にデバイスやコンテキストを判断することができなくなります。そのため、引き続きデバイス、コンテキストの情報を計測したい場合は、広告主サーバー側でデバイスとコンテキストの情報を取得し、コンバージョンデータに追加し送信する必要があります。より詳細を確認したい場合はAPIインテグレーション資料を参照してください。
ご質問
実装に関するその他技術的なご質問に関しましては、 integrations.support@partnerize.com までお問い合わせ下さい。