Not what you’re looking for?

Submit a Ticket
?

サーバー間通信方式(S2S) トラッキング実装手順について

_________________________________________________________________________________________________________________

本項の目的:

  • Partnerizeのトラッキン手法 サーバー間通信方式(S2S) の導入手順についてご案内いたします。

❗注: もし既にPartnerizeのトラッキングを導入済みの場合は、S2S計測切り替え手順(Optimisation Guides)をご参照ください。

__________________________________________________________________________________________________________________

目次

概要

API (Server to Server)トラッキングは、アフィリエイトマーケティングにおいて、最も一般的なトラッキング方法であるピクセル方式に代わるトラッキングソリューションです。トラッキングタグをサイト上に実装したくない広告主に対する、リアルタイムトラッキングを実現する代替計測手法となります。

Partnerizeの S2S 計測は下記のような広告主様に適しています

  • サイト上にトラッキングピクセルタグの追加実装を行いたくない広告主様

  • ピクセルタグ追加によるページのロード時間を増やしたくない広告主様

  • ピクセルに変わる強固かつセキュアな方法で実装を行いたい広告主様

S2S 計測は、POSTまたはGETによる直接のhttp通信で実装します。サーバー間通信を利用することで、ブラウザを介さずにトラッキングを行うため、セキュリティと正確性を向上させます。本方式はまた、3rdパーティーCookieの利用も必要ではなく、その観点でもトラッキングの信頼性を飛躍的に向上させることが期待できます。

__________________________________________________________________________________________________________________

実装手順

S2S でトラッキングを行うには、下記の通り 2 種類の実装が必要となります。

Picture_1.png

種類 概要

1.クリック計測

Partnerizeよって付与されたclickrefの値を広告主様サイト遷移時に取得し、広告主側で保持します。

※成果発生時にclickrefの値を同時に送信することでパートナー情報を特定し、成果の紐付けを行います

2. コンバージョン計測

成果発生時に広告主様がPartnerizeの成果計測用APIを利用し、全ての成果情報を送信します。

このデータにより該当のパートナーに成果が付与され、成果データが記録されます。

__________________________________________________________________________________________________________________

Step 1 - クリック計測

パートナーのサイトからPartnerizeのトラッキングリンクを使用して広告主様サイトへ流入があった場合、広告主様サイトのURLに以下のようにclickrefパラメーターが付与されます。

  • Example 1 : https://www.brandsite.com?clickref=abc123

広告主は最新のclickrefの値を、広告主のローカルストレージや1stパーティCookieに保存する必要があります。ユーザーが初回の訪問で購買アクションを行わず、再度Partnerizeリンクをクリックして再訪問した場合は新しいclickrefの値を上書き、及び有効期限を再設定する必要があります。

  • Example2 : https://www.brandsite.com?clickref=def456

:

  • 広告主サイト遷移時に付与されるclickrefというパラメータ名は、ご希望のパラメータ名に変更可能です。実装開始前にPartnerizeにご相談ください。

  • clickrefの値はクリック毎発行されるIDです。ラストクリックベースでの報酬設定を予定されている場合、正確にパブリッシャーに報酬を付与するため、広告主は最新のclickrefの値を保持する必要があります。

__________________________________________________________________________________________________________________

Step 2 - コンバージョン計測

購買/申込完了の成果発生時に、最新のclickref情報を含めてAPIコールを行う必要があります。コンバージョンデータを送信するURLは、広告主様のご要望内容に応じて異なる点ご注意ください。

 

コンバージョンURL例 :

https://prf.hn/conversion/tracking_mode:api/campaign:{CAMPAIGNID}/clickref:{CLICKREF}/conversionref:{ORDERID}/country:{COUNTRY}/currency:{CUR}/customertype:{new|existing}/voucher:{VOUCHER}/[category:{CAT}/sku:{SKU}/value:{VALUE}/quantity:{QTY}]

 

コンバージョンレベルのパラメータ : 

コンバージョンAPIのURLに複数のパラメータを設定しコンバージョンデータの登録を行います。パラメータ名と値をコロン ( : ) で組み合わせ、各パラメータ毎にスラッシュ ( / ) を区切りとしてパラメータの設定を行ってください。

パラメータ名 説明 必須項目

campaign 

