Partnerizeタグ実装手順について

__________________________________________________________________________________________________________________

本項の目的:

Partnerizeタグについて、以下項目についてご案内いたします。

• Partnerizeタグとは？
• Partnerizeタグの特徴
• ウェブサイトに実装が必要なコード
• 実装確認テスト方法

__________________________________________________________________________________________________________________

目次

• 概要
• 実装概要
• 実装手順
• ご質問

概要

Partnerizeタグは、広告主様がウェブサイトに実装するJavascriptです。Partnerizeタグを実装することにより、計測を含めたPartnerizeプラットフォームの機能をより効果的に利用できるようになります。

このガイドではPartnerizeタグを利用した1stパーティ計測について説明しています。

1. ランディングページ(LP)用タグの実装  : タグを設置することにより、PartnerizeのクリックID(clickref)を1stパーティストレージに格納が行われます。
2. 完了ページ用タグの実装 : タグを設置することにより、1によりLPで格納されたclickrefの取得と併せて自動的に成果情報の通知が行われます。

__________________________________________________________________________________________________________________

実装概要

手順	詳細	担当
1. Partnerize タグの有効化	クライアントネットワークに対してPartnerizeタグ機能の有効化を行います	Partnerize
2. Partnerize タグの作成	LPと完了ページに設置するPartnerizeタグを作成します。	Partnerize
2b. clickrefの付与設定	キャンペーンのclickref設定を有効化します。 この設定により、キャンペーンのリンク使用時のLP遷移時にclickrefがGetパラメータとして追加されます。	Partnerize
3. ランディングページへのタグ設置	2で作成されたPartnerizeタグを必要なページに実装します。 （LPが複数となる場合はその全てのページに対し実装する必要があります）	広告主様
4. 完了ページへのタグ設置	成果地点となる完了ページにLP用タグと 完了ページ用タグを実装します。 完了ページ用タグに設定する広告主データに対する処理は別途実装する必要があります。	広告主様
5. テスト実施	申し込みテストを実施します。	広告主様
6. テスト結果確認	管理画面への登録内容やログ等の結果を確認します。	Partnerize

 

__________________________________________________________________________________________________________________

実装手順

Step 1 - Partnerizeタグの有効化(Partnerize)

Partnerizeタグはネットワークレベルの設定で、使用開始前に有効化する必要があります。この作業はPartnerizeのインテグレーションチームにより実施されます。

__________________________________________________________________________________________________________________

Step 2 - Partnerizeタグの作成(Partnerize)

Partnerizeのインテグレーションチームで作成を行い、広告主様へタグをご案内いたします。

• ランディングページ用タグ:  広告主毎に固有の内容となるJavascrpitコードです。1stパーティ計測機能を有効にします。
• 完了ページ用タグ: 完了ページに設置し、1stパーティ計測におけるコンバージョン登録の手助けをします。

__________________________________________________________________________________________________________________

Step 2b - Clickrefの付与設定 (Partnerize)

Partnerizeのリンクを経由した広告主様ページへの遷移時にPartnerize ID(clickref)を自動付与する設定を行います。

• 例) https://www.brand-site.com?clickref=ABC1234

Partnerize ID(clickref)はクリック毎にユニークなIDが発行され、1stパーティストレージに格納されます。

• 別クリック時の例) https://www.brand-site.com?clickref=DEF456

Partnerizeタグは常に最新のPartnerize ID(clickref)を把握し、コンバージョンページで取得することを可能としています。

__________________________________________________________________________________________________________________

Step 3 - Partnerizeタグの実装 (広告主)

広告主様は下記に該当する必要な全てのページのbody下部にPartnerizeタグを実装してください。

• Partnerizeリンクを通して遷移先となる全てのページ
• 完了ページ　(コンバージョンタグの実装と合わせて行います)

 

Partnerizeタグの設置例

Partnerizeタグはインテグレーションチームから広告主に正確なコードをお渡しします。下記はタグサンプルとなります。

<script src="https://pzapi-kg.com/b/XXXXX/YYYYY.js"></script>

• ドメインは広告主毎に異なります。
• XXXXX は広告主IDとなります。
• YYYYY はタグ毎のIDとなります。

コンバージョンの発火に別スクリプトを利用し、Partnerizeのコンバージョンタグに流用する必要がある場合は、そのコードより下部にPartnerizeタグを合わせて実装することを推奨します。

__________________________________________________________________________________________________________________

Step 4 - 完了ページ用タグの実装  (広告主)

完了ページにはPartnerizeタグとともに、コンバージョン送信用のタグの実装を行います。

 

完了ページ用タグの例  

キャンペーンIDやパラメータはキャンペーン毎、キャンペーン運用により異なります。
大文字の文字列は変数を設定する箇所となります。

<div data-partnerize="https://prf.hn/conversion/campaign:XXXXX/conversionref:CONVERSIONREF/country:COUNTRY/currency:CURRENCY/customertype:CUSTOMERTYPE/voucher:VOUCHER/[category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY][category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY]" style="display: none"></div>

 

パラメータの例

コンバージョンAPI のURL は複数のパラメーターによって構成されます。スラッシュ”/”を利用してパラメーターを区切り、コロン”:”を利用して値を指定します。

パラメータ名	概要	例	必須項目
campaign	各キャンペーンのID 実装前にPartnerizeのインテグレーションチームから共有されます。	campaign:XXXXX	必須
conversionref	広告主様側で生成・保持するID 通常、申込ID、購入ID、ユーザーID等を設定します。 広告主様側とPartnerizeレポートのデータ結合やPartnerizeでの承認／非承認作業に使用します。	conversionref:2345761	必須
country	国コード ISO 3166 準拠の国コードを設定する必要があります。	country:GB	任意
currency	通貨コード ISO 4217 準拠の3文字の通過コードを設定する必要があります。	currency:GBP	必須
customertype	顧客タイプ（新規／既存） 顧客が新規ユーザーまたは既存ユーザであるかの設定を行います。 new または existing のどちらかで設定する必要があります。	customertype:new	任意
voucher	クーポンコード クーポンコードの設定を行います。 クーポンコードによる報酬設定を行うことが可能です。	voucher:discount10	任意

• 商品価格(valueの値)にはバウチャーコード利用後の金額を計算して設定してください。
• 報酬設定時の計算には割引前の金額ではなく、割引後(入力された値)の金額が適用されます。
• クーポンコードの反映が技術的に難しい場合は、報酬レートを別途設定する 等で対応します。
• クーポンコードの利用がない成果、商品に対しては、値を空で設定してください。

❗注:

• Partnerize IDはPartnerizeタグと<div data-partnerize=…>のタグを使用することで最新のものが自動で追加され送信されます。

__________________________________________________________________________________________________________________

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

コンバージョンデータは成果単位のみでなく、[ ](角括弧)を使用することで、成果に紐づく各アイテムレベルのデータによって登録を行うことが可能です。

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

パラメータ名	概要	例	必須項目
category	カテゴリー	category:SHOES	必須
sku	商品SKU番号	sku:98735c	任意
value	商品単価金額 商品金額に対する料率(%)報酬の設定することが可能です。	value:19.99	任意
quantity	商品数量 正の整数値で設定する必要があります。	quantity:1	必須

 

❗注:

• コンバージョンレベルの合計金額はアイテムレベルのvalueの金額にquantityを乗算し、全ての商品を合計した金額が表示されます。
  
  • Valueは個々の商品単価を設定する必要がります。
• 個人情報または個人を特定できる情報(Personal Identified Information, PII)はコンバージョンデータとして登録しないでください。  (例 : メールアドレス, 自宅住所,電話番号,等)

__________________________________________________________________________________________________________________

値が反映された場合の例

単一商品例 : 

<div data-partnerize="https://prf.hn/conversion/campaign:XXXXXX/conversionref:8516768/country:GB/currency:GBP/customertype:new/voucher:Discount10/[category:shoes/sku:98735c/value:19.99/quantity:1]" style="display: none"></div>

複数商品例 : 

<<div data-partnerize="https://prf.hn/conversion/campaign:XXXXXX/conversionref:5787898/country:US/currency:USD/customertype:existing/voucher:/[category:bag/sku:3245ds/value:10.00/quantity:2][category:book/sku:2123bk/value:40.00/quantity:1]" style="display: none"></div>

 

❗注:

• 合計金額は登録時に個別の商品の金額と個数から自動で計算されます。
• campaign:XXXXXX は例となっており、実際の値はPartnerizeインテグレーションチームから共有が行われます。

__________________________________________________________________________________________________________________

メタデータ

メタパラメータ名は広告主様毎に自由に定義でき、他パラメータと同様に各パラメータを「/」で区切り「パラメータ名:値」 のフォーマットに従って設定します。 

 

メタデータ使用例 :  

<div data-partnerize="https://prf.hn/conversion/campaign:XXXXXX/conversionref:8516768/[category:DVD/sku:98735c/value: 19.99/quantity:1/productname:ET/delivery:freeshipping/age:PG]" style="display: none"></div>

• メタデータの名称として「destination」は使用できません。

 

業種毎によく使われるメタパラメータ サンプル

以下の記事をご参照ください。

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

__________________________________________________________________________________________________________________

Step 5 - テスト実施(広告主様)

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

 

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

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

 

Partnerizeタグをご利用の場合は、テスト時にブラウザの開発者ツールを使用し下記をご確認ください。

• Partnerizeタグが完了ページのソースに表示されているかどうか。
• テストリンクの使用後の広告主LPでclickrefがLocalStorage("_pz_clickref")に格納されているかどうか。

__________________________________________________________________________________________________________________

Step 6 - テスト結果確認 (Partnerize)

テスト完了後にテスト情報(日時、購入／申込ID、その他データ)についてご連絡ください。Partnerizeのインテグレーションチームでも内容を確認し、キャンペーン開始可否の判断を行います。ご連絡いただく前に下記をご確認ください。

• 管理画面上登録が行われているかどうか
• 登録データのパラメータ名と値が正しいかどうか
• 本番環境にてテストが行われたかどうか
• 最新のclickrefがコンバージョンに反映されているかどうか

__________________________________________________________________________________________________________________

 

ご質問

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