|
| 1 | +# Umbraco.Cms.Integrations.SEO.GoogleSearchConsole.URLInspectionTool |
| 2 | + |
| 3 | +This integration provides an extension for Umbraco CMS allowing programmatic access to URL-level data for properties managed in Google Search Console and the indexed version of a URL. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +Requires minimum versions of Umbraco: |
| 8 | + |
| 9 | +- CMS V8: 8.4.0 |
| 10 | +- CMS V9: 9.0.1 |
| 11 | + |
| 12 | +## How To Use |
| 13 | + |
| 14 | +### Authentication |
| 15 | + |
| 16 | +The package uses OAuth2 security protocol for authentication. After the authorization process completes successfully, |
| 17 | +the access token and the refresh token will be saved into the Umbraco database. |
| 18 | + |
| 19 | +All requests to the Google Search Console API will include the access token in the authorization header. |
| 20 | + |
| 21 | +### Working With the URL Inspection Tool |
| 22 | + |
| 23 | +The URL Inspection Tool is accessible from each content node via the _URL Inspection_ content app. |
| 24 | + |
| 25 | +If you haven't connected you Google account yet, you will be able to authorize your Umbraco application |
| 26 | +by using the _Connect_ button. This will prompt the Google authorization window and at the end of the process you will receive |
| 27 | +the access token and the refresh token. |
| 28 | + |
| 29 | +You can also choose to remove access to Google Search Console API by triggering the _Revoke_ action. This will remove the access token and the refresh token |
| 30 | +from the database. |
| 31 | + |
| 32 | +Before you can properly use the URL Inspection Tool to retrieve data from the Search Console API you |
| 33 | +will need to register the domain of you Umbraco website as a property in [Google Search Console](https://search.google.com/search-console). |
| 34 | + |
| 35 | +After Google has verified your ownership, the _URL Inspection_ tool will provide the proper results. Otherwise a _PERMISSION_DENIED_ |
| 36 | +error will be prompted. |
| 37 | + |
| 38 | +The URL Inspection Tool API expects three parameters, two mandatory: |
| 39 | +- inspectionUrl - fully-qualified URL to inspect. Must be under the property specified in "siteUrl". |
| 40 | +- siteUrl - the URL of the property as defined in Search Console. |
| 41 | +- languageCode - optional; default value is "en-US". |
| 42 | + |
| 43 | +More information can be found [here](https://developers.google.com/webmaster-tools/v1/urlInspection.index/inspect) |
| 44 | + |
0 commit comments