Google Git
Sign in
android / platform / external / python / google-api-python-client / refs/heads/android12-d1-s6-release / . / docs / dyn / streetviewpublish_v1.photo.html
blob: 86076c4d5674878c09a0bc5d2a15d72e3a5581cb [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="streetviewpublish_v1.html">Street View Publish API</a> . <a href="streetviewpublish_v1.photo.html">photo</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
<p class="firstline">After the client finishes uploading the photo with the returned</p>
<p class="toc_element">
<code><a href="#delete">delete(photoId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Photo and its metadata.</p>
<p class="toc_element">
<code><a href="#get">get(photoId, languageCode=None, x__xgafv=None, view=None)</a></code></p>
<p class="firstline">Gets the metadata of the specified</p>
<p class="toc_element">
<code><a href="#startUpload">startUpload(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an upload session to start uploading photo bytes. The method uses</p>
<p class="toc_element">
<code><a href="#update">update(id, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the metadata of a Photo, such</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
<pre>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](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 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.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # Photo is used to store 360 photos along with photo metadata.
"viewCount": "A String", # Output only. View count of the photo.
"photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
# Identifier for the photo, which is unique among all photos in
# Google.
"id": "A String", # Required. A unique identifier for a photo.
},
"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
# photo bytes are uploaded to.
"uploadUrl": "A String", # 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}"
},
"places": [ # Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # 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.
"name": "A String", # Output-only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in
# https://developers.google.com/places/place-id.
},
],
"connections": [ # Connections to other photos. A connection represents the link from this
# photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
# another photo.
"id": "A String", # Required. A unique identifier for a photo.
},
},
],
"pose": { # Raw pose measurement for an entity. # Pose of the photo.
"latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a 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 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 photo process to fail.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"number": 3.14, # 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": "A String", # 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.
},
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
# NaN indicates an unmeasured quantity.
"heading": 3.14, # 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": 3.14, # 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": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0
# means level with the horizon.
# NaN indicates an unmeasured quantity.
"accuracyMeters": 3.14, # 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.
},
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
# when
# GetPhotoRequest.view
# is set to
# PhotoView.INCLUDE_DOWNLOAD_URL.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
# rejected.
"captureTime": "A String", # 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.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"shareLink": "A String", # Output only. The share link for the photo.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Photo is used to store 360 photos along with photo metadata.
"viewCount": "A String", # Output only. View count of the photo.
"photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
# Identifier for the photo, which is unique among all photos in
# Google.
"id": "A String", # Required. A unique identifier for a photo.
},
"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
# photo bytes are uploaded to.
"uploadUrl": "A String", # 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}"
},
"places": [ # Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # 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.
"name": "A String", # Output-only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in
# https://developers.google.com/places/place-id.
},
],
"connections": [ # Connections to other photos. A connection represents the link from this
# photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
# another photo.
"id": "A String", # Required. A unique identifier for a photo.
},
},
],
"pose": { # Raw pose measurement for an entity. # Pose of the photo.
"latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a 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 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 photo process to fail.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"number": 3.14, # 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": "A String", # 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.
},
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
# NaN indicates an unmeasured quantity.
"heading": 3.14, # 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": 3.14, # 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": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0
# means level with the horizon.
# NaN indicates an unmeasured quantity.
"accuracyMeters": 3.14, # 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.
},
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
# when
# GetPhotoRequest.view
# is set to
# PhotoView.INCLUDE_DOWNLOAD_URL.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
# rejected.
"captureTime": "A String", # 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.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"shareLink": "A String", # Output only. The share link for the photo.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(photoId, x__xgafv=None)</code>
<pre>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.
Args:
photoId: string, Required. ID of the Photo. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(photoId, languageCode=None, x__xgafv=None, view=None)</code>
<pre>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.
Args:
photoId: string, Required. ID of the Photo. (required)
languageCode: string, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
view: string, Specifies if a download URL for the photo bytes should be returned in the
Photo response.
Returns:
An object of the form:
{ # Photo is used to store 360 photos along with photo metadata.
"viewCount": "A String", # Output only. View count of the photo.
"photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
# Identifier for the photo, which is unique among all photos in
# Google.
"id": "A String", # Required. A unique identifier for a photo.
},
"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
# photo bytes are uploaded to.
"uploadUrl": "A String", # 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}"
},
"places": [ # Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # 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.
"name": "A String", # Output-only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in
# https://developers.google.com/places/place-id.
},
],
"connections": [ # Connections to other photos. A connection represents the link from this
# photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
# another photo.
"id": "A String", # Required. A unique identifier for a photo.
},
},
],
"pose": { # Raw pose measurement for an entity. # Pose of the photo.
"latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a 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 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 photo process to fail.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"number": 3.14, # 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": "A String", # 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.
},
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
# NaN indicates an unmeasured quantity.
"heading": 3.14, # 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": 3.14, # 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": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0
# means level with the horizon.
# NaN indicates an unmeasured quantity.
"accuracyMeters": 3.14, # 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.
},
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
# when
# GetPhotoRequest.view
# is set to
# PhotoView.INCLUDE_DOWNLOAD_URL.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
# rejected.
"captureTime": "A String", # 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.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"shareLink": "A String", # Output only. The share link for the photo.
}</pre>
</div>
<div class="method">
<code class="details" id="startUpload">startUpload(body=None, x__xgafv=None)</code>
<pre>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?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 with
CreatePhoto
to create the Photo object entry.
Args:
body: object, The request body.
The object takes the form of:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Upload reference for media files.
"uploadUrl": "A String", # 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}"
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(id, body, updateMask=None, x__xgafv=None)</code>
<pre>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.
Args:
id: string, Required. A unique identifier for a photo. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Photo is used to store 360 photos along with photo metadata.
"viewCount": "A String", # Output only. View count of the photo.
"photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
# Identifier for the photo, which is unique among all photos in
# Google.
"id": "A String", # Required. A unique identifier for a photo.
},
"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
# photo bytes are uploaded to.
"uploadUrl": "A String", # 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}"
},
"places": [ # Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # 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.
"name": "A String", # Output-only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in
# https://developers.google.com/places/place-id.
},
],
"connections": [ # Connections to other photos. A connection represents the link from this
# photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
# another photo.
"id": "A String", # Required. A unique identifier for a photo.
},
},
],
"pose": { # Raw pose measurement for an entity. # Pose of the photo.
"latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a 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 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 photo process to fail.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"number": 3.14, # 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": "A String", # 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.
},
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
# NaN indicates an unmeasured quantity.
"heading": 3.14, # 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": 3.14, # 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": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0
# means level with the horizon.
# NaN indicates an unmeasured quantity.
"accuracyMeters": 3.14, # 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.
},
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
# when
# GetPhotoRequest.view
# is set to
# PhotoView.INCLUDE_DOWNLOAD_URL.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
# rejected.
"captureTime": "A String", # 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.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"shareLink": "A String", # Output only. The share link for the photo.
}
updateMask: string, 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.latLngPair`
* `pose.pitch`
* `pose.roll`
* `pose.level`
* `pose.altitude`
* `connections`
* `places`
<aside class="note"><b>Note:</b> 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.</aside>
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Photo is used to store 360 photos along with photo metadata.
"viewCount": "A String", # Output only. View count of the photo.
"photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
# Identifier for the photo, which is unique among all photos in
# Google.
"id": "A String", # Required. A unique identifier for a photo.
},
"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
# photo bytes are uploaded to.
"uploadUrl": "A String", # 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}"
},
"places": [ # Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # 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.
"name": "A String", # Output-only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in
# https://developers.google.com/places/place-id.
},
],
"connections": [ # Connections to other photos. A connection represents the link from this
# photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
# another photo.
"id": "A String", # Required. A unique identifier for a photo.
},
},
],
"pose": { # Raw pose measurement for an entity. # Pose of the photo.
"latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a 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 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 photo process to fail.
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
# standard</a>. Values must be within normalized ranges.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"number": 3.14, # 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": "A String", # 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.
},
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
# NaN indicates an unmeasured quantity.
"heading": 3.14, # 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": 3.14, # 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": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0
# means level with the horizon.
# NaN indicates an unmeasured quantity.
"accuracyMeters": 3.14, # 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.
},
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
# when
# GetPhotoRequest.view
# is set to
# PhotoView.INCLUDE_DOWNLOAD_URL.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
# rejected.
"captureTime": "A String", # 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.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"shareLink": "A String", # Output only. The share link for the photo.
}</pre>
</div>
</body></html>