将会话令牌与 Map Tiles API 搭配使用

欧洲经济区 (EEA) 开发者

会话令牌是一段数据(UUID),用于在 REST 调用中标识会话(一系列相关的消息交换)。您必须在 2D 图块和街景图像的所有请求中包含会话令牌。 您需要将其作为附加到所有请求网址的 session 参数的值。

在 Map Tiles API 中,会话令牌表示一组已定义的显示选项。这意味着您无需在每个图块请求中传递一组显示选项。您可以在多个客户端中使用同一会话令牌。 会话令牌目前在签发后两周内有效,但此期限可能会发生变化。您始终可以通过查看响应消息中的 expiry 字段来检查会话令牌的到期时间。

会话令牌请求

如需请求会话令牌,请向 createSession 端点发送 HTTPS POST 请求,如以下示例所示。您必须发送带有 Content-Type: application/json 标头的请求。

curl -X POST -d '{
  "mapType": "streetview",
  "language": "en-US",
  "region": "US"
}' \
-H 'Content-Type: application/json' \
"https://tile.googleapis.com/v1/createSession?key=YOUR_API_KEY"

必填字段

mapType

基本地图的类型。这个值可以是以下值之一:

roadmap
标准 Google 地图绘制的地图图块。
satellite
卫星图像。
terrain
地形图像。选择 terrain 作为地图类型时,您还必须添加 layerRoadmap 图层类型(在可选字段部分中进行了介绍)。
streetview
街景全景图片。如需了解详情,请参阅街景图块。
language

一个 IETF 语言标记,用于指定在图块上显示信息时所用的语言。例如,en-US 指定美国使用的英语。

region

通用语言区域数据代码库区域标识符(两个大写字母),表示用户的实际位置。例如 US。

可选字段

imageFormat
指定要返回的文件格式。有效值为 jpeg 或 png。 JPEG 文件不支持透明度,因此不建议用于叠加图块。如果您未指定 imageFormat,系统会自动为图块选择最佳格式。
scale

放大地图元素(例如道路标签)的大小,同时保留默认图块的图块大小和覆盖区域。提高比例还会减少地图上的标签数量,从而减少杂乱。以下值是有效的 scale 值:

  • scaleFactor1x:默认值。
  • scaleFactor2x:将标签大小加倍,并移除次要地图项标签。
  • scaleFactor4x:将标签大小放大到原来的四倍,并移除次要特征标签。

以下示例展示了缩放地图元素的效果。

缩放比例 1x 缩放比例 2x
显示缩放比例 1x 的地图 显示缩放比例为 2x 的地图
highDpi
指定是否返回高分辨率图块。如果缩放比例增加,则使用 highDpi 来增加图块的大小。通常,提高缩放比例会将生成的图块放大为相同大小的图片,这会降低质量。使用 highDpi 时,生成的文件大小也会增加,从而保持质量。DPI 代表每英寸的点数,高 DPI 意味着图块渲染时使用的每英寸的点数比正常情况多。如果为 true,则 x 和 y 维度中的像素数都会乘以缩放比例(即 2 倍或 4 倍)。图块的覆盖区域保持不变。 此参数仅适用于 scale 值为 2x 或 4x 的情况。它对 1x 缩放图块没有影响。
缩放比例 1x 缩放比例 2x 高 DPI
地图以常规分辨率显示 地图以 2 倍高 DPI 分辨率显示
layerTypes

一个值数组,用于指定添加到地图中的图层类型。有效值包括:

layerRoadmap
如果您将 terrain 指定为地图类型,则必须使用此属性。也可以选择叠加在 satellite 地图类型上。对路线图图块没有影响。
layerStreetview
在地图上使用蓝色轮廓显示支持街景的街道和地点。
layerTraffic
显示当前路况信息。
styles

一个 JSON 样式对象数组,用于指定道路、公园和建成区等地图项的外观和详细程度。样式设置用于自定义标准 Google 基本地图。仅当地图类型为 roadmap 时,styles 参数才有效。如需了解完整的样式语法,请参阅样式参考。

overlay

一个布尔值,用于指定 layerTypes 应呈现为单独的叠加层,还是与基础图像合并。如果为 true,则不显示基本地图。如果您未定义任何 layerTypes,则系统会忽略此值。

例如,请求 satellite 地图类型(包含 layerRoadmap 图层,且 overlay 设置为 false)会生成与 Maps JavaScript API 中使用的 hybrid 地图类型等效的图块(左图)。如果将 overlay 设置为 true,则相同的地图和图层类型会生成带有地理分布图的透明图块,其样式适合叠加在卫星图像上(右图)。

overlay:false overlay:true
叠加层设置为 false 叠加层设为 true

以下 JSON 是一个典型请求正文的示例,其中包含必填字段和选填字段。

{
  "mapType": "satellite",
  "language": "en-US",
  "region": "us",
  "layerTypes": [ "layerRoadmap", "layerStreetview" ],
  "overlay":  true,
  "scale": "scaleFactor1x",
  "styles": [
    {
      "stylers": [
        { "hue": "#00ffe6" },
        { "saturation": -20 }
      ]
    },{
      "featureType": "road",
      "elementType": "geometry",
      "stylers": [
        { "lightness": 100 },
        { "visibility": "simplified" }
      ]
    }
  ]
}

此示例提供了一个适合与卫星图像结合使用的叠加层。该示例包含路线图和街景叠加层。生成的地图会以英语(美国)呈现名称和数据。

会话令牌响应

以下 JSON 是一个响应正文示例。

{
  "session": "IgAAAHGU9jnAU4KOAfwY3Bcd6eH_WxQsyocSBAdUnAr9pnvTTNXtF9c_27RBo94ytEXTDg",
  "expiry": "1361828036",
  "tileWidth": 256,
  "tileHeight": 256,
  "imageFormat": "png"
}

以下列表包含响应正文中的字段定义。

session
您必须在所有 Map Tiles API 请求中包含的会话令牌值。
expiry
一个字符串,其中包含令牌到期的时间(自新纪元开始算起,以秒为单位)。会话令牌自创建之日起两周内有效,但此政策可能会发生变化,恕不另行通知。
tileWidth
图块的宽度(以像素为单位)。
tileHeight
图块的高度(以像素为单位)。
imageFormat
图片格式,可以是 png 或 jpeg。