Adobe Document Cloud | Update – Adobe Analytics上でのPDF分析機能の紹介
Document Cloud API の中の「PDF Embed API」という機能を利⽤することで、PDF に対するページビューや閲覧者数などのアクセス数や、検索キーワードなど閲覧行動履歴を、Adobe Analytics 経由で解析できるようになります。
これまで視覚化しにくかったPDFファイルへの効果測定を、詳細に⾏うことが可能になります。
Adobe Developers – PDF Embed API | Embed PDF in HTML | Adobe Document Services
https://www.adobe.io/apis/documentcloud/dcsdk/pdf-embed.html
PDF Embed API を利用して PDF をページへ埋め込む方法として「full-size windows, in-line display, lightnoxes」の3パターンの方法が用意されています。
その他、Save Control 機能による「ファイルの保存方法」の設定、メニューやツールの設定なども行うことができます。
計測のしくみ
Document Cloud SDK の一部は、JavaScript (JS) ライブラリとして提供しています。
ページへの訪問者がHTMLへアクセスした際にこのライブラリが読み込まれます。バックグラウンドの処理として、記述されている Application Key をもとに Document Cloud 上にある main.js にアクセスされます。この一連の処理により、指定したPDFをページに埋め込まれるわけですが、この処理上で Adobe Analytics への計測コードも自動的に有効化されており、訪問者がPDFをめくったり保存したりする行動履歴を Adobe Analytics へコールしてゆきます。
注意点
- Viewerで表⽰しているウェブページ上のものだけが計測可能対象です。ダウンロードされ
たものは対象外となります。 - 計測の際には埋め込みを⾏っているウェブページで AppMeasurement が読み込まれている
必要があります。 - AppMeasurement の設定を⼀部利⽤するため、レポートスイートID(RSID)は、読み込
みを⾏っているものと同じものを利⽤する必要があります。 - 計測時はPDFのページが切り替わるごとに、サーバーコールが発⽣します。
- 本レポート配信時点では Embed API は無料で利⽤が可能ですが、今後、サービスの体系が
変わる可能性もございます。
設定の流れ
Embed PDFでの計測を⾏うためには以下の⼿順で⾏う必要があります。
※⻘枠は初回のみ、オレンジ枠はPDF埋め込みを実施する都度⾏う必要があります。
ステップ1:API Keyの取得
Embed APIを利用するにあたり、Document CloudのAPI Keyを発行します。Adobe I/Oからプロジェクトを作成し、取得を行います。PDFの埋め込みを行うドメイン単位での発行となります。
参照:Adobe I/O Project
ステップ2:ページ埋め込みの実施
PDFをページ内に埋め込み表示する方法は大きく4つ存在し、メニューに表示する機能などをパラメータによりコントロールすることが可能です。
- Full Window
- Sized Container
- In-Line
- Lightbox
デモサイトで確認しながら埋め込み用のコードを発行することが可能です。ぜひご利用ください。
参照:PDF Embed Mode Demo Site
ステップ3:計測設定の実施(埋め込み側)
埋め込み設定をしたJSファイル内に2カ所設定をすることでサーバーコール自体の設定が可能になります。
adobeDCViewをNewしているところでRSIDを設定する
registerCallbackの箇所で、enablePDFAnalyticsをTrueにする
RSIDの設定箇所は下記となります。
document.addEventListener(“adobe_dc_view_sdk.ready”, function () {
/* Initialize the AdobeDC View object */
var adobeDCView = new AdobeDC.View({
/* Pass your registered client id */
clientId: “YOUR DC API KEY”,
/* Pass the div id in which PDF should be rendered */
divId: “adobe-dc-view”,
//Adobe Analytics RSID//
reportSuiteId: “REPORTSUITE ID”,
});
計測をONにする
/* options to control the callback execution */
{
/* Enable PDF analytics events on user interaction. */
enablePDFAnalytics: true,
}
全体のコードの設定についてはGitHubのMore Samples配下のCapture PDF Embed API Eventsにサンプルコードがありますので併せてご確認ください。
計測データはContextData(計測ページ側で変数を設定せず、計測サーバー側で設定)を利用したものとなります。開発者ツールなどで、RSIDで絞ったサーバーコールが飛んでいることが確認できたらステップ4へ進みAdobe Analytics側の設定を行います。
ステップ4:計測設定の実施(Adobe Analytics側)
ContextDataとして設定されたものはAdobe Analyticsの管理者画面がから実施できるプロセシングルールを利用し、変数へのマッピングを行います。お薦めの設定としては下記を取得しておくことをお薦めします。
- Events(成功指標)
-
- PDF Loads(PDFの読み込み)
- PDF Page Views(PDF内のページビュー)
- PDF Downloads(Viewerのダウンロードボタンの押下)
- PDF Search(PDF内の検索の実施)
- eVar(コンバージョン指標)
-
- PDF File Name(計測しているPDFの名前。SDK内で指定しているものが入ります)
- PDF File Page Nume(計測しているページ番号)
- PDF Search Term(検索したキーワード)
これらをマッピングすることで、かなりの計測が可能になります。
ステップ5:レポーティング
レポーティングについては、計測されているものを自由に設定して頂くことで、これまでのページなどの分析同様に実施して頂くことが可能になっています。
閲覧ページのブレイクダウン(セグメントでの絞り込みも可)
https://qiita-user-contents.imgix.net/https%3A%2F%2Fqiita-image-store.s3.ap-northeast-1.amazonaws.com%2F0%2F608794%2F8dbc834f-b0e8-4f08-f423-a9f0889fb88f.png?ixlib=rb-1.2.2&auto=format&gif-q=60&q=75&s=5549e1231818dfce55504de505f17e74
埋め込んだページから特定PDFのページ閲覧までを繋げたパス分析
https://qiita-user-contents.imgix.net/https%3A%2F%2Fqiita-image-store.s3.ap-northeast-1.amazonaws.com%2F0%2F608794%2F41c9906a-730e-55e5-b2ce-bb24e117a256.png?ixlib=rb-1.2.2&auto=format&gif-q=60&q=75&s=fe5c2cf6e86ced71703da38e749c1682
オンラインでは動画も計測できる割にPDF内はブラックボックスだったので、ぜひこれを機会に最適化などにご活用頂ければと思います。
補足資料
- Adobe | Document Services APIs?
- Adobe | PDF Embed API – Quick Start
- Adobe Developers – PDF Embed API | Embed PDF in HTML | Adobe Document Services
- Qiita | ウェブに掲載されているPDF内の計測をAdobe Analyticsで実施する
関連記事
この記事のPDFファイルはこちら
「Adobe Document Cloud | Update – Adobe Analytics上でのPDF分析機能の紹介」
https://landing.adobe.com/content/dam/landing/uploads/2020/jp/dxcsm/202011_Acrobat-AA.pdf