Blame - docs/dyn/streetviewpublish_v1.photos.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

80

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

81

<code><a href="#batchGet">batchGet(languageCode=None, photoIds=None, view=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

83

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

84

<code><a href="#batchUpdate">batchUpdate(body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<p class="firstline">Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. *Note:* To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

87

<code><a href="#close">close()</a></code></p>

88

<p class="firstline">Close httplib2 connections.</p>

89

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

90

<code><a href="#list">list(filter=None, languageCode=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<p class="firstline">Lists all the Photos that belong to the user. *Note:* Recently created photos that are still being indexed are not returned in the response.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

<h3>Method Details</h3>

96

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

97

<code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

98

<pre>Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

99

100

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

101

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

102

The object takes the form of:

103

104

{ # Request to delete multiple Photos.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

105

"photoIds": [ # Required. IDs of the Photos. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=&photoIds=&...`.

106

"A String",

107

],

108

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

110

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

117

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

118

{ # Response to batch delete of one or more Photos.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

119

"status": [ # The status for the operation to delete a single Photo in the batch request.

120

{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

121

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

122

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

123

{

124

"a_key": "", # Properties of the object. Contains field @type with type URL.

125

},

126

],

127

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

128

},

129

],

130

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

134

<code class="details" id="batchGet">batchGet(languageCode=None, photoIds=None, view=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

135

<pre>Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

136

137

Args:

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

138

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

139

photoIds: string, Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`. (repeated)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

140

view: string, Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.

141

Allowed values

142

BASIC - Server reponses do not include the download URL for the photo bytes. The default value.

143

INCLUDE_DOWNLOAD_URL - Server responses include the download URL for the photo bytes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

144

x__xgafv: string, V1 error format.

145

Allowed values

146

1 - v1 error format

147

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

148

149

Returns:

150

An object of the form:

151

152

{ # Response to batch get of Photos.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

153

"results": [ # List of results for each individual Photo requested, in the same order as the requests in BatchGetPhotos.

154

{ # Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.

155

"photo": { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request was successful.

156

"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.

157

"connections": [ # Connections to other photos. A connection represents the link from this photo to another photo.

158

{ # A connection is the link from a source photo to a destination photo.

159

"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

160

"id": "A String", # Required. A unique identifier for a photo.

161

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

162

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

163

],

164

"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.

165

"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.

166

"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.

167

"id": "A String", # Required. A unique identifier for a photo.

168

},

169

"places": [ # Places where this photo belongs.

170

{ # Place metadata for an entity.

171

"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.

172

"name": "A String", # Output-only. The name of the place, localized to the language_code.

173

"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.

174

},

175

],

176

"pose": { # Raw pose measurement for an entity. # Pose of the photo.

177

"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.

178

"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.

179

"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.

180

"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # 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.

181

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

182

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

183

},

184

"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.

185

"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.

186

"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.

187

},

188

"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.

189

"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.

190

},

191

"shareLink": "A String", # Output only. The share link for the photo.

192

"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.

193

"transferStatus": "A String", # Output only. Status of rights transfer on this photo.

194

"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

195

"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

196

},

197

"viewCount": "A String", # Output only. View count of the photo.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

198

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

199

"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status for the operation to get or update a single photo in the batch request.

200

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

201

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

202

{

203

"a_key": "", # Properties of the object. Contains field @type with type URL.

204

},

205

],

206

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

},

},

],

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

214

<code class="details" id="batchUpdate">batchUpdate(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

215

<pre>Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. *Note:* To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

216

217

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

218

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

219

The object takes the form of:

220

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

221

{ # Request to update the metadata of photos. Updating the pixels of photos is not supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

222

"updatePhotoRequests": [ # Required. List of UpdatePhotoRequests.

223

{ # Request to update the metadata of a Photo. Updating the pixels of a photo is not supported.

224

"photo": { # Photo is used to store 360 photos along with photo metadata. # Required. Photo object containing the new metadata.

225

"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.

226

"connections": [ # Connections to other photos. A connection represents the link from this photo to another photo.

227

{ # A connection is the link from a source photo to a destination photo.

228

"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

229

"id": "A String", # Required. A unique identifier for a photo.

230

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

231

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

232

],

233

"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.

234

"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.

235

"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.

236

"id": "A String", # Required. A unique identifier for a photo.

237

},

238

"places": [ # Places where this photo belongs.

239

{ # Place metadata for an entity.

240

"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.

241

"name": "A String", # Output-only. The name of the place, localized to the language_code.

242

"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.

243

},

244

],

245

"pose": { # Raw pose measurement for an entity. # Pose of the photo.

246

"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.

247

"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.

248

"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.

249

"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # 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.

250

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

251

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

252

},

253

"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.

254

"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.

255

"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.

256

},

257

"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.

258

"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.

259

},

260

"shareLink": "A String", # Output only. The share link for the photo.

261

"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.

262

"transferStatus": "A String", # Output only. Status of rights transfer on this photo.

263

"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

264

"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

265

},

266

"viewCount": "A String", # Output only. View count of the photo.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

267

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

268

"updateMask": "A String", # 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.latLngPair` * `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.

269

},

270

],

271

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

272

273

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

280

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

281

{ # Response to batch update of metadata of one or more Photos.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

282

"results": [ # List of results for each individual Photo updated, in the same order as the request.

283

{ # Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.

284

"photo": { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request was successful.

285

"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.

286

"connections": [ # Connections to other photos. A connection represents the link from this photo to another photo.

287

{ # A connection is the link from a source photo to a destination photo.

288

"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

289

"id": "A String", # Required. A unique identifier for a photo.

290

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

291

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

292

],

293

"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.

294

"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.

295

"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.

296

"id": "A String", # Required. A unique identifier for a photo.

297

},

298

"places": [ # Places where this photo belongs.

299

{ # Place metadata for an entity.

300

"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.

301

"name": "A String", # Output-only. The name of the place, localized to the language_code.

302

"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.

303

},

304

],

305

"pose": { # Raw pose measurement for an entity. # Pose of the photo.

306

"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.

307

"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.

308

"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.

309

"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # 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.

310

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

311

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

312

},

313

"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.

314

"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.

315

"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.

316

},

317

"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.

318

"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.

319

},

320

"shareLink": "A String", # Output only. The share link for the photo.

321

"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.

322

"transferStatus": "A String", # Output only. Status of rights transfer on this photo.

323

"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

324

"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

325

},

326

"viewCount": "A String", # Output only. View count of the photo.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

327

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

328

"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status for the operation to get or update a single photo in the batch request.

329

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

330

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

331

{

332

"a_key": "", # Properties of the object. Contains field @type with type URL.

333

},

334

],

335

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

},

},

],

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

343

<code class="details" id="close">close()</code>

344

<pre>Close httplib2 connections.</pre>

345

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

346

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

347

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

348

<code class="details" id="list">list(filter=None, languageCode=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

349

<pre>Lists all the Photos that belong to the user. *Note:* Recently created photos that are still being indexed are not returned in the response.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

350

351

Args:

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

352

filter: string, Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

353

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.

354

pageSize: integer, The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 is used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`.

355

pageToken: string, The nextPageToken value returned from a previous ListPhotos request, if any.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

356

view: string, Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.

357

Allowed values

358

BASIC - Server reponses do not include the download URL for the photo bytes. The default value.

359

INCLUDE_DOWNLOAD_URL - Server responses include the download URL for the photo bytes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

360

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

367

368

{ # Response to list all photos that belong to a user.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

369

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

370

"photos": [ # List of photos. The pageSize field in the request determines the number of items returned.

371

{ # Photo is used to store 360 photos along with photo metadata.

372

"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.

373

"connections": [ # Connections to other photos. A connection represents the link from this photo to another photo.

374

{ # A connection is the link from a source photo to a destination photo.

375

"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

376

"id": "A String", # Required. A unique identifier for a photo.

377

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

378

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

379

],

380

"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.

381

"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.

382

"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.

383

"id": "A String", # Required. A unique identifier for a photo.

384

},

385

"places": [ # Places where this photo belongs.

386

{ # Place metadata for an entity.

387

"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.

388

"name": "A String", # Output-only. The name of the place, localized to the language_code.

389

"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.

390

},

391

],

392

"pose": { # Raw pose measurement for an entity. # Pose of the photo.

393

"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.

394

"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.

395

"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.

396

"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # 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.

397

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

398

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

399

},

400

"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.

401

"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.

402

"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.

403

},

404

"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.

405

"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.

406

},

407

"shareLink": "A String", # Output only. The share link for the photo.

408

"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.

409

"transferStatus": "A String", # Output only. Status of rights transfer on this photo.

410

"uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

411

"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"

Yoshi Automation Bot