PartnerizeキャンペーンのIDを設定してください。

キャンペーンIDが不明の場合は integration.support@partnerize.com までお問い合わせください。

campaign:XXXXXX 

必須

clickref 

クリック毎に発行される計測用クリックIDを設定してください

 

❗注:

広告主様側システムにも、購入情報や登録会員情報と紐づけて保存しておくことを推奨しています。広告主様側でもclickrefを保持することでより柔軟性の高い計測や問題発生時の調査等に役立てることができます。

clickref:def456 

必須

conversionref 

広告主様側システムで発行される購入/申込ID等を設定します。

そのIDを使用しPartnerizeに登録されたコンバージョンの承認/非承認作業を行うことが可能です。もし値を設定できない場合はPartnizeで自動で発行したIDが登録されます。

ただし、広告主様側のIDと紐づかないため、承認/非承認の判定を行うことが難しくなります。

conversionref:138516768 

必須

country

国コードを設定してください。

国コードはISO 3166の2文字の国コードに準拠する必要があります。(例:JP、US)

 

country:GB

任意

currency

通貨コードを設定してください。

通貨コードはISO 4217の3文字の通貨コードに準拠する必要があります。(例: JPY, USD)

 

コンバージョンに登録するデータが、金額によらない場合(入会申込、サインアップ等)は通貨の設定を行う必要はありません。

currency:GBP

必須

customertype

ユーザーの種別、新規と既存を判定したい場合に設定してください。

「new」または「existing」で設定する必要があります。

customertype:new

任意

voucher

クーポンのコードが必要な場合に設定してください。

 

IMPORTANT:

クーポンによる割引等がある場合、valueに設定する金額については広告主様側で計算し設定する必要があります。

voucher:discount10

任意

 

❗注: パラメータに登録する値がない場合、空文字のまま送付することが可能です。(.../voucher:/...)

__________________________________________________________________________________________________________________

アイテムレベルのパラメータ:

コンバージョンは成果アクション単位のみでなく、[ ](角括弧)を使用することで、成果に紐づく各アイテムレベルのデータによって登録を行うことが可能です。(例、1回の購入行動だけでなく、それぞれの購入商品などの情報をアイテムレベルに登録が可能)

ご利用できるパラメータは以下の通りです。全てのパラメータは必須ではありませんが、より多くのデータを可視化できるよう、可能な限り多くの情報をコンバージョンデータとして生成することを推奨しています。

 

パラメータ名 説明 必須項目
category

商品/申込のカテゴリーを設定してください。

この項目は管理画面のレポートでピボット項目として使用できます。

category:DVD  必須
sku 商品SKUを設定してください。 sku:98735c  任意
value

商品単価金額を設定してください。

消費税や配送料は除外した金額を設定します。

通貨記号や桁区切りのカンマを除外した数値のみで設定する必要があります。

value:19.99  任意
quantity

商品数量を設定してください。

正の整数で設定する必要があります。0や-数値の設定はできません。

quantity:1 必須

 

❗注:

  • 成果単位の金額はアイテムレベルのvalueとquantityを乗算した値を全てのアイテムで合計した値が表示されます。
  • 個人情報(Personal Identifiable Information, PII)を特定できるようなデータを設定しないよう注意してください (: email アドレス、住所、電話番号等).

__________________________________________________________________________________________________________________

S2Sコンバージョンの送信タイミング

