Index
StreetViewPublishService
(interface)BatchDeletePhotosRequest
(message)BatchDeletePhotosResponse
(message)BatchGetPhotosRequest
(message)BatchGetPhotosResponse
(message)BatchUpdatePhotosRequest
(message)BatchUpdatePhotosResponse
(message)Connection
(message)CreatePhotoRequest
(message)DeletePhotoRequest
(message)GetPhotoRequest
(message)Level
(message)ListPhotosRequest
(message)ListPhotosResponse
(message)Photo
(message)Photo.MapsPublishStatus
(enum)Photo.TransferStatus
(enum)PhotoId
(message)PhotoResponse
(message)PhotoView
(enum)Place
(message)Pose
(message)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:
|
DeletePhoto | |
---|---|
Deletes a This method returns the following error codes:
|
GetPhoto | |
---|---|
Gets the metadata of the specified This method returns the following error codes:
|
ListPhotos | |
---|---|
Lists all 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 |
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. |
DeletePhotoRequest
Request to delete a Photo
.
Fields | |
---|---|
photo_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. |
Level
Level information containing level number and its corresponding name.
Fields | |
---|---|
number |
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. |
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 |
The maximum number of photos to return. |
page_token |
The |
filter |
Required. The filter expression. For example: The only filter supported at the moment is |
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. |
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. |
Photo
Photo is used to store 360 photos along with photo metadata.
Fields | |
---|---|
photo_id |
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 |
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 |
Pose of the photo. |
connections[] |
Connections to other photos. A connection represents the link from this photo to another photo. |
capture_time |
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. |
places[] |
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. Not currently populated. |
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 |
Required. 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 |
PhotoView
Specifies which view of the Photo
to include in the response.
Enums | |
---|---|
BASIC |
Server reponses 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 |
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. |
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. |
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 | |
---|---|
upload_url |
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}" |