Method: photo.update

  • Updates a Photo's metadata, such as pose, connections, and places, but not the image pixels themselves.

  • Uses an updateMask to specify which fields to update; if omitted, all fields are updated.

  • Requires the https://www.googleapis.com/auth/streetviewpublish OAuth scope for authorization.

  • Returns the updated Photo object if successful.

  • May return errors if permissions are lacking, the request is invalid, the Photo doesn't exist, or is still being indexed.

Updates the metadata of a Photo, such as pose, place association, connections, etc. Changing the pixels of a photo is not supported.

Only the fields specified in the updateMask field are used. If updateMask is not present, the update applies to all fields.

This method returns the following error codes:

HTTP request

PUT https://streetviewpublish.googleapis.com/v1/photo/{photo.photoId.id}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
photo.photoId.id

string

A unique identifier for a photo.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is 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.lat_lng_pair
  • pose.pitch
  • pose.roll
  • pose.level
  • pose.altitude
  • connections
  • places

Note: When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains connections and UpdatePhotoRequest.photo.connections is empty, all connections are removed.

Request body

The request body contains an instance of Photo.

Response body

If successful, the response body contains an instance of Photo.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/streetviewpublish

For more information, see the OAuth 2.0 Overview.