S2Sのコンバージョンは通常「clickref」の値が存在する場合に送信するよう設定します。もし、別途Partnerizeの”Exclusive Code”機能(https://help.phgsupport.com/hc/en-us/articles/4405844671377 )を使用したい場合は、「voucher」パラメータにクーポンのIDを設定する必要があります。

 

”Exclusive Code”機能では、クリックを使用しない計測の概念も導入されており、クリックリンクなしでの計測も可能としています。ただし、クリックリンクを使用しない計測を行う場合は、「clickref」の有無に関わらず、全ての申込/購入に対して成果情報をPartnerizeへ送信を行う必要があります。

「clickref」パラメータは「.../clickref:/...」のように値なしで送信することが可能です。

 

:  コンバージョンデータを全ての申込/購入時に送信したとしても、Partnerizeで成果反映が行われるものはPartnerへの紐付けができるデータのみとなります。

__________________________________________________________________________________________________________________

コンバージョン時間設定パラメータ

Partnerizeでは通常リアルタイム(コンバージョンの送信/登録された時点の日時)での計測が行われますが、リアルタイム送信が行えない場合、一括での登録処理をお望みの場合、または広告主様側の購入/申込日時と正確に合わせて登録を行う場合に、時間の指定を行い登録することが可能となっています。

 

パラメータ名 説明 必須項目

conversion_time 

コンバージョン日時を設定してください。

日時の指定はUTC時間の日時を設定する必要があることに注意してください。

また、以下のフォーマットに対してURLエンコードした値を送信する必要があります。

YYYY-MM-DD HH:MM:SS 

 

日本時間(JST : UTC+9)

2021年4月21日11時20分35秒

conversion_time:2021-04-21%2002:20:35

または

conversion_time:2021-04-21+02:20:35

(%20、+は半角スペースをURLエンコードした値)

任意

 

:

  • このパラメータを使用しない場合はコンバージョンの送信/登録が行われた日時が設定されます。
  • 日時の指定はUTC時間を設定してください。
  • コンバージョンレベルのパラメータとして設定する必要があります。

__________________________________________________________________________________________________________________

APIレスポンス

/tracking_mode:api/」をコンバージョンURLに設定した場合、Partnerizeでコンバージョンの登録が成功した場合に登録が行われたコンバージョンのIDをHTTPレスポンスのボディで受け取ることが可能です。

■コンバージョン ID例

1011l127393111

 

: IDを受け取る必要がない場合は「/tracking_mode:api/」をコンバージョンAPIのURLから削除してください。その場合、成功時は「1」、失敗時は「0」が返答されます。

__________________________________________________________________________________________________________________

設定例

単一アイテム時のコンバージョン例:

https://prf.hn/conversion/tracking_mode:api/campaign:XXXXXX/clickref:def456/conversionref:87971/country:GB/currency:GBP/customertype:/voucher:/[category:SHOES/sku:4A7CAA/value:50.99/quantity:1]

 

複数アイテム時のコンバージョン例:

アイテムレベルのパラメータを角括弧 ( [ ] ) で囲い複数回設定します。

https://prf.hn/conversion/tracking_mode:api/campaign:XXXXXX/clickref:def456/conversionref:787977/country:US/currency:USD/customertype:existing/voucher:Discount10/[category:BAG/sku:bao98/value:35.00/quantity:2]/[category:SHOES/sku:4A7CAA/value:50.99/quantity:1]

 

コンバージョン日時指定時のコンバージョン例:

https://prf.hn/conversion/tracking_mode:api/campaign:XXXXXX/clickref:def456/conversionref:87971/country:GB/currency:GBP/customertype:existing/voucher:discount10/[category:SHOES/sku:4A7CAA/value:45.20/quantity:1]/conversion_time:2021-10-01+18:33:03

 

NOTE:

  • コンバージョンの合計金額は各アイテムのvalueに設定された金額にquantitiyに設定された数量を乗算した合計値が設定されます。
  • campaign:XXXXXX の XXXXXXは実際のキャンペーンIDに置き換えます。キャンペーンIDが不明な場合はPartneizeにお問い合わせください。
  • ラストクリックに対しての報酬を設定する場合、clickrefは常に最新の値を格納・保持しコンバージョン送信時のパラメータ内に設定してください。

__________________________________________________________________________________________________________________

メタパラメータ

今までの基本項目の他にメタパラメータとして自由に項目を追加することができます。コンバージョンにメタパラメータを追加することにより、広告主様はより柔軟で正確な分析を行い、キャンペーンの成長やパートナーとの連携を深めることが可能になります。

メタパラメータも標準パラメータ同様、パラメータ名と値をコロン ( : ) で組み合わせ、各パラメータ毎にスラッシュ ( / ) を区切りとしてパラメータの設定を行います。

パラメータ名は広告主様側で自由に設定が可能です。

 

メタパラメータ使用時のコンバージョン例 (delivery_costを追加)

https://prf.hn/conversion/tracking_mode:api/campaign:XXXXXX/clickref:def456/conversionref:87971/country:GB/currency:GBP/customertype:new/voucher:/[category:SHOES/sku:4A7CAA/value:45.20/quantity:1/delivery_cost:free]

 

業種別メタパラメータ 設定例

以下のページにて各業種で頻繁に利用されるパラメータ一覧が参照できます。 

https://help.phgsupport.com/hc/en-us/articles/4410042606225-Vertical-Specific-Tracking-Parameters 

 

:

  • 「destination」はパラメータ名として設定できません。

__________________________________________________________________________________________________________________

デバイス、ユーザーコンテキスト

デバイスとユーザーコンテキストは、通常、ブラウザーからHTTPヘッダーの一部として送信されるユーザーエージェント情報から取得します。しかし、S2Sトラッキングでは、ブラウザを使用せずにコンバージョンデータの送信を行うため、Partnerizeでユーザーエージェントの取得ができず、デバイスとユーザーコンテキストの判定ができません。 この問題に対処するため、広告主様がS2Sのコンバージョン送信時にデバイスおよびユーザーコンテキスト情報を送信できる機能があります。これにより、コンバージョンデータのデバイス・ユーザーコンテキストをPartnerizeレポート内で正しく表示することができ、ピボット機能を引き続き使用することが可能です。

デバイスとユーザーコンテキストの設定には「device」と「context」のパラメータを使用します。この二つのパラメータには設定できる値が予め指定されているため、下記の表をご参照ください。

「device」と「context」はコンバージョンレベルのパラメータとして設定する必要があります。

 

例:

https://prf.hn/conversion/campaign:XXXXXX/clickref:def456/tracking_mode:api/conversionref:568043/device:{device}/context:{context}/[category:DVD/sku:98735c/value:19.99/quantity:1/productname:ET/delivery:freeshipping/age:PG] 

 

デバイス(device)とユーザーコンテキスト(context)に設定できる値:

デバイス(device)

bot

desktop

mobile

tablet

Other

 

ユーザーコンテキスト(context) 詳細

web

Standard desktop web

m_web

Mobile web

m_app

Mobile app

in_app

In Mobile App

cd_d

Cross device - deterministic

cd_p

Cross device - probabilistic

other

Other/unknown

offline

Offline

 

例:

モバイル端末のウェブブラウザーから登録がされた場合

https://prf.hn/conversion/tracking_mode:api/campaign:{CAMPAIGNID}/clickref:def456/conversionref:138a76098/device:mobile/context:m_web/[category:DVD/sku:back+to+future/value:9.99/quantity:1]

 

:

  • デバイスとユーザーコンテキストに設定する値は広告主様側のサーバーで判定を行い、上記の値をしていしてコンバージョンAPIのURLに設定する必要があります。

__________________________________________________________________________________________________________________

テスト

実装完了後に広告主様側にて本番環境でテストを実施し、正常に計測が行われるか確認を行います。ノーセッションテストは必ず行うようにしてください。リンクをクリックしてからコンバージョンの発生がクッキー有効期限内であれば計測が行われます。

 

基本的なテスト手順は下記URLから参照いただけます。(英語)

https://help.phgsupport.com/hc/en-us/articles/360019824018-Testing-Tracking-Solutions-FAQs

 

コンバージョンテストの前に、clickrefが正しく広告主様の1stパーティのストレージ(localstorage, 1st party cookie)に格納されているか確認することで、よりスムーズにテストを実施することができます。

 

※確認手順

  • テストリンクを使用しLPに遷移
  • ブラウザの開発者ツール等を使用し、URLのパラメータに付与されたclickrefの値が格納されているか確認
  • テストリンクを再度使用してLPへの遷移を行い、格納されたclickrefの値が新しいものに変更されることを確認

__________________________________________________________________________________________________________________

その他

  • キャンペーンIDとURLのパラメータにclickrefが付与される設定になっているかご確認ください。不明な場合は、Partnerizeインテグレーションチーム integration.support@partnerize.com へご連絡下さい。
  • 計測漏れを防ぐため、必ず上記の手順に従って実装、及びキャンペーン開始前のテストを実施して下さい。

ご質問

実装に関するその他技術的なご質問に関しましては、 integrations.support@partnerize.com までお問い合わせ下さい。

この記事は役に立ちましたか? 1人中1人がこの記事が役に立ったと言っています

Didn't get the answer you need?

Get in Touch