-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding docs for GPT API audits (#253)
* 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
Showing
2 changed files
with
41 additions
and
0 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
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. |
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,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. |