Skip to content

docs: update required Google APIs documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
isamu merged 1 commit into from
Jan 24, 2026
Merged

docs: update required Google APIs documentation #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,28 @@ interface MapToolData {

## Google Maps API Setup

This plugin requires a Google Maps API key with the **Maps Embed API** enabled.
This plugin requires a Google Maps API key with several APIs enabled.

### Step 1: Create a Google Cloud Project

1. Go to [Google Cloud Console](https://console.cloud.google.com/)
2. Create a new project or select an existing one
3. Make sure billing is enabled for the project

### Step 2: Enable Maps Embed API
### Step 2: Enable Required APIs

1. Go to [APIs & Services > Library](https://console.cloud.google.com/apis/library)
2. Search for "Maps Embed API"
3. Click on **Maps Embed API**
4. Click **Enable**
This plugin requires the following 4 APIs. Enable all of them:

| API | Purpose | Enable Link |
|-----|---------|-------------|
| **Maps JavaScript API** | Interactive map, markers, controls | [Enable](https://console.cloud.google.com/apis/library/maps-backend.googleapis.com) |
| **Places API (New)** | Search locations by name | [Enable](https://console.cloud.google.com/apis/library/places-backend.googleapis.com) |
| **Directions API** | Route calculation between points | [Enable](https://console.cloud.google.com/apis/library/directions-backend.googleapis.com) |
| **Geocoding API** | Convert addresses to coordinates | [Enable](https://console.cloud.google.com/apis/library/geocoding-backend.googleapis.com) |

> **Note**: You can use either "Places API" (legacy) or "Places API (New)".

> **Troubleshooting**: If the map doesn't work, check [APIs & Services > Enabled APIs](https://console.cloud.google.com/apis/dashboard) to verify all 4 APIs are enabled. Also check if any API has quota limits or restrictions in its settings.

### Step 3: Create an API Key

Expand All @@ -87,7 +95,7 @@ This plugin requires a Google Maps API key with the **Maps Embed API** enabled.
3. Copy the generated API key
4. (Recommended) Click **Edit API key** to add restrictions:
- **Application restrictions**: HTTP referrers (for web apps)
- **API restrictions**: Restrict to "Maps Embed API"
- **API restrictions**: Restrict to the 4 APIs above

### Step 4: Configure the Plugin

Expand Down