Google Maps Platform

The Google Maps Platform SDK for TypeScript provides typed access to the Google Maps Platform REST APIs from Node.js and the browser.

[!TIP] Looking for a specific signature, request field, model, enum or error type? This SDK ships a generated, machine-readable SDK map — a lookup index of the whole TypeScript surface. Consult it before grepping or scanning the source tree; it answers most contract questions directly and, where a source file is genuinely needed, names the exact one to open. Details under SDK map.

API Specification for Google Maps Platform

Installation

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

npm install <path-to-sdk>

Quick Start

Your first call

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { GoogleMapsPlatformClient, ServerEnvironment } from "google-maps-platform";

const client = new GoogleMapsPlatformClient({
  serverEnvironment: ServerEnvironment.Production,
  apiKeyAuth: "YOUR_API_KEY",
});

Every option has a default — see DEFAULT_CLIENT_OPTIONS in the same module. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJS

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("google-maps-platform");

const client = new sdk.GoogleMapsPlatformClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  apiKeyAuth: "YOUR_API_KEY",
});

Usage

For code examples and error responses, see API Reference.

SDK map

This SDK ships a generated SDK map — sdk-map.md plus the pages under map/operations/ — a deterministic, lookup-oriented table of contents of the TypeScript surface, generated alongside the SDK.

Read it before scanning the source. Whether you are an AI coding assistant or searching by hand, the map answers "what is the exact …" by lookup for every call-level contract, and for anything it does not carry it names the one file that does:

• sdk-map.md — the index: client construction, the two error families, the non-throwing .asApiResult() form, servers, environments and auth, the model locator with every enum and union, the runtime facts, and the SDK-wide defaults every operation relies on.
• map/operations/ — one page per resource: the exact signature and return type, the verb and route, the request body and its media type, a Fields table giving every request field its channel, and a Type sources table naming the file and schema value of every type the operation mentions.

Model shapes are not duplicated in the map, and not in the API reference either. Both name the type and the file to read; that file is the single source of truth and cannot go stale against the code.

Each operation block states only what is specific to it. The SDK-wide defaults are stated once in sdk-map.md — the call shape, the base ResponseError, the default server group — and a block departs from one only by saying so, so a block silent on a point is telling you the default applies. Take it and move on rather than opening the source to confirm.

Which one to reach for

The map and the API reference answer different questions, and both are generated from this SDK so they stay in lockstep with the code.

| Use | For | | --- | --- | | sdk-map.md + map/operations/ | Traversing the SDK and working out its surface — locating the operation you need (this SDK exposes 17 operations), its exact signature, which credential it sends, which channel every request field travels on, which error type it rejects with and how to read it, and the file behind any type. This is the index to consume the SDK from, and the one to reach for first. | | api-reference.md | Usage guidance for a single operation once you know which one you want — a code sample, per-parameter descriptions, and the success and error types it resolves or rejects with. |

License

This SDK is distributed under the MIT License.

Support

Refer to the API reference for detailed information on available operations with code samples.