package google.streetview.publish.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Publishes and connects user-contributed photos on Street View.
Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned [UploadRef][google.streetview.publish.v1.UploadRef] to upload the bytes for the [Photo][google.streetview.publish.v1.Photo]. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo medadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses [UploadRef][google.streetview.publish.v1.UploadRef] with [CreatePhoto][google.streetview.publish.v1.StreetViewPublishService.CreatePhoto] to create the [Photo][google.streetview.publish.v1.Photo] object entry.
After the client finishes uploading the photo with the returned [UploadRef][google.streetview.publish.v1.UploadRef], [CreatePhoto][google.streetview.publish.v1.StreetViewPublishService.CreatePhoto] publishes the uploaded [Photo][google.streetview.publish.v1.Photo] to Street View on Google Maps. Currently, the only way to set heading, pitch, and roll in CreatePhoto is through the [Photo Sphere XMP metadata](https://developers.google.com/streetview/spherical-metadata) in the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`, `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose. This method returns the following error codes: * [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] if the request is malformed or if the uploaded photo is not a 360 photo. * [google.rpc.Code.NOT_FOUND][google.rpc.Code.NOT_FOUND] if the upload reference does not exist. * [google.rpc.Code.RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] if the account has reached the storage limit.
message
rpcmessages.proto:39Request to create a [Photo][google.streetview.publish.v1.Photo].
optional photo = 1
Required. Photo to create.
rpc GetPhoto (, )
streetview_publish.proto:99Gets the metadata of the specified [Photo][google.streetview.publish.v1.Photo]. This method returns the following error codes: * [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED] if the requesting user did not create the requested [Photo][google.streetview.publish.v1.Photo]. * [google.rpc.Code.NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested [Photo][google.streetview.publish.v1.Photo] does not exist. * [google.rpc.Code.UNAVAILABLE][google.rpc.Code.UNAVAILABLE] if the requested [Photo][google.streetview.publish.v1.Photo] is still being indexed.
message
rpcmessages.proto:53Request to get a [Photo][google.streetview.publish.v1.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.
string photo_id = 1
Required. ID of the [Photo][google.streetview.publish.v1.Photo].
PhotoView view = 2
Specifies if a download URL for the photo bytes should be returned in the [Photo][google.streetview.publish.v1.Photo] response.
string language_code = 3
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.
Gets the metadata of the specified [Photo][google.streetview.publish.v1.Photo] batch. Note that if [BatchGetPhotos][google.streetview.publish.v1.StreetViewPublishService.BatchGetPhotos] fails, either critical fields are missing or there is an authentication error. Even if [BatchGetPhotos][google.streetview.publish.v1.StreetViewPublishService.BatchGetPhotos] succeeds, individual photos in the batch may have failures. These failures are specified in each [PhotoResponse.status][google.streetview.publish.v1.PhotoResponse.status] in [BatchGetPhotosResponse.results][google.streetview.publish.v1.BatchGetPhotosResponse.results]. See [GetPhoto][google.streetview.publish.v1.StreetViewPublishService.GetPhoto] for specific failures that can occur per photo.
message
rpcmessages.proto:77Request to get one or more [Photos][google.streetview.publish.v1.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.
repeated string photo_ids = 1
Required. IDs of the [Photos][google.streetview.publish.v1.Photo]. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=<id1>&photoIds=<id2>&...`.
PhotoView view = 2
Specifies if a download URL for the photo bytes should be returned in the Photo response.
string language_code = 3
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.
message
rpcmessages.proto:96Response to batch get of [Photos][google.streetview.publish.v1.Photo].
repeated results = 1
List of results for each individual [Photo][google.streetview.publish.v1.Photo] requested, in the same order as the requests in [BatchGetPhotos][google.streetview.publish.v1.StreetViewPublishService.BatchGetPhotos].
Lists all the [Photos][google.streetview.publish.v1.Photo] that belong to the user. <aside class="note"><b>Note:</b> Recently created photos that are still being indexed are not returned in the response.</aside>
message
rpcmessages.proto:135Request 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 previous [ListPhotos][google.streetview.publish.v1.StreetViewPublishService.ListPhotos] request, if any. * `filter` allows filtering by a given parameter. 'placeId' is the only parameter supported at the moment.
PhotoView view = 1
Specifies if a download URL for the photos bytes should be returned in the Photos response.
int32 page_size = 2
The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 is used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`.
string page_token = 3
The [nextPageToken][google.streetview.publish.v1.ListPhotosResponse.next_page_token] value returned from a previous [ListPhotos][google.streetview.publish.v1.StreetViewPublishService.ListPhotos] request, if any.
string filter = 4
The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`.
string language_code = 5
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.
message
rpcmessages.proto:168Response to list all photos that belong to a user.
repeated photos = 1
List of photos. The [pageSize][google.streetview.publish.v1.ListPhotosRequest.page_size] field in the request determines the number of items returned.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Updates the metadata of a [Photo][google.streetview.publish.v1.Photo], such as pose, place association, connections, etc. Changing the pixels of a photo is not supported. Only the fields specified in the [updateMask][google.streetview.publish.v1.UpdatePhotoRequest.update_mask] field are used. If `updateMask` is not present, the update applies to all fields. This method returns the following error codes: * [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED] if the requesting user did not create the requested photo. * [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] if the request is malformed. * [google.rpc.Code.NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested photo does not exist. * [google.rpc.Code.UNAVAILABLE][google.rpc.Code.UNAVAILABLE] if the requested [Photo][google.streetview.publish.v1.Photo] is still being indexed.
Updates the metadata of [Photos][google.streetview.publish.v1.Photo], such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if [BatchUpdatePhotos][google.streetview.publish.v1.StreetViewPublishService.BatchUpdatePhotos] fails, either critical fields are missing or there is an authentication error. Even if [BatchUpdatePhotos][google.streetview.publish.v1.StreetViewPublishService.BatchUpdatePhotos] succeeds, individual photos in the batch may have failures. These failures are specified in each [PhotoResponse.status][google.streetview.publish.v1.PhotoResponse.status] in [BatchUpdatePhotosResponse.results][google.streetview.publish.v1.BatchUpdatePhotosResponse.results]. See [UpdatePhoto][google.streetview.publish.v1.StreetViewPublishService.UpdatePhoto] for specific failures that can occur per photo. Only the fields specified in [updateMask][google.streetview.publish.v1.UpdatePhotoRequest.update_mask] field are used. If `updateMask` is not present, the update applies to all fields. The number of [UpdatePhotoRequest][google.streetview.publish.v1.UpdatePhotoRequest] messages in a [BatchUpdatePhotosRequest][google.streetview.publish.v1.BatchUpdatePhotosRequest] must not exceed 20. <aside class="note"><b>Note:</b> To update [Pose.altitude][google.streetview.publish.v1.Pose.altitude], [Pose.latLngPair][google.streetview.publish.v1.Pose.lat_lng_pair] has to be filled as well. Otherwise, the request will fail.</aside>
message
rpcmessages.proto:218Request to update the metadata of photos. Updating the pixels of photos is not supported.
repeated update_photo_requests = 1
Required. List of [UpdatePhotoRequests][google.streetview.publish.v1.UpdatePhotoRequest].
message
rpcmessages.proto:226Response to batch update of metadata of one or more [Photos][google.streetview.publish.v1.Photo].
repeated results = 1
List of results for each individual [Photo][google.streetview.publish.v1.Photo] updated, in the same order as the request.
Deletes a [Photo][google.streetview.publish.v1.Photo] and its metadata. This method returns the following error codes: * [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED] if the requesting user did not create the requested photo. * [google.rpc.Code.NOT_FOUND][google.rpc.Code.NOT_FOUND] if the photo ID does not exist.
message
rpcmessages.proto:234Request to delete a [Photo][google.streetview.publish.v1.Photo].
string photo_id = 1
Required. ID of the [Photo][google.streetview.publish.v1.Photo].
Deletes a list of [Photos][google.streetview.publish.v1.Photo] and their metadata. Note that if [BatchDeletePhotos][google.streetview.publish.v1.StreetViewPublishService.BatchDeletePhotos] fails, either critical fields are missing or there was an authentication error. Even if [BatchDeletePhotos][google.streetview.publish.v1.StreetViewPublishService.BatchDeletePhotos] succeeds, individual photos in the batch may have failures. These failures are specified in each [PhotoResponse.status][google.streetview.publish.v1.PhotoResponse.status] in [BatchDeletePhotosResponse.results][google.streetview.publish.v1.BatchDeletePhotosResponse.status]. See [DeletePhoto][google.streetview.publish.v1.StreetViewPublishService.DeletePhoto] for specific failures that can occur per photo.
message
rpcmessages.proto:240Request to delete multiple [Photos][google.streetview.publish.v1.Photo].
repeated string photo_ids = 1
Required. IDs of the [Photos][google.streetview.publish.v1.Photo]. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=<id1>&photoIds=<id2>&...`.
message
rpcmessages.proto:249Response to batch delete of one or more [Photos][google.streetview.publish.v1.Photo].
repeated status = 1
The status for the operation to delete a single [Photo][google.streetview.publish.v1.Photo] in the batch request.
message
resources.proto:111A connection is the link from a source photo to a destination photo.
Used in:
optional target = 1
Required. The destination of the connection from the containing photo to another photo.
message
resources.proto:42Level information containing level number and its corresponding name.
Used in:
double number = 1
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.
string name = 2
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.
message
resources.proto:118Photo is used to store 360 photos along with photo metadata.
Used as response type in: StreetViewPublishService.CreatePhoto, StreetViewPublishService.GetPhoto, StreetViewPublishService.UpdatePhoto
Used as field type in: , , ,
optional photo_id = 1
Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
optional upload_reference = 2
Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
string download_url = 3
Output only. The download URL for the photo bytes. This field is set only when [GetPhotoRequest.view][google.streetview.publish.v1.GetPhotoRequest.view] is set to [PhotoView.INCLUDE_DOWNLOAD_URL][google.streetview.publish.v1.PhotoView.INCLUDE_DOWNLOAD_URL].
string thumbnail_url = 9
Output only. The thumbnail URL for showing a preview of the given photo.
string share_link = 11
Output only. The share link for the photo.
optional pose = 4
Pose of the photo.
repeated connections = 5
Connections to other photos. A connection represents the link from this photo to another photo.
optional capture_time = 6
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.
repeated places = 7
Places where this photo belongs.
int64 view_count = 10
Output only. View count of the photo.
Photo.TransferStatus transfer_status = 12
Output only. Status of rights transfer on this photo.
Photo.MapsPublishStatus maps_publish_status = 13
Output only. Status in Google Maps, whether this photo was published or rejected.
Publication status of the photo in Google Maps.
Used in:
UNSPECIFIED_MAPS_PUBLISH_STATUS = 0
The status of the photo is unknown.
PUBLISHED = 1
The photo is published to the public through Google Maps.
REJECTED_UNKNOWN = 2
The photo has been rejected for an unknown reason.
Status of rights transfer.
Used in:
TRANSFER_STATUS_UNKNOWN = 0
The status of this transfer is unspecified.
NEVER_TRANSFERRED = 1
This photo has never been in a transfer.
PENDING = 2
This photo transfer has been initiated, but the receiver has not yet responded.
COMPLETED = 3
The photo transfer has been completed, and this photo has been transferred to the recipient.
REJECTED = 4
The recipient rejected this photo transfer.
EXPIRED = 5
The photo transfer expired before the recipient took any action.
CANCELLED = 6
The sender cancelled this photo transfer.
RECEIVED_VIA_TRANSFER = 7
The recipient owns this photo due to a rights transfer.
message
resources.proto:36Identifier for a [Photo][google.streetview.publish.v1.Photo].
Used in: ,
string id = 1
Required. A unique identifier for a photo.
message
rpcmessages.proto:110Response payload for a single [Photo][google.streetview.publish.v1.Photo] in batch operations including [BatchGetPhotos][google.streetview.publish.v1.StreetViewPublishService.BatchGetPhotos] and [BatchUpdatePhotos][google.streetview.publish.v1.StreetViewPublishService.BatchUpdatePhotos].
Used in: ,
optional status = 1
The status for the operation to get or update a single photo in the batch request.
optional photo = 2
The [Photo][google.streetview.publish.v1.Photo] resource, if the request was successful.
Specifies which view of the [Photo][google.streetview.publish.v1.Photo] to include in the response.
Used in: , ,
BASIC = 0
Server reponses do not include the download URL for the photo bytes. The default value.
INCLUDE_DOWNLOAD_URL = 1
Server responses include the download URL for the photo bytes.
message
resources.proto:97Place metadata for an entity.
Used in:
string place_id = 1
Place identifier, as described in https://developers.google.com/places/place-id.
string name = 2
Output-only. The name of the place, localized to the language_code.
string language_code = 3
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.
message
resources.proto:55Raw pose measurement for an entity.
Used in:
optional lat_lng_pair = 1
Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a [Photo][google.streetview.publish.v1.Photo], if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the create photo process to fail.
double altitude = 2
Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
double heading = 3
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.
double pitch = 4
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.
double roll = 5
Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
optional level = 7
Level (the floor in a building) used to configure vertical navigation.
float accuracy_meters = 9
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.
message
rpcmessages.proto:182Request to update the metadata of a [Photo][google.streetview.publish.v1.Photo]. Updating the pixels of a photo is not supported.
Used as request type in: StreetViewPublishService.UpdatePhoto
Used as field type in:
optional photo = 1
Required. [Photo][google.streetview.publish.v1.Photo] object containing the new metadata.
optional update_mask = 2
Mask that identifies fields on the photo metadata to update. If not present, the old [Photo][google.streetview.publish.v1.Photo] metadata is entirely replaced with the new [Photo][google.streetview.publish.v1.Photo] metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` <aside class="note"><b>Note:</b> When [updateMask][google.streetview.publish.v1.UpdatePhotoRequest.update_mask] contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if [updateMask][google.streetview.publish.v1.UpdatePhotoRequest.update_mask] contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.</aside>
message
resources.proto:28Upload reference for media files.
Used as response type in: StreetViewPublishService.StartUpload
Used as field type in:
string upload_url = 1
Required. An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"