class Photo extends Resource (View source)

The "photo" collection of methods.

Typical usage is:

 $streetviewpublishService = new Google\Service\StreetViewPublish(...);
 $photo = $streetviewpublishService->photo;

Methods

create(Photo $postBody, array $optParams = [])

After the client finishes uploading the photo with the returned UploadRef, CreatePhoto publishes the uploaded Photo to Street View on Google Maps.

delete(string $photoId, array $optParams = [])

Deletes a Photo and its metadata. This method returns the following error codes: google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. google.rpc.Code.NOT_FOUND if the photo ID does not exist. (photo.delete)

get(string $photoId, array $optParams = [])

Gets the metadata of the specified Photo. This method returns the following error codes: google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested Photo. google.rpc.Code.NOT_FOUND if the requested Photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed. (photo.get)

startUpload(StreetviewpublishEmpty $postBody, array $optParams = [])

Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. 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: Photo Sphere XMP metadata must be included in the photo metadata. 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?ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry.

update(string $id, Photo $postBody, array $optParams = [])

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: google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. google.rpc.Code.INVALID_ARGUMENT if the request is malformed. google.rpc.Code.NOT_FOUND if the requested photo does not exist. google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed. (photo.update)

Details

Photo create(Photo $postBody, array $optParams = [])

After the client finishes uploading the photo with the returned UploadRef, CreatePhoto publishes the uploaded 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 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 if the request is malformed or if the uploaded photo is not a 360 photo. google.rpc.Code.NOT_FOUND if the upload reference does not exist. * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the storage limit. (photo.create)

Parameters

Photo $postBody
array $optParams

Optional parameters.

Return Value

Photo

Exceptions

Exception

StreetviewpublishEmpty delete(string $photoId, array $optParams = [])

Deletes a Photo and its metadata. This method returns the following error codes: google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. google.rpc.Code.NOT_FOUND if the photo ID does not exist. (photo.delete)

Parameters

string $photoId

Required. ID of the Photo.

array $optParams

Optional parameters.

Return Value

StreetviewpublishEmpty

Exceptions

Exception

Photo get(string $photoId, array $optParams = [])

Gets the metadata of the specified Photo. This method returns the following error codes: google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested Photo. google.rpc.Code.NOT_FOUND if the requested Photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed. (photo.get)

Parameters

string $photoId

Required. ID of the Photo.

array $optParams

Optional parameters.

Return Value

Photo

Exceptions

Exception

UploadRef startUpload(StreetviewpublishEmpty $postBody, array $optParams = [])

Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. 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: Photo Sphere XMP metadata must be included in the photo metadata. 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?ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry.

(photo.startUpload)

Parameters

StreetviewpublishEmpty $postBody
array $optParams

Optional parameters.

Return Value

UploadRef

Exceptions

Exception

Photo update(string $id, Photo $postBody, array $optParams = [])

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: google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. google.rpc.Code.INVALID_ARGUMENT if the request is malformed. google.rpc.Code.NOT_FOUND if the requested photo does not exist. google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed. (photo.update)

Parameters

string $id

A unique identifier for a photo.

Photo $postBody
array $optParams

Optional parameters.

Return Value

Photo

Exceptions

Exception