置換変数
公開日:
AMPで利用できる、URLの置換変数をまとめています。platformはamp-pixelやamp-listなどで使用できる変数、analyticsはamp-analytics要素で使用できる変数です。
- AMP HTML URL Variable Substitutions
- AMPの公式ドキュメント(英語)。置換変数について説明されています。
Page and Content
現在のページの情報を置換します。
AMP Document Host
platform: AMPDOC_HOST
analytics: ${ampdocHost}
例: demo.syncer.jp:443
ホスト。ポート番号も含まれる。
AMP Document Hostname
platform: AMPDOC_HOSTNAME
analytics: ${ampdocHostname}
例: demo.syncer.jp
ホスト。
AMP Document URL
platform: AMPDOC_URL
analytics: ${ampdocUrl}
例: https%3A%2F%2Fdemo.syncer.jp%2F
URL。
Canonical Host
platform: CANONICAL_HOST
analytics: ${canonicalHost}
例: syncer.jp:443
親ウィンドウのホスト。ポート番号も含まれる。
Canonical Hostname
platform: CANONICAL_HOSTNAME
analytics: ${canonicalHostname}
例: syncer.jp
親ウィンドウのホスト。
Canonical Path
platform: CANONICAL_PATH
analytics: ${canonicalPath}
例: %2Findex.html
親ウィンドウのパス。
Canonical URL
platform: CANONICAL_URL
analytics: ${canonicalUrl}
例: https%3A%2F%2Fsyncer.jp%2Findex.html
親ウィンドウのURL。
Counter
platform: COUNTER
analytics: ${counter}
例: 1
1つのページに複数あると、1からカウントされる。COUNTER(name)
で名前ごとにカウントできる。
Document Charset
platform: DOCUMENT_CHARSET
analytics: ${documentCharset}
例: UTF-8
文字コード。
Document Referrer
platform: DOCUMENT_REFERRER
analytics: ${documentReferrer}
例: http%3A%2F%2Fwww.yahoo.co.jp%2F
リファラーのURL。
Source URL
platform: SOURCE_URL
analytics: ${sourceUrl}
例: https%3A%2F%2Fdemo.syncer.jp%2Findex.html
ソースのURL。AMP(Google)のサーバでホストされているページでは、元のページのURLになる。
Source Host
platform: SOURCE_HOST
analytics: ${sourceHost}
例: demo.syncer.jp:443
ソースのホスト。AMP(Google)のサーバでホストされているページでは、元のページのホストになる。
Source Hostname
platform: SOURCE_HOSTNAME
analytics: ${sourceHostname}
例: demo.syncer.jp
ソースのホスト。ポート番号は含まれない。AMP(Google)のサーバでホストされているページでは、元のページのホストになる。
Source Path
platform: SOURCE_PATH
analytics: ${sourcePath}
例: %2Findex.html
ソースのパス。AMP(Google)のサーバでホストされているページでは、元のページのパスになる。
Title
platform: TITLE
analytics: ${title}
例: SYNCER
タイトル。
Viewer
platform: VIEWER
analytics: ${viewer}
例: www.google.com
ビューアの識別子。ブラウザで直接見ている場合は空文字。
Performance
JavaScriptのPerfomance関連のAPIを利用できます。
Content Load Time
platform: CONTENT_LOAD_TIME
analytics: ${contentLoadTime}
例: 35
前のページのunloaded
イベントが発火してから、DOMContentLoaded
イベントが発火するまでの時間。
Domain Lookup Time
platform: DOMAIN_LOOKUP_TIME
analytics: ${domainLookupTime}
ドメインのルックアップにかかった時間。
DOM Interactive Time
platform: DOM_INTERACTIVE_TIME
analytics: ${domInteractiveTime}
例: 48
前のページのunloaded
イベントが発火してから、DOM Interactiveになるまでの時間。
Navigation Redirect Count
platform: NAV_REDIRECT_COUNT
analytics: ${navRedirectCount}
リダイレクトの回数。
Navigation Timing
platform: NAV_TIMING
analytics: ${navTiming}
例: 1486284220539
Navigation Timing APIを利用できる。NAV_TIMING(navigationStart,responseStart)
というように引数付きで指定する。The PerformanceTiming interfaceを参照。
Navigation Type
platform: NAV_TYPE
analytics: ${navType}
Navigation Timing APIにおける、ナビゲーションの種類。通常のアクセスなら0
、リロードなら1
など。The PerformanceNavigation interfaceを参照。
Page Download Time
platform: PAGE_DOWNLOAD_TIME
analytics: ${pageDownloadTime}
例: 1
最後のByteをダウンロード完了するまでの時間。
Redirect Time
platform: REDIRECT_TIME
analytics: ${redirectTime}
リダイレクトにかかった時間。
Server Response Time
platform: SERVER_RESPONSE_TIME
analytics: ${serverResponseTime}
例: 13
サーバーの応答時間。
TCP Connection Time
platform: TCP_CONNECT_TIME
analytics: ${tcpConnectTime}
HTTP接続にかかった時間。
Device and Browser
ユーザーのデバイスやブラウザの情報を置換できます。
Available Screen Height
platform: AVAILABLE_SCREEN_HEIGHT
analytics: ${availableScreenHeight}
例: 1417
ページのレンダリングに必要な高さ。
Available Screen Width
platform: AVAILABLE_SCREEN_WIDTH
analytics: ${availableScreenWidth}
例: 2477
ページのレンダリングに必要な横幅。
Browser Language
platform: BROWSER_LANGUAGE
analytics: ${browserLanguage}
例: ja
ブラウザの言語設定。
Screen Color Depth
platform: SCREEN_COLOR_DEPTH
analytics: ${screenColorDepth}
例: 24
ブラウザの色深度。
Screen Height
platform: SCREEN_COLOR_DEPTH
analytics: ${screenHeight}
例: 1440
スクリーンの高さ。
Screen Width
platform: SCREEN_WIDTH
analytics: ${screenWidth}
例: 2560
スクリーンの横幅。
Scroll Height
platform: SCROLL_HEIGHT
analytics: ${scrollHeight}
例: 394
ページ全体の高さ。
Scroll Width
platform: SCROLL_WIDTH
analytics: ${scrollWidth}
例: 750
ページ全体の横幅。
Scroll Left
platform: SCROLL_WIDTH
analytics: ${scrollLeft}
X方向のスクロール量。
Scroll Top
platform: SCROLL_TOP
analytics: ${scrollTop}
Y方向のスクロール量。
Timezone
platform: TIMEZONE
analytics: ${timezone}
例: 540
タイムゾーン。UTCとの時差を表す分単位の数値。
Viewport Height
platform: VIEWPORT_HEIGHT
analytics: ${viewportHeight}
例: 394
ウィンドウの高さ。
Viewport Width
platform: VIEWPORT_WIDTH
analytics: ${viewportWidth}
例: 750
ウィンドウの横幅。
Interaction
Horizontal Scroll Boundary
platform: N/A
analytics: ${horizontalScrollBoundary}
Total Engaged Time
platform: TOTAL_ENGAGED_TIME
analytics: ${totalEngagedTime}
Vertical Scroll Boundary
platform: N/A
analytics: ${verticalScrollBoundary}
Visibility
Backgrounded
platform: N/A
analytics: ${backgrounded}
Backgrounded At Start
platform: TOTAL_ENGAGED_TIME
analytics: ${backgroundedAtStart}
Carousel From Slide
platform: N/A
analytics: ${fromSlide}
Carousel To Slide
platform: N/A
analytics: ${toSlide}
Element Height
platform: N/A
analytics: ${elementHeight}
Element Width
platform: N/A
analytics: ${elementWidth}
Element X
platform: N/A
analytics: ${elementX}
Element Y
platform: N/A
analytics: ${elementY}
First Seen Time
platform: N/A
analytics: ${firstSeenTime}
First Visible Time
platform: N/A
analytics: ${firstVisibleTime}
Last Seen Time
platform: N/A
analytics: ${lastSeenTime}
Last Visible Time
platform: N/A
analytics: ${lastVisibleTime}
Load Time Visibility
platform: N/A
analytics: ${loadTimeVisibility}
Max Continuous Visible Time
platform: N/A
analytics: ${maxContinuousVisibleTime}
Max Visible Percentage
platform: N/A
analytics: ${maxVisiblePercentage}
Min Visible Percentage
platform: N/A
analytics: ${minVisiblePercentage}
Total Time
platform: N/A
analytics: ${totalTime}
Total Visible Time
platform: N/A
analytics: ${totalVisibleTime}
Miscellaneous
AMP Version
platform: AMP_VERSION
analytics: ${ampVersion}
例: 1486153081489
ページで利用しているAMPのバージョン。
Background State
platform: BACKGROUND_STATE
analytics: ${backgroundState}
ページのバックグラウンド状態。0
なら表示、1
ならバックグラウンド。
Client ID
platform: CLIENT_ID
analytics: ${clientId}
Extra URL Parameters
platform: N/A
analytics: ${extraUrlParams}
Page View ID
platform: PAGE_VIEW_ID
analytics: ${pageViewId}
例: 3623
ページビューごとに割り当てられたID。ユーザー、日付、URLごとに一意となる可能性が高い文字列。
Query Parameter
platform: QUERY_PARAM
analytics: ${queryParam}
QUERY_PARAM(name)
というように引数を指定すると、そのクエリの値を取得できる。QUERY_PARAM(name,default)
というように第2引数を指定した場合、クエリの値がなかった場合に第2引数が置換の値となる。
Random
platform: RANDOM
analytics: ${random}
例: 0.24460565177638793
ランダムの数値。
Request Count
platform: N/A
analytics: ${requestCount}
Timestamp
platform: TIMESTAMP
analytics: ${timestamp}
例: 1486295674903
UNIXタイムスタンプ。