ec-cube icon indicating copy to clipboard operation
ec-cube copied to clipboard

Googleアナリティクス機能を追加

Open yKazihara opened this issue 4 years ago • 1 comments

概要(Overview・Refs Issue)

管理画面でトラッキングIDを設定し、GA計測ができるようにしました。

関連Issue

#4837

方針(Policy)

  • トラッキングIDの登録は、管理画面の設定>店舗設定>基本設定に入力フォームを追加しました。
  • dtb_base_infoにトラッキングID保持用のカラムを追加しました。

実装に関する補足(Appendix)

  • トラッキングIDの登録がない場合は、フロント側のGA用スクリプトはまるごと表示されません。
    • 既にGAプラグインや実装などがされている場合、GA用スクリプトが重複して表示されることはありません。

テスト(Test)

トラッキングIDの登録ありなしで、フロント側のスクリプト表示非表示のテストを追加しました。

相談(Discussion)

特になし

マイナーバージョン互換性保持のための制限事項チェックリスト

  • [x] 既存機能の仕様変更
  • [x] フックポイントの呼び出しタイミングの変更
  • [x] フックポイントのパラメータの削除・データ型の変更
  • [x] twigファイルに渡しているパラメータの削除・データ型の変更
  • [x] Serviceクラスの公開関数の、引数の削除・データ型の変更
  • [x] 入出力ファイル(CSVなど)のフォーマット変更

レビュワー確認項目

  • [ ] 動作確認
  • [ ] コードレビュー
  • [ ] E2E/Unit テスト確認(テストの追加・変更が必要かどうか)
  • [ ] 互換性が保持されているか
  • [ ] セキュリティ上の問題がないか

yKazihara avatar Feb 12 '21 02:02 yKazihara

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.71%. Comparing base (26ea5b9) to head (781e089). Report is 5 commits behind head on 4.3.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff              @@
##                4.3    #4912      +/-   ##
============================================
- Coverage     82.77%   82.71%   -0.07%     
- Complexity     6509     6511       +2     
============================================
  Files           479      479              
  Lines         26029    26042      +13     
============================================
- Hits          21546    21541       -5     
- Misses         4483     4501      +18     
Flag Coverage Δ
E2E 70.08% <76.92%> (+<0.01%) :arrow_up:
Unit 79.55% <100.00%> (-0.06%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Feb 26 '24 02:02 codecov-commenter

@chihiro-adachi @dotani1111 @ji-eunsoo 4.3αのコードを取り込み直しました。テストも通ったので、改めてレビューお願いします。

shinya avatar Feb 26 '24 12:02 shinya

@shinya GAのトラッキングが通っていることのご確認をお願い致します。

ji-eunsoo avatar Feb 29 '24 02:02 ji-eunsoo

スクリーンショット 2024-03-01 9 07 08

GA上でもアクセスが来ることを確認できました

shinya avatar Mar 01 '24 00:03 shinya

googleアナリティクスを導入する際にプライバシーポリシーに以下の記述が必要となりますが、 考慮する必要はないでしょうか。 https://support.google.com/analytics/answer/7318509?hl=ja

k-yamamura avatar Mar 01 '24 00:03 k-yamamura

@k-yamamura ありがとうございます。確かに考慮する必要ありだと感じました。 こちら一旦預かってやり方検討いたします。

shinya avatar Mar 06 '24 07:03 shinya

WebサイトにGoogleAnalytics(以下GA)を導入する場合、 ・GAを使ってトラッキングしていること ・そのトラッキングのためにCookieを使っていること ・収集したデータの保存・処理方法の説明(GAの規約リンクを貼るでもOK) の記載が必要です。

しかし、GAのID発行の際に上記の必要性は使用者(この場合GAの使用者なのでサイトオーナーを指す)に通知されるため、 EC-CUBEが特別それを考慮する必要はないと感じました。 (ようはこの規約を知らずにサイトにGAを導入することはありえない)

また、本機能はあくまでタグの導入を支援する位置づけのものであり、 上記の規約云々を理解したユーザーがHTMLを直接編集する手間を軽減する目的で実装します。

とはいえ、何もしないのはさすがに不親切なのでユーザーが情報を調べられるようにはしておきたい。

以上の理由から、EC-CUBE内での対応は下記で行こうと考えています。 ・管理画面内のtooltipにはGAの規約を満たしたうえで使用するよう文言を変える ・doc4運用マニュアルにそれぞれ使い方を記載しておく

ご意見ください。 問題なければそれで対応を進めます。

shinya avatar Mar 07 '24 05:03 shinya

動作確認OKでした。

dotani1111 avatar Apr 04 '24 07:04 dotani1111

@chihiro-adachi こちら問題なければApproveをお願い致します。

dotani1111 avatar Apr 04 '24 07:04 dotani1111