Index
StreetViewPublishService
(interface)BatchDeletePhotosRequest
(message)BatchDeletePhotosResponse
(message)BatchGetPhotosRequest
(message)BatchGetPhotosResponse
(message)BatchUpdatePhotosRequest
(message)BatchUpdatePhotosResponse
(message)Connection
(message)CreatePhotoRequest
(message)CreatePhotoSequenceRequest
(message)CreatePhotoSequenceRequest.InputType
(enum)DeletePhotoRequest
(message)DeletePhotoSequenceRequest
(message)GetPhotoRequest
(message)GetPhotoSequenceRequest
(message)GpsDataGapFailureDetails
(message)Imu
(message)Imu.Measurement3d
(message)ImuDataGapFailureDetails
(message)InsufficientGpsFailureDetails
(message)LatLngBounds
(message)Level
(message)ListPhotoSequencesRequest
(message)ListPhotoSequencesResponse
(message)ListPhotosRequest
(message)ListPhotosResponse
(message)NoOverlapGpsFailureDetails
(message)NotOutdoorsFailureDetails
(message)Photo
(message)Photo.MapsPublishStatus
(enum)Photo.TransferStatus
(enum)PhotoId
(message)PhotoResponse
(message)PhotoSequence
(message)PhotoSequence.GpsSource
(enum)PhotoView
(enum)Place
(message)Pose
(message)ProcessingFailureDetails
(message)ProcessingFailureReason
(enum)ProcessingState
(enum)UpdatePhotoRequest
(message)UploadRef
(message)
StreetViewPublishService
Publishes and connects user-contributed photos on Street View.
BatchDeletePhotos |
---|
Deletes a list of Note that if
|
BatchGetPhotos |
---|
Gets the metadata of the specified Note that if
|
BatchUpdatePhotos |
---|
Updates the metadata of Note that if Only the fields specified in The number of
|
CreatePhoto |
---|
After the client finishes uploading the photo with the returned Currently, the only way to set heading, pitch, and roll in CreatePhoto is through the Photo Sphere XMP metadata in the photo bytes. CreatePhoto ignores the This method returns the following error codes:
|
CreatePhotoSequence |
---|
After the client finishes uploading the
This method returns the following error codes:
|
DeletePhoto |
---|
Deletes a This method returns the following error codes:
|
DeletePhotoSequence |
---|
Deletes a This method returns the following error codes:
|
GetPhoto |
---|
Gets the metadata of the specified This method returns the following error codes:
|
GetPhotoSequence |
---|
Gets the metadata of the specified This method returns the following three types of responses:
This method returns the following error codes:
|
ListPhotoSequences |
---|
Lists all the
|
ListPhotos |
---|
Lists all the
|
StartPhotoSequenceUpload |
---|
Creates an upload session to start uploading photo sequence data. The upload URL of the returned After the upload is complete, the
|
StartUpload |
---|
Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?ref_topic=6275604, the photo must meet the following requirements:
After the upload completes, the method uses
|
UpdatePhoto |
---|
Updates the metadata of a Only the fields specified in the This method returns the following error codes:
|
BatchDeletePhotosRequest
Request to delete multiple Photos
.
Fields | |
---|---|
photo_ids[] |
Required. IDs of the |
BatchDeletePhotosResponse
Response to batch delete of one or more Photos
.
Fields | |
---|---|
status[] |
The status for the operation to delete a single |
BatchGetPhotosRequest
Request to get one or more Photos
. By default
- does not return the download URL for the photo bytes.
Parameters:
view
controls if the download URL for the photo bytes is returned.
Fields | |
---|---|
photo_ids[] |
Required. IDs of the |
view |
Required. Specifies if a download URL for the photo bytes should be returned in the Photo response. |
language_code |
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. |
BatchGetPhotosResponse
Response to batch get of Photos
.
Fields | |
---|---|
results[] |
List of results for each individual |
BatchUpdatePhotosRequest
Request to update the metadata of photos. Updating the pixels of photos is not supported.
Fields | |
---|---|
update_photo_requests[] |
Required. List of |
BatchUpdatePhotosResponse
Response to batch update of metadata of one or more Photos
.
Fields | |
---|---|
results[] |
List of results for each individual |
Connection
A connection is the link from a source photo to a destination photo.
Fields | |
---|---|
target |
Required. The destination of the connection from the containing photo to another photo. |
CreatePhotoRequest
Request to create a Photo
.
Fields | |
---|---|
photo |
Required. Photo to create. |
CreatePhotoSequenceRequest
Request to create a PhotoSequence
from a video.
Fields | |
---|---|
photo_sequence |
Required. |
input_type |
Required. The input form of |
InputType
Input forms of PhotoSequence
.
Enums | |
---|---|
INPUT_TYPE_UNSPECIFIED |
Not specified. Server will return google.rpc.Code.INVALID_ARGUMENT . |
VIDEO |
360 Video. |
XDM |
Extensible Device Metadata, http://www.xdm.org |
DeletePhotoRequest
Request to delete a Photo
.
Fields | |
---|---|
photo_id |
Required. ID of the |
DeletePhotoSequenceRequest
Request to delete a PhotoSequence
.
Fields | |
---|---|
sequence_id |
Required. ID of the |
GetPhotoRequest
Request to get a Photo
.
By default
- does not return the download URL for the photo bytes.
Parameters:
view
controls if the download URL for the photo bytes is returned.
Fields | |
---|---|
photo_id |
Required. ID of the |
view |
Required. Specifies if a download URL for the photo bytes should be returned in the |
language_code |
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. |
GetPhotoSequenceRequest
Request to get a PhotoSequence
.
By default
- does not return the download URL for the
PhotoSequence
.
Parameters:
view
controls if the download URL for thePhotoSequence
is returned.
Fields | |
---|---|
sequence_id |
Required. ID of the photo sequence. |
view |
Specifies if a download URL for the photo sequence should be returned in
|
filter |
Optional. The filter expression. For example: The filters supported are: |
GpsDataGapFailureDetails
Details related to ProcessingFailureReason#GPS_DATA_GAP. If there are multiple GPS data gaps, only the one with the largest duration is reported here.
Fields | |
---|---|
gap_duration |
The duration of the gap in GPS data that was found. |
gap_start_time |
Relative time (from the start of the video stream) when the gap started. |
Imu
IMU data from the device sensors.
Fields | |
---|---|
accel_mpsps[] |
The accelerometer measurements in meters/sec^2 with increasing timestamps from devices. |
gyro_rps[] |
The gyroscope measurements in radians/sec with increasing timestamps from devices. |
mag_ut[] |
The magnetometer measurements of the magnetic field in microtesla (uT) with increasing timestamps from devices. |
Measurement3d
A Generic 3d measurement sample.
Fields | |
---|---|
capture_time |
The timestamp of the IMU measurement. |
x |
The sensor measurement in the x axis. |
y |
The sensor measurement in the y axis. |
z |
The sensor measurement in the z axis. |
ImuDataGapFailureDetails
Details related to ProcessingFailureReason#IMU_DATA_GAP. If there are multiple IMU data gaps, only the one with the largest duration is reported here.
Fields | |
---|---|
gap_duration |
The duration of the gap in IMU data that was found. |
gap_start_time |
Relative time (from the start of the video stream) when the gap started. |
InsufficientGpsFailureDetails
Details related to ProcessingFailureReason#INSUFFICIENT_GPS.
Fields | |
---|---|
gps_points_found |
The number of GPS points that were found in the video. |
LatLngBounds
A rectangle in geographical coordinates.
Fields | |
---|---|
southwest |
The southwest corner of these bounds. |
northeast |
The northeast corner of these bounds. |
Level
Level information containing level number and its corresponding name.
Fields | |
---|---|
number |
Optional. Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK. |
name |
Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator. |
ListPhotoSequencesRequest
Request to list all photo sequences that belong to the user sending the request.
Parameters:
pageSize
determines the maximum number of photo sequences to return.pageToken
is the next page token value returned from a previousListPhotoSequences
request, if any.
Fields | |
---|---|
page_size |
Optional. The maximum number of photo sequences to return. |
page_token |
Optional. The |
filter |
Optional. The filter expression. For example: The filters supported are: |
ListPhotoSequencesResponse
Response to list all photo sequences that belong to a user.
Fields | |
---|---|
photo_sequences[] |
List of photo sequences via The maximum number of items returned is based on the Each item in the list can have three possible states,
|
next_page_token |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListPhotosRequest
Request to list all photos that belong to the user sending the request.
By default
- does not return the download URL for the photo bytes.
Parameters:
view
controls if the download URL for the photo bytes is returned.pageSize
determines the maximum number of photos to return.pageToken
is the next page token value returned from a previousListPhotos
request, if any.filter
allows filtering by a given parameter. 'placeId' is the only parameter supported at the moment.
Fields | |
---|---|
view |
Required. Specifies if a download URL for the photos bytes should be returned in the Photos response. |
page_size |
Optional. The maximum number of photos to return. |
page_token |
Optional. The |
filter |
Optional. The filter expression. For example: The filters supported are: |
language_code |
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. |
ListPhotosResponse
Response to list all photos that belong to a user.
Fields | |
---|---|
photos[] |
List of photos. The |
next_page_token |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
NoOverlapGpsFailureDetails
Details related to PhotoSequenceProcessingFailureReason#NO_OVERLAP_GPS.
Fields | |
---|---|
gps_start_time |
Time of first recorded GPS point. |
gps_end_time |
Time of last recorded GPS point. |
video_start_time |
Start time of video. |
video_end_time |
End time of video. |
NotOutdoorsFailureDetails
Details related to ProcessingFailureReason#NOT_OUTDOORS. If there are multiple indoor frames found, the first frame is recorded here.
Fields | |
---|---|
start_time |
Relative time (from the start of the video stream) when an indoor frame was found. |
Photo
Photo is used to store 360 photos along with photo metadata.
Fields | |
---|---|
photo_id |
Required. Output only. Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google. |
upload_reference |
Input only. Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to. |
download_url |
Output only. The download URL for the photo bytes. This field is set only when |
thumbnail_url |
Output only. The thumbnail URL for showing a preview of the given photo. |
share_link |
Output only. The share link for the photo. |
pose |
Optional. Pose of the photo. |
connections[] |
Optional. Connections to other photos. A connection represents the link from this photo to another photo. |
capture_time |
Optional. Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata. |
upload_time |
Output only. Time when the image was uploaded. |
places[] |
Optional. Places where this photo belongs. |
view_count |
Output only. View count of the photo. |
transfer_status |
Output only. Status of rights transfer on this photo. |
maps_publish_status |
Output only. Status in Google Maps, whether this photo was published or rejected. |
MapsPublishStatus
Publication status of the photo in Google Maps.
Enums | |
---|---|
UNSPECIFIED_MAPS_PUBLISH_STATUS |
The status of the photo is unknown. |
PUBLISHED |
The photo is published to the public through Google Maps. |
REJECTED_UNKNOWN |
The photo has been rejected for an unknown reason. |
TransferStatus
Status of rights transfer.
Enums | |
---|---|
TRANSFER_STATUS_UNKNOWN |
The status of this transfer is unspecified. |
NEVER_TRANSFERRED |
This photo has never been in a transfer. |
PENDING |
This photo transfer has been initiated, but the receiver has not yet responded. |
COMPLETED |
The photo transfer has been completed, and this photo has been transferred to the recipient. |
REJECTED |
The recipient rejected this photo transfer. |
EXPIRED |
The photo transfer expired before the recipient took any action. |
CANCELLED |
The sender cancelled this photo transfer. |
RECEIVED_VIA_TRANSFER |
The recipient owns this photo due to a rights transfer. |
PhotoId
Identifier for a Photo
.
Fields | |
---|---|
id |
A unique identifier for a photo. |
PhotoResponse
Response payload for a single Photo
in batch operations including BatchGetPhotos
and BatchUpdatePhotos
.
Fields | |
---|---|
status |
The status for the operation to get or update a single photo in the batch request. |
photo |
The |
PhotoSequence
A sequence of 360 photos along with metadata.
Fields | |
---|---|
id |
Output only. Unique identifier for the photo sequence. This also acts as a long running operation ID if uploading is performed asynchronously. |
photos[] |
Output only. Photos with increasing timestamps. |
upload_reference |
Input only. Required when creating photo sequence. The resource name where the bytes of the photo sequence (in the form of video) are uploaded. |
capture_time_override |
Optional. Absolute time when the photo sequence starts to be captured. If the photo sequence is a video, this is the start time of the video. If this field is populated in input, it overrides the capture time in the video or XDM file. |
upload_time |
Output only. The time this photo sequence was created in uSV Store service. |
raw_gps_timeline[] |
Input only. Raw GPS measurements with increasing timestamps from the device that aren't time synced with each photo. These raw measurements will be used to infer the pose of each frame. Required in input when InputType is VIDEO and raw GPS measurements are not in Camera Motion Metadata Track (CAMM). User can indicate which takes precedence using gps_source if raw GPS measurements are provided in both raw_gps_timeline and Camera Motion Metadata Track (CAMM). |
gps_source |
Input only. If both raw_gps_timeline and the Camera Motion Metadata Track (CAMM) contain GPS measurements, indicate which takes precedence. |
imu |
Input only. Three axis IMU data for the collection. If this data is too large to put in the request, then it should be put in the CAMM track for the video. This data always takes precedence over the equivalent CAMM data, if it exists. |
processing_state |
Output only. The processing state of this sequence. |
failure_reason |
Output only. If this sequence has processing_state = FAILED, this will contain the reason why it failed. If the processing_state is any other value, this field will be unset. |
failure_details |
Output only. If this sequence has |
distance_meters |
Output only. The computed distance of the photo sequence in meters. |
sequence_bounds |
Output only. A rectangular box that encapsulates every image in this photo sequence. |
view_count |
Output only. The total number of views that all the published images in this PhotoSequence have received. |
filename |
Output only. The filename of the upload. Does not include the directory path. Only available if the sequence was uploaded on a platform that provides the filename. |
GpsSource
Primary source of GPS measurements.
Enums | |
---|---|
PHOTO_SEQUENCE |
GPS in raw_gps_timeline takes precedence if it exists. |
CAMERA_MOTION_METADATA_TRACK |
GPS in Camera Motion Metadata Track (CAMM) takes precedence if it exists. |
PhotoView
Specifies which view of the Photo
to include in the response.
Enums | |
---|---|
BASIC |
Server responses do not include the download URL for the photo bytes. The default value. |
INCLUDE_DOWNLOAD_URL |
Server responses include the download URL for the photo bytes. |
Place
Place metadata for an entity.
Fields | |
---|---|
place_id |
Place identifier, as described in https://developers.google.com/places/place-id. |
name |
Output only. The name of the place, localized to the language_code. |
language_code |
Output only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback. |
Pose
Raw pose measurement for an entity.
Fields | |
---|---|
lat_lng_pair |
Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a |
altitude |
Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. |
heading |
The following pose parameters pertain to the center of the photo. They match https://developers.google.com/streetview/spherical-metadata. Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. |
pitch |
Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity. |
roll |
Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity. |
gps_record_timestamp_unix_epoch |
Time of the GPS record since UTC epoch. |
level |
Level (the floor in a building) used to configure vertical navigation. |
accuracy_meters |
The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. |
ProcessingFailureDetails
Additional details to accompany the ProcessingFailureReason enum. This message is always expected to be used in conjunction with ProcessingFailureReason, and the oneof value set in this message should match the FailureReason.
Fields | |
---|---|
Union field details . Only one set of details will be set, and must match the corresponding enum in ProcessingFailureReason. details can be only one of the following: |
|
insufficient_gps_details |
See InsufficientGpsFailureDetails. |
gps_data_gap_details |
See GpsDataGapFailureDetails. |
imu_data_gap_details |
See ImuDataGapFailureDetails. |
not_outdoors_details |
See NotOutdoorsFailureDetails. |
no_overlap_gps_details |
See NoOverlapGpsFailureDetails. |
ProcessingFailureReason
The possible reasons this PhotoSequence
failed to process.
Enums | |
---|---|
PROCESSING_FAILURE_REASON_UNSPECIFIED |
The failure reason is unspecified, this is the default value. |
LOW_RESOLUTION |
Video frame's resolution is too small. |
DUPLICATE |
This video has been uploaded before. |
INSUFFICIENT_GPS |
Too few GPS points. |
NO_OVERLAP_GPS |
No overlap between the time frame of GPS track and the time frame of video. |
INVALID_GPS |
GPS is invalid (e.x. all GPS points are at (0,0)) |
FAILED_TO_REFINE_POSITIONS |
The sequence of photos could not be accurately located in the world. |
TAKEDOWN |
The sequence was taken down for policy reasons. |
CORRUPT_VIDEO |
The video file was corrupt or could not be decoded. |
INTERNAL |
A permanent failure in the underlying system occurred. |
INVALID_VIDEO_FORMAT |
The video format is invalid or unsupported. |
INVALID_VIDEO_DIMENSIONS |
Invalid image aspect ratio found. |
INVALID_CAPTURE_TIME |
Invalid capture time. Timestamps were from the future. |
GPS_DATA_GAP |
GPS data contains a gap greater than 5 seconds in duration. |
JUMPY_GPS |
GPS data is too erratic to be processed. |
INVALID_IMU |
IMU (Accelerometer, Gyroscope, etc.) data are not valid. They may be missing required fields (x, y, z or time), may not be formatted correctly, or any other issue that prevents our systems from parsing it. |
INSUFFICIENT_IMU |
Too few IMU points. |
INSUFFICIENT_OVERLAP_TIME_SERIES |
Insufficient overlap in the time frame between GPS, IMU, and other time series data. |
IMU_DATA_GAP |
IMU (Accelerometer, Gyroscope, etc.) data contain gaps greater than 0.1 seconds in duration. |
UNSUPPORTED_CAMERA |
The camera is not supported. |
NOT_OUTDOORS |
Some frames were indoors, which is unsupported. |
INSUFFICIENT_VIDEO_FRAMES |
Not enough video frames. |
INSUFFICIENT_MOVEMENT |
Not enough moving data. |
ProcessingState
The processing state of the sequence. The states move as follows:
+-------------------------+
| |
+---v---+ +----------+ +----+----+
|PENDING+-->PROCESSING+-->PROCESSED|
+---+---+ +----+-----+ +----+----+
| | |
| +--v---+ |
+-------->FAILED<---------+
+------+
The sequence may move to FAILED from any state. Additionally, a processed sequence may be re-processed at any time.
Enums | |
---|---|
PROCESSING_STATE_UNSPECIFIED |
The state is unspecified, this is the default value. |
PENDING |
The sequence has not yet started processing. |
PROCESSING |
The sequence is currently in processing. |
PROCESSED |
The sequence has finished processing including refining position. |
FAILED |
The sequence failed processing. See FailureReason for more details. |
UpdatePhotoRequest
Request to update the metadata of a Photo
. Updating the pixels of a photo is not supported.
Fields | |
---|---|
photo |
Required. |
update_mask |
Required. Mask that identifies fields on the photo metadata to update. If not present, the old The following fields are valid:
|
UploadRef
Upload reference for media files.
Fields | |
---|---|
Union field file_source . Required. file_source can be only one of the following: |
|
upload_url |
An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}" |