forked from ampproject/amphtml
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add required logic for view/engagement analytics without an iframe
- Loading branch information
Jason Rogers
committed
Oct 27, 2017
1 parent
4dd3658
commit e524f96
Showing
17 changed files
with
752 additions
and
175 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| /** | ||
| * Copyright 2017 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| import {Services} from '../../../../src/services'; | ||
| import {addParamsToUrl} from '../../../../src/url'; | ||
|
|
||
| import {API_SERVER} from '../constants'; | ||
| import {getSessionId} from './session'; | ||
| import {pixelDrop} from './pixel'; | ||
|
|
||
| const getEngData = ({monitors, loc, ampDoc, pubId}) => { | ||
| const { | ||
| dwellMonitor, | ||
| scrollMonitor, | ||
| clickMonitor, | ||
| activeToolsMonitor, | ||
| } = monitors; | ||
| const {host, pathname, hash} = loc; | ||
| const viewport = Services.viewportForDoc(ampDoc); | ||
|
|
||
| return { | ||
| al: activeToolsMonitor.getActivePcos().join(',') || undefined, | ||
| amp: 1, | ||
| dc: 1, | ||
| dp: host, | ||
| dt: dwellMonitor.getDwellTime(), | ||
| fp: pathname.replace(hash, ''), | ||
| ict: clickMonitor.getIframeClickString(), | ||
| ivh: scrollMonitor.getInitialViewHeight(), | ||
| pct: clickMonitor.getPageClicks(), | ||
| pfm: ampDoc.win.navigator.sendBeacon ? 0 : 1, | ||
| ph: viewport.getHeight(), | ||
| pub: pubId, | ||
| sh: scrollMonitor.getScrollHeight(), | ||
| sid: getSessionId(), | ||
| }; | ||
| }; | ||
|
|
||
| export const callEng = props => { | ||
| const data = getEngData(props); | ||
| const url = addParamsToUrl(`${API_SERVER}/live/red_lojson/100eng.json`, data); | ||
| const {ampDoc} = props; | ||
|
|
||
| if (ampDoc.win.navigator.sendBeacon) { | ||
| ampDoc.win.navigator.sendBeacon(url, '{}'); | ||
| } else { | ||
| pixelDrop(url, ampDoc); | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
extensions/amp-addthis/0.1/addthis-utils/monitors/active-tools-monitor.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /** | ||
| * Copyright 2017 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| import {RE_ALPHA} from '../../constants'; | ||
|
|
||
| const RE_NUMDASH = /[0-9\-].*/; | ||
|
|
||
| export class ActiveToolsMonitor { | ||
| constructor() { | ||
| this.activePcos_ = {}; | ||
| } | ||
|
|
||
| record({widget}) { | ||
| // Get the "clean" PCO (no numbers or dashes) from the widget. | ||
| const pco = (widget.id || widget.pco || '').replace(RE_NUMDASH, ''); | ||
|
|
||
| // PCOs must be alpha strings, and we don't want duplicates. | ||
| if (!pco || this.activePcos_[pco] || !RE_ALPHA.test(pco)) { | ||
| return; | ||
| } | ||
|
|
||
| this.activePcos_[pco] = pco; | ||
| } | ||
|
|
||
| getActivePcos() { | ||
| return Object.keys(this.activePcos_); | ||
| } | ||
| } |
75 changes: 75 additions & 0 deletions
75
extensions/amp-addthis/0.1/addthis-utils/monitors/click-monitor.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /** | ||
| * Copyright 2017 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import {listen} from '../../../../../src/event-helper'; | ||
|
|
||
| export class ClickMonitor { | ||
| constructor() { | ||
| this.iframeClickMap_ = {}; | ||
| this.pageClicks_ = 0; | ||
| this.lastSelection_ = null; | ||
| this.win_ = null; | ||
| } | ||
|
|
||
| startForDoc(ampDoc) { | ||
| this.win_ = ampDoc.win; | ||
| this.lastSelection_ = this.win_.document.activeElement; | ||
|
|
||
| listen(this.win_, 'blur', this.checkSelection_.bind(this)); | ||
| listen(this.win_, 'click', this.onPageClick_.bind(this)); | ||
| } | ||
|
|
||
| checkSelection_() { | ||
| const {activeElement} = this.win_.document; | ||
|
|
||
| if (!activeElement) { | ||
| return; | ||
| } | ||
|
|
||
| const changeOccurred = activeElement !== this.lastSelection_; | ||
|
|
||
| if (activeElement.tagName === 'IFRAME' && changeOccurred) { | ||
| this.incrementFrameClick_(activeElement); | ||
| } | ||
|
|
||
| this.lastSelection_ = activeElement; | ||
| } | ||
|
|
||
| onPageClick_() { | ||
| this.pageClicks_++; | ||
| this.lastSelection_ = this.win_.document.activeElement; | ||
| } | ||
|
|
||
| incrementFrameClick_(activeElement) { | ||
| const trimSrc = activeElement.src.split('://').pop(); | ||
|
|
||
| if (!this.iframeClickMap_[trimSrc]) { | ||
| this.iframeClickMap_[trimSrc] = 1; | ||
| } else { | ||
| this.iframeClickMap_[trimSrc]++; | ||
| } | ||
| } | ||
|
|
||
| getPageClicks() { | ||
| return this.pageClicks_; | ||
| } | ||
|
|
||
| getIframeClickString() { | ||
| return Object.keys(this.iframeClickMap_).map(key => { | ||
| return `${key}|${this.iframeClickMap_[key]}`; | ||
| }).join(','); | ||
| } | ||
| } |
40 changes: 40 additions & 0 deletions
40
extensions/amp-addthis/0.1/addthis-utils/monitors/dwell-monitor.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /** | ||
| * Copyright 2017 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import {Services} from '../../../../../src/services'; | ||
|
|
||
| export class DwellMonitor { | ||
| constructor() { | ||
| this.dwellTime_ = 0; | ||
| this.viewer_ = null; | ||
| } | ||
|
|
||
| startForDoc(ampDoc) { | ||
| this.viewer_ = Services.viewerForDoc(ampDoc); | ||
| this.viewer_.onVisibilityChanged(this.listener.bind(this)); | ||
| } | ||
|
|
||
| listener() { | ||
| if (!this.viewer_.isVisible()) { | ||
| const lastVisibleTime = this.viewer_.getLastVisibleTime() || 0; | ||
| this.dwellTime_ += (Date.now() - lastVisibleTime); | ||
| } | ||
| } | ||
|
|
||
| getDwellTime() { | ||
| return this.dwellTime_; | ||
| } | ||
| } |
19 changes: 19 additions & 0 deletions
19
extensions/amp-addthis/0.1/addthis-utils/monitors/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /** | ||
| * Copyright 2017 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| export {ScrollMonitor} from './scroll-monitor'; | ||
| export {ClickMonitor} from './click-monitor'; | ||
| export {DwellMonitor} from './dwell-monitor'; | ||
| export {ActiveToolsMonitor} from './active-tools-monitor'; |
Oops, something went wrong.