ECCUBEの注文完了画面注文番号と商品情報を編集するCRITEO（クリテオ）タグを編集

2016/10/08

ECCUBEの注文完了画面注文番号にCRITEO（クリテオ）タグを編集

ECCUBEの完了画面に注文情報や商品情報を編集する

　
ECCUBEにCRITEO（クリテオ）のタグを編集する機会がありました。
　
商品一覧ページ、商品詳細ページなどはテンプレートファイルの中だけの処理だけで対応が可能だったのですが、完了ページにコンバージョンのタグを編集する方法は少しカスタマイズが必要になりましたので、それを記載しておきます。
　
今回の対応は、ECCUBE 2.12と 2.13で確認をしました。
　
　
ECCUBEの完了画面には、注文番号や商品情報など注文をした情報を引き継ぎません。
そのため、テンプレートファイルだけの対応では想定しているタグを編集することはできませんので、完了画面に遷移する前に、表示する情報（注文情報と、購入した商品の商品ID、単価、数量）を取得し、完了画面に渡す必要があります。
　
そのためにプログラムの変更が必要になります。
　
　

プログラムの改修・LC_Page_Shopping_Complete_Ex.php

　
変更するプログラムの対象は、下記になります。
　/data/class_extends/page_extends/shopping/LC_Page_Shopping_Complete_Ex.php
　
下記の内容をコピペして追加します。
追加する場所は、一番最後で問題ありません。

public function action() {
    $this->arrInfo = SC_Helper_DB_Ex::sfGetBasisData();

    // 注文情報を取得
    $objPurchase = new SC_Helper_Purchase();
    $arrOrder = $objPurchase->getOrder ( $_SESSION['order_id'] );
    $arrOrderDetail = $objPurchase->getOrderDetail( $_SESSION['order_id'] );

    $itemArray = array();   // コンバージョンタグ用の商品リスト
    foreach ( $arrOrderDetail as $value ) {
        $itemArray[] = '{ id: "' . $value['product_code'] . '", price: ' . $value['price'] . ', quantity: ' . $value['quantity'] . ' }';
    }

    // 必要な値を完了画面に引き渡す
    $this->arrMyOrder = array(
        'order_id'  => $arrOrder['order_id'],          // 注文番号
        'item_list' => implode ( ",\n", $itemArray ),  // 商品情報
        );
}

public function action() {

$this->arrInfo = SC_Helper_DB_Ex::sfGetBasisData();

// 注文情報を取得

$objPurchase = new SC_Helper_Purchase();

$arrOrder = $objPurchase->getOrder ( $_SESSION['order_id'] );

$arrOrderDetail = $objPurchase->getOrderDetail( $_SESSION['order_id'] );

$itemArray = array(); // コンバージョンタグ用の商品リスト

foreach ( $arrOrderDetail as $value ) {

$itemArray[] = '{ id: "' . $value['product_code'] . '", price: ' . $value['price'] . ', quantity: ' . $value['quantity'] . ' }';

}

// 必要な値を完了画面に引き渡す

$this->arrMyOrder = array(

'order_id' => $arrOrder['order_id'], // 注文番号

'item_list' => implode ( ",\n", $itemArray ), // 商品情報

);

}

テンプレートファイルの改修・complete.tpl

　
完了画面のテンプレートファイルを変更します。
変更する対象となる完了画面のファイルは下記になります。
　/data/Smarty/templates/default/shopping/complete.tpl
　
下記の内容を適当な場所に追加します。
一番最後で問題ありません。

<!--  コンバージョンページタグ ---->
<script type="text/javascript" src="//static.criteo.net/js/ld/ld.js" async="true"></script>
<script type="text/javascript">
window.criteo_q = window.criteo_q || [];
window.criteo_q.push( 
        { event: "setAccount", account: ****** },
        { event: "setSiteType", type: "d" },
        { event: "trackTransaction" , id: "<!--{$arrMyOrder.order_id}-->",
            deduplication: 0, item: [ 
<!--{$arrMyOrder.item_list}-->
]});
</script>

window.criteo_q = window.criteo_q || [];

window.criteo_q.push(

{ event: "setAccount", account: ****** },

{ event: "setSiteType", type: "d" },

{ event: "trackTransaction" , id: "",

deduplication: 0, item: [

]});

</script>

　
　
プログラム側ですでに編集する値を処理していますので、テンプレート側では単純に受け取った値を編集するだけになっています。
　
クリテオでは、商品情報を 1商品 1行で編集する必要がありますので、改行コードも併せて編集しています。

- PHP・Smarty・ECCUBE

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: PHPのソースで見慣れない記号が出てきた・アロー演算子（->）、ダブルアロー演算子（=>）

PHPのプログラムソースには見慣れない記号が出てきます。その意味や調べ方です。

: GMOペイメントゲートウェイのjava.io.IOExceptionのエラー

ECCUBEの決済でGMOペイメントゲートウェイのモジュールを使ってテスト決済を行った場合の不具合、java.io.IOExceptionと言うエラーの原因と対策方法の解説です。

: QRコード（二次元バーコード）作成サービスを公開

QRコード（二次元バーコード）を生成するサービス。QRコードにする文字列を入力するだけで QRコードが簡単に作れる。オプションとして、画像サイズ、余白サイズ、エラー訂正レベルがある。

: cURLを利用する際の注意点「&」があるURLは「”」で囲む

cURLでURLはダブルクォーテーションで囲む。LinuxでもWindowsでもコマンドでは「＆」は意味を持つ文字のためエラー原因になる。クォーテーションは常につけておく方が無難。

: WindowsのXAMPPのPHPではstrptimeは使用不可。代替はdate_parse_from_formatを使う

strptimeはWindowsのPHPには未実装。LinuxとMacで挙動が異なる。PHP8.1で非推奨になる。なので日付のチェックはdate_parse_from_formatを使おう。使い方を詳細解説。

: 連想配列のキーも値もまとめてhtmlspecialchars()でサニタイズする関数の作成解説

PHPの配列・連想配列のキーと値をまとめてhtmlspecialchars()関数でサニタイズ（無害化、無毒化）を行う関数を作成。連想配列のキーはarray_map()関数でのサニタイズは無理。

: PHPで1ヵ月前、先月、今月1日、来月末の日付などの算出はDateTimeImmutableを使う

PHPには日時をオブジェクトとして生成する関数「DateTimeImmutable」「DateTime」が用意されている。これを利用して1ヶ月後、月初日、月末日、5日後などを指定して日付を取得できる。

: PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較

PHPからWebサイトにアクセスしてHTMLを取得、APIにアクセスして情報を取得する場合は、cURLがオススメ。file_get_contentsでも可能だがエラー制御に難がありトラブルのもとになる。