package google.streetview.publish.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Publishes and connects user-contributed photos on Street View.
Deletes a list of photos and their metadata. Note that if `photos.batchDelete` fails, either critical fields are missing or there was an authentication error. Even if `photos.batchDelete` succeeds, there may have been failures for single photos in the batch. These failures will be specified in `BatchDeletePhotosResponse.status`. See `photo.update` for specific failures that will occur per photo.
message
rpcmessages.proto:180Request to delete multiple photos.
repeated string photo_ids = 1
Required. List of delete photo requests.
message
rpcmessages.proto:186Response to batch delete of one or more photos.
repeated status = 1
The status for the operation to delete a single photo in the batch request.
Gets the metadata of the specified `Photo` batch. Note that if `photos.batchGet` fails, either critical fields are missing or there was an authentication error. Even if `photos.batchGet` succeeds, there may have been failures for single photos in the batch. These failures will be specified in `BatchGetPhotosResponse.results.status`. See `photo.get` for specific failures that will occur per photo.
message
rpcmessages.proto:56Request 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 will be returned.
repeated string photo_ids = 1
Required. IDs of the photos.
PhotoView view = 2
Specifies if a download URL for the photo bytes should be returned in the Photo response.
message
rpcmessages.proto:66Response to batch get of photos.
repeated results = 1
List of results for each individual photo requested, in the same order as the request.
Updates the metadata of photos, such as pose, place association, etc. Changing the pixels of a photo is not supported. Note that if `photos.batchUpdate` fails, either critical fields are missing or there was an authentication error. Even if `photos.batchUpdate` succeeds, there may have been failures for single photos in the batch. These failures will be specified in `BatchUpdatePhotosResponse.results.status`. See `UpdatePhoto` for specific failures that will occur per photo.
message
rpcmessages.proto:161Request to update the metadata of photos. Updating the pixels of photos is not supported.
repeated update_photo_requests = 1
Required. List of update photo requests.
message
rpcmessages.proto:167Response to batch update of metadata of one or more photos.
repeated results = 1
List of results for each individual photo updated, in the same order as the request.
After the client finishes uploading the photo with the returned `UploadRef`, `photo.create` publishes the uploaded photo to Street View on Google Maps. This method returns the following error codes: * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the upload reference does not exist.
message
rpcmessages.proto:29Request to create a photo.
optional photo = 1
Required. Photo to create.
Deletes a photo and its metadata. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user did not create the requested photo. * `NOT_FOUND` if the photo ID does not exist.
message
rpcmessages.proto:174Request to delete a photo.
string photo_id = 1
Required. ID of the photo.
rpc GetPhoto (, )
streetview_publish.proto:63Gets the metadata of the specified `Photo`. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user did not create the requested photo. * `NOT_FOUND` if the requested photo does not exist.
message
rpcmessages.proto:41Request 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 will be returned.
string photo_id = 1
Required. ID of the photo.
PhotoView view = 2
Specifies if a download URL for the photo bytes should be returned in the Photo response.
Lists all the photos that belong to the user.
message
rpcmessages.proto:93Request 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 will be returned. - 'page_size' determines the maximum number of photos to return. - 'page_token' is the next page token value returned from a previous List request, if any.
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. `page_size` must be non-negative. If `page_size` is zero or is not provided, the default page size of 100 will be used. The number of photos returned in the response may be less than `page_size` if the number of photos that belong to the user is less than `page_size`.
string page_token = 3
The next_page_token value returned from a previous List request, if any.
string filter = 4
The filter expression. Example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`
message
rpcmessages.proto:114Response to list all photos that belong to a user.
repeated photos = 1
List of photos. There will be a maximum number of items returned based on the page_size field in the request.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Creates an upload session to start uploading photo data. The upload URL of the returned `UploadRef` is used to upload the data for the photo. After the upload is complete, the `UploadRef` is used with `StreetViewPublishService:CreatePhoto()` to create the `Photo` object entry.
Updates the metadata of a photo, such as pose, place association, etc. Changing the pixels of a photo is not supported. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user did not create the requested photo. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the photo ID does not exist.
message
resources.proto:100A 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:43Level 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:107Photo 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
Output only. Identifier for the photo, which is unique among all photos in Google.
optional upload_reference = 2
Required (when creating 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 the `view` parameter in a `GetPhotoRequest` is set to `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.
message
resources.proto:37Identifier for a photo.
Used in: ,
string id = 1
Required. A base64 encoded identifier.
message
rpcmessages.proto:74Response payload for a single `Photo` in batch operations including `BatchGetPhotosRequest` and `BatchUpdatePhotosRequest`.
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 resource, if the request was successful.
Specifies which view of the `Photo` should be included 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:93Place metadata for an entity.
Used in:
string place_id = 1
Required. Place identifier, as described in https://developers.google.com/places/place-id.
message
resources.proto:56Raw 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, if the latitude and longitude pair are not provided here, the geolocation from the exif header will be used. If the latitude and longitude pair is not provided and cannot be found in the exif header, the create photo process will fail.
double altitude = 2
Altitude of the pose in meters above ground level (as defined by WGS84). 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.
message
rpcmessages.proto:126Request to update the metadata of a 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 object containing the new metadata. Only the fields specified in `update_mask` are used. If `update_mask` is not present, the update applies to all fields. **Note:** To update `pose.altitude`, `pose.latlngpair` has to be filled as well. Otherwise, the request will fail.
optional update_mask = 2
Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata will be entirely replaced with the new 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` **Note:** Repeated fields in `update_mask` mean the entire set of repeated values will be replaced with the new contents. For example, if `UpdatePhotoRequest.photo.update_mask` contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections will be removed.
message
resources.proto:29Upload 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>"