REST Resource: photo

资源: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 时间戳,则使用此值在照片元数据中设置时间戳。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

uploadTime

string (Timestamp format)

仅限输出。图片上传时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

places[]

object (Place)

可选。相应照片所属的营业地点。

viewCount

string (int64 format)

仅限输出。照片的查看次数。

transferStatus

enum (TransferStatus)

仅限输出。相应照片的版权转移状态。

mapsPublishStatus

enum (MapsPublishStatus)

仅限输出。在 Google 地图中的状态,即相应照片是已发布还是已遭拒。

PhotoId

Photo 的标识符。

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

string

照片的唯一标识符。

UploadRef

媒体文件的上传参考。

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

每个用户的上传参考 ID 都应该是唯一的。其格式如下:“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 记录时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

level

object (Level)

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

accuracyMeters

number

相应姿势的估计水平精确度(以米为单位),置信度为 68%(一个标准差)。例如,在 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,但也可以是回退语言代码。

TransferStatus

版权转移的状态。

枚举
TRANSFER_STATUS_UNKNOWN 相应转移的状态未指定。
NEVER_TRANSFERRED 此照片从未参与过传输。
PENDING 照片转移已发起,但接收者尚未做出回应。
COMPLETED 照片转移已完成,此照片已转移给接收者。
REJECTED 收件人拒绝了此照片转移。
EXPIRED 在收件人采取任何操作之前,照片转移已过期。
CANCELLED 发送者已取消此照片转移。
RECEIVED_VIA_TRANSFER 由于权利转移,收件人拥有此照片。

MapsPublishStatus

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

枚举
UNSPECIFIED_MAPS_PUBLISH_STATUS 照片的状态未知。
PUBLISHED 照片通过 Google 地图公开发布。
REJECTED_UNKNOWN 照片因未知原因而被拒。

方法

create

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

delete

删除 Photo 及其元数据。

get

获取指定 Photo 的元数据。

startUpload

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

update

更新 Photo 的元数据,例如姿势、地点关联、连接等。