Integrate your analytics tool with AMP
概要
トラフィックやビジターに関するデータを把握するためのサイト運営者向け SaaS(サービスとしてのソフトウェア)ツールを提供している場合、そのサービスを amp-analytics
に統合することができます。こうすることで、顧客は AMP HTML ページのトラフィックパターンを閲覧できるようになります。
始める前に
分析サービスを AMP HTML ランタイムに追加する前に、以下の内容を実施する必要があります。
- 分析サービスを使用する上で AMP HTML ドキュメントに必要となる変数とリクエストの種類を特定する。
- サービスに関連するページから分析リクエストが送信されるようにするトリガーを特定する。
- ファーストパーティとサードパーティ AMP のコンテキストでユーザーを追跡するかどうか、そしてその方法を検討する。
- 分析ダッシュボードが AMP トラフィックをどのように処理するかを確認する。
amp-analytics
に欠落した機能がないかを確認し、必要な機能についてリクエストを提出する。- AMP アナリティクスは、あらかじめ構成されたエンドポイントに変数を送信します。既存のエンドポイントがない場合、その構築方法の概要について、こちらのサンプルを参照してください。
iframe
を除くすべてのトランスポートタイプでは、変数は HTTPS リクエストのクエリ文字列パラメータとして送信されます。iframe
トランスポートタイプについては、変数はwindow.postMessage
を通じて、作成された iframe に送信されます。この場合、メッセージは URL である必要はありません。このオプションは、MRC 認定ベンダーのみが利用できます。amp-analytics
との統合によって、既存のポリシー(特にプライバシーポリシー)や契約にどのような影響が生まれる可能性があるかを検討する。
AMP HTML ランタイムへの構成の追加
- 分析サービスを AMP HTML のランタイムに追加することを述べた Intent-To-Implement(実装意図)の課題 を作成します。説明に cc @ampproject/wg-analytics を必ず含めてください。
- 以下の内容を実装するパッチを開発します。
- 以下のような、デフォルト外のオプションを含めた新しい構成 json ファイル
${vendorName}.json
を vendors フォルダ:- 追加のデフォルト変数用の
"vars": {}
。 - サービスが使用するリクエスト用の
"requests": {}
。 - 必要な場合は
"optout":
。現時点では、優れたオプトアウトシステムが用意されていないため、あなたに合ったものを設計できるように、お問い合わせください。 - 必要な場合は
"warningMessage":
。コンソールにベンダーからの警告情報(説明や移行)を表示します。
- 追加のデフォルト変数用の
- iframe トランスポートを使用する場合は、
"*vendor-name*": "*url*"
を含む iframe-transport-vendors.js の ANALYTICS_IFRAME_TRANSPORT_CONFIG に新しい行を追加します。 - examples/analytics-vendors.amp.html リファレンス内の例。
- extensions/amp-analytics/0.1/test/vendor-requests.json ファイルのテスト。
- extensions/amp-analytics/0.1/analytics-vendors-list.md ファイルの対応ベンダーリストに分析サービスを追加します。種類、説明、および使用方法のドキュメントへのリンクを含めてください。
- examples/analytics-vendors.amp.html に配置した新しい例をテストし、この例のヒット数が期待通りに動作していることを確認します。たとえば、必要なデータが収集され、分析ダッシュボードに表示されることを確認します。
- Intent-To-Implement 課題を参照する、このパッチのプルリクエストを提出します。
- サービスの使用方法ドキュメントを更新し、顧客に伝えます。
- AMP リポの外部で統合テストを管理することを強くお勧めします。
タグマネージャー
タグ管理サービスには、AMP アナリティクスと統合するためのオプションが 2 つ用意されています。
- エンドポイントアプローチ:
amp-analytics
の追加エンドポイントとして機能し、バックエンドでマーケティング管理を実施します。 - Config アプローチ: 各サイト運営者固有の、動的に生成された JSON config ファイルを通じて、タグ管理を実施します。
エンドポイントアプローチは、前のセクションで説明した標準アプローチと同じです。config アプローチには、サイト運営者固有の amp-analytics の構成を作成する作業があり、互換性のあるすべてのアナリティクスパッケージが含まれます。サイト運営者は、以下のような構文を使用して構成を含めます。
<amp-analytics config="https://my-awesome-tag-manager.example.com/user-id.json" > </amp-analytics> >
このアプローチを使用する場合は、サイト運営者向けの AMP アナリティクスの統合に関するドキュメントを参照してください。
その他のリソース
- ディープダイブ: Why not just use an iframe?
- ディープダイブ: Managing non-authenticated user state with AMP
- amp-analytics サンプル
- amp-analytics リファレンスドキュメント
- amp-analytics variables リファレンスドキュメント