Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions plugins/GoogleSearchConsole/v1/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Prerequisites

- A Google account with access to Google Search Console
- A verified URL-prefix property in Google Search Console
- A verified Search Console property (URL-prefix or Domain)
- A Google Cloud Project

## Enabling the Google Search Console API
Expand Down Expand Up @@ -61,13 +61,22 @@

8. Copy the **Client ID** and **Client Secret** that are displayed, save these somewhere secure as you won't be able to view the client secret again

## Which property value to use

Search Console has two property types, entered differently:

- **URL-prefix** β€” shown as a full `https://…` URL. Use the exact URL **including the trailing slash**: `https://example.com/`. Protocol and subdomain must match exactly.
- **Domain** β€” shown with a 🌐 globe icon and a bare domain (DNS-verified). Use the `sc-domain:` form with **no protocol or slash**: `sc-domain:example.com`.

Not sure which you have? Check the property selector in Search Console, or call the API's `sites.list` to see the exact string for your account.

## Configuring the plugin

Populate the following fields when configuring the plugin:

| Field | Description |
|---------|---------|
| Search Console property URL | The exact URL-prefix property from Google Search Console (for example, `https://example.com/`) |
| Search Console property | Your property as it appears in Search Console. URL-prefix: full URL with trailing slash (e.g. `https://example.com/`). Domain: the `sc-domain:` form, no protocol or slash (e.g. `sc-domain:example.com`) |
| Google OAuth client ID | The Client ID created in Google Cloud |
| Google OAuth client secret | The Client Secret created in Google Cloud |
| Sign in | Click to authenticate using a Google account that has access to the Search Console property |
Expand All @@ -76,7 +85,7 @@ Populate the following fields when configuring the plugin:

| Setting | Example |
|---------|---------|
| Search Console property URL | `https://example.com/` |
| Search Console property | `https://example.com/` (URL-prefix) or `sc-domain:example.com` (Domain) |
| Google OAuth client ID | `1234567890-example.apps.googleusercontent.com` |
| Google OAuth client secret | `GOCSPX-xxxxxxxxxxxxxxxxxxxx` |

Expand All @@ -100,4 +109,5 @@ Verify that:

- The property exists in Google Search Console
- The signed-in Google account has access to the property
- The property URL exactly matches the URL entered in the plugin configuration
- The property value exactly matches the identifier in Search Console
- A **403 "insufficient permission"** despite being an owner usually means the property *type* is wrong β€” e.g. entering `https://example.com/` for a **Domain** property. Use `sc-domain:example.com` instead (and vice versa)
2 changes: 1 addition & 1 deletion plugins/GoogleSearchConsole/v1/metadata.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "google-search-console",
"displayName": "Google Search Console",
"version": "1.0.0",
"version": "1.0.1",
"author": {
"name": "@Daniel-Hodgson-SquaredUp",
"type": "community"
Expand Down
6 changes: 3 additions & 3 deletions plugins/GoogleSearchConsole/v1/ui.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
{
"name": "siteUrl",
"type": "text",
"label": "Search Console property URL",
"help": "Enter the exact URL-prefix property from Google Search Console. Example: https://example.com/",
"placeholder": "https://example.com/",
"label": "Search Console property",
"help": "Enter your property exactly as it appears in Search Console. URL-prefix: the full URL including the trailing slash (e.g. https://example.com/). Domain: the sc-domain: form, no protocol or slash (e.g. sc-domain:example.com).",
"placeholder": "https://example.com/ or sc-domain:example.com",
"validation": {
"required": true
}
Expand Down
Loading