Method: isochrones.generate

计算并返回给定参数集的单个等时圈。

HTTP 请求

POST https://isochrones.googleapis.com/v1/isochrones:generate

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "travelDuration": string,
  "travelMode": enum (TravelMode),
  "travelDirection": enum (TravelDirection),
  "routingPreference": enum (RoutingPreference),
  "enableSmoothing": boolean,
  "polygonFidelity": enum (PolygonFidelity),

  // Union field origin can be only one of the following:
  "location": {
    object (LatLng)
  },
  "place": string
  // End of list of possible types for union field origin.
}
字段
travelDuration

string (Duration format)

必需。用于等时圈计算的行程时间。该值必须为正数,上限为 7200 秒(120 分钟)。对于 DRIVE 模式,允许的最长时长为 3600 秒(60 分钟)。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

travelMode

enum (TravelMode)

必需。交通方式。

travelDirection

enum (TravelDirection)

必需。行程方向。

routingPreference

enum (RoutingPreference)

可选。指定如何路由的偏好设置。默认值为 TRAFFIC_UNAWARE。

enableSmoothing

boolean

可选。指定是否平滑生成的等时圈多边形的边缘。

polygonFidelity

enum (PolygonFidelity)

可选。控制生成的多边形的精度。默认值为 POLYGON_FIDELITY_UNSPECIFIED。

联合字段 origin。必需。用于等时圈计算的起点。origin 只能是下列其中一项:
location

object (LatLng)

起点,以纬度/经度坐标表示。

place

string

地点的资源名称,格式为 places/{place_id}

响应正文

包含生成的等时圈数据的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "isochrone": {
    object (Isochrone)
  }
}
字段
isochrone

object (Isochrone)

仅限输出。生成的等时圈。

LatLng

表示纬度/经度对的对象。该对象以一对双精度数表示,分别代表纬度度数和经度度数。除非另有说明,否则该对象必须符合 WGS84 标准。值必须介于标准化范围内。

JSON 表示法
{
  "latitude": number,
  "longitude": number
}
字段
latitude

number

纬度(以度为单位)。它必须在 [-90.0, +90.0] 范围内。

longitude

number

经度(以度为单位)。它必须在 [-180.0, +180.0] 范围内。

TravelMode

定义用于等时圈计算的交通方式。

枚举
TRAVEL_MODE_UNSPECIFIED 未指定交通方式。
DRIVE 乘坐乘用车出行。
BICYCLE 骑自行车出行。
WALK 步行出行。

TravelDirection

指定用于等时圈计算的行程方向。

枚举
TRAVEL_DIRECTION_UNSPECIFIED 未指定行程方向。
FROM 计算从起点可到达的区域。 示例:“从我的仓库出发,30 分钟内可以送货到哪里?”
TO 计算从哪个区域出发可以到达起点。 示例:“我的员工从哪里出发,可以在 30 分钟内到达办公室?”

RoutingPreference

确定如何将路况信息纳入计算。

枚举
ROUTING_PREFERENCE_UNSPECIFIED 未指定路由偏好设置。服务器将使用其默认值,即 TRAFFIC_UNAWARE。
TRAFFIC_UNAWARE 计算不会考虑路况信息。等时圈将基于道路网络和静态行程时间。这适用于不考虑路况的规划目的。
TRAFFIC_AWARE 计算将考虑实时路况信息。

PolygonFidelity

控制等时圈多边形的详细程度。

枚举
POLYGON_FIDELITY_UNSPECIFIED 未指定多边形保真度。服务器将使用其默认值,该值基于行程时长。
LOW 精度低。适合用较少的顶点覆盖大面积区域。
MEDIUM 精度中等。在细节和工件大小之间取得平衡。
HIGH 精度高。边缘保真度高,但在道路网络密度较低的多边形中可能会产生孔洞。

Isochrone

等时圈计算的结果,表示在指定行程时间内从起点可到达的区域。

JSON 表示法
{

  // Union field geometry can be only one of the following:
  "geoJson": {
    object
  }
  // End of list of possible types for union field geometry.
}
字段
联合字段 geometry。等时圈的几何表示法。geometry 只能是下列其中一项:
geoJson

object (Struct format)

GeoJSON 格式的等时圈几何图形,使用 RFC 7946 格式:https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6