Skip to content

Commit

Permalink
Adding docs for GPT API audits (#253)
Browse files Browse the repository at this point in the history
* Adding docs for GPT API audits

* Updates to docs based on comments

* Fixes to audit docs to add clarity / amend spelling errors

* A few grammar fixes to GPT Audit Docs
  • Loading branch information
avparmar authored Feb 8, 2021
1 parent 00a99fa commit 24bfc04
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/audits/deprecated-api-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Avoid deprecated GPT APIs

## Overview

This audit ensures that the page does not use any deprecated Google Publisher Tag (GPT) APIs.
Deprecated APIs are googletag methods or configuration options which are no longer maintained or documented. As these APIs
may be partly or wholly removed from GPT, their use is discouraged and unpredictable behavior could come from their
continued use.

## Recommendations

Observe the details of the audit to see which deprecated APIs the page is using and remove their usages.
Many deprecated APIs will have a supported alternative which can be used instead.

Check [the official GPT release notes](https://developers.google.com/publisher-tag/release-notes) for more information on
deprecated APIs and suggested alternatives.

## More information

This audit checks console messages for the presence of any warnings or errors coming from GPT which are related to deprecated or
discouraged APIs.
20 changes: 20 additions & 0 deletions docs/audits/gpt-errors-overall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Fix GPT errors

## Overview

This audit ensures that no warnings or errors related to Google Publisher Tags (GPT) are present. Reducing errors can help
ensure that user experience is consistent and the page is tagged as intended.

## Recommendations

Observe the details of the audit to see more specific details on the errors affecting the page.
Run [Publisher Ads Audits for Lighthouse](https://developers.google.com/publisher-ads-audits)
regularly when making changes to the webpage to minimize the introduction of new errors.

Check [the official GPT best practices pages](https://developers.google.com/publisher-tag/guides/general-best-practices)
for more information on recommended usage of GPT on your page.

## More information

This audit checks console messages for the presence of any warnings or errors coming from GPT, excluding those related to other
audits.

0 comments on commit 24bfc04

Please sign in to comment.