REST Resource: photo

资源:照片

照片用于存储 360 度全景照片以及照片元数据。

JSON 表示法
{
  "photoId": {
    object (PhotoId)
  },
  "uploadReference": {
    object (UploadRef)
  },
  "downloadUrl": string,
  "thumbnailUrl": string,
  "shareLink": string,
  "pose": {
    object (Pose)
  },
  "connections": [
    {
      object (Connection)
    }
  ],
  "captureTime": string,
  "uploadTime": string,
  "places": [
    {
      object (Place)
    }
  ],
  "viewCount": string,
  "transferStatus": enum (TransferStatus),
  "mapsPublishStatus": enum (MapsPublishStatus)
}
字段
photoId

object (PhotoId)

必需。仅供输出。更新照片时必须指定这项设置。仅在创建照片时输出。照片的标识符,在 Google 的所有照片中都是唯一的。

uploadReference

object (UploadRef)

仅限输入。创建照片时必填。仅限输入。照片字节上传到的资源网址。

downloadUrl

string

仅供输出。照片字节的下载网址。只有在 GetPhotoRequest.view 设置为 PhotoView.INCLUDE_DOWNLOAD_URL 时,此字段才会设置。

thumbnailUrl

string

仅供输出。显示给定照片预览的缩略图网址。

pose

object (Pose)

可选。照片照片。

connections[]

object (Connection)

可选。连接到其他照片。连接表示此照片与另一张照片之间的关联。

captureTime

string (Timestamp format)

可选。照片的绝对时间。当照片没有 Exif 时间戳时,这用于设置照片元数据中的时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

uploadTime

string (Timestamp format)

仅供输出。图片上传的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

places[]

object (Place)

可选。此照片所属的地点。

viewCount

string (int64 format)

仅供输出。查看照片的数量。

transferStatus

enum (TransferStatus)

仅供输出。此照片的权利转移状态。

mapsPublishStatus

enum (MapsPublishStatus)

仅供输出。Google 地图中的状态:此照片是已发布还是已被拒绝。

照片 ID

Photo 的标识符。

JSON 表示法
{
  "id": string
}
字段
id

string

照片的唯一标识符。

上传参考

媒体文件的上传参考信息。

JSON 表示法
{

  // Union field file_source can be only one of the following:
  "uploadUrl": string
  // End of list of possible types for union field file_source.
}
字段
联合字段 file_source。必需。file_source 只能是下列其中一项:
uploadUrl

string

每位用户的上传引用都应该是唯一的。其格式为:“https://StreetViewpublish.googleapis.com/media/user/{account_id}/photo/{uploadReference}”

姿势

实体的原始姿态测量。

JSON 表示法
{
  "latLngPair": {
    object (LatLng)
  },
  "altitude": number,
  "heading": number,
  "pitch": number,
  "roll": number,
  "gpsRecordTimestampUnixEpoch": string,
  "level": {
    object (Level)
  },
  "accuracyMeters": number
}
字段
latLngPair

object (LatLng)

姿势的纬度和经度对,如下所述:https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng 创建 Photo 时,如果未提供纬度和经度对,系统会使用 exif 标头中的地理定位。照片或 exif 标题中未提供的纬度和经度对会导致照片处理失败。

altitude

number

姿势高度(以米为单位,高于 WGS84 椭球体)。NaN 表示未衡量的数量。

heading

number

以下位置参数与照片的中心相关。需与 https://developers.google.com/streetview/spherical-metadata 一致。罗盘航向,在照片中心测量,以与北方所呈顺时针角度表示。值必须大于等于 0 且小于 360。NaN 表示未衡量的数量。

pitch

number

俯仰角,以照片中心为基准(以度为单位)。值必须大于等于 90 且小于等于 90。值 -90 表示直接俯视,值 90 表示直接向上看。NaN 表示未衡量的数量。

roll

number

滚动,以度为单位。值必须大于等于 0 且小于 360。值为 0 表示地平线。NaN 表示未衡量的数量。

gpsRecordTimestampUnixEpoch

string (Timestamp format)

自世界协调时间 (UTC) 纪元起的 GPS 记录的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

level

object (Level)

用于配置垂直导航的楼层(建筑物内的楼层)。

accuracyMeters

number

此姿势的水平精度估算值,以米为单位,置信度为 68%(1 个标准偏差)。例如,在 Android 上,可通过 https://developer.android.com/reference/android/location/Location#getAccuracy() 方法获取此值。其他平台可通过不同的方法获取类似的准确度估值。

LatLng

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

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

number

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

longitude

number

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

等级

包含层级编号及其对应名称的层级信息。

JSON 表示法
{
  "number": number,
  "name": string
}
字段
number

number

可选。楼层编号,用于订购。0 表示地面,1 表示高于地面的第一级,-1 表示低于地面的第一级。可以使用非整数值。

name

string

必需。为该级别指定的名称,不得超过 3 个字符。并考虑在存在电梯时,应如何标记此级别的电梯按钮。

连接

连接是指从源照片到目标照片的链接。

JSON 表示法
{
  "target": {
    object (PhotoId)
  }
}
字段
target

object (PhotoId)

必需。从包含照片到另一张照片的连接目标。

地点

为实体添加元数据。

JSON 表示法
{
  "placeId": string,
  "name": string,
  "languageCode": string
}
字段
placeId

string

地点标识符,如 https://developers.google.com/places/place-id 中所述。

name

string

仅供输出。地点的名称,已本地化为 languageCode。

languageCode

string

仅供输出。名称经过本地化的 languageCode。它应该是请求中指定的 languageCode,但可以是回退机制。

传输状态

权利转让的状态。

枚举
TRANSFER_STATUS_UNKNOWN 此转移的状态未指定。
NEVER_TRANSFERRED 这张照片从未传输过。
PENDING 此照片转移流程已发起,但对方尚未回复。
COMPLETED 照片转移已完成,并且照片已转移给接收者。
REJECTED 收款人拒绝了这张照片转移。
EXPIRED 照片转移在收件人执行任何操作之前已过期。
CANCELLED 发送者已取消此照片转移。
RECEIVED_VIA_TRANSFER 由于权利转移,接收者拥有此照片。

地图发布状态

照片在 Google 地图上的发布状态。

枚举
UNSPECIFIED_MAPS_PUBLISH_STATUS 照片状态未知。
PUBLISHED 照片会通过 Google 地图向公众发布。
REJECTED_UNKNOWN 照片因未知原因而遭到拒绝。

方法

create

客户端上传完返回的 UploadRef 照片后,CreatePhoto 会将上传的 Photo 发布到 Google 地图上的街景。

delete

删除 Photo 及其元数据。

get

获取指定 Photo 的元数据。

startUpload

创建上传会话以开始上传照片字节。

update

更新 Photo 的元数据,例如位置方向、地点关联、连接等。