Class: Google::Apis::StreetviewpublishV1::StreetViewPublishService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/streetviewpublish_v1/service.rb

Overview

Street View Publish API

Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.

Examples:

require 'google/apis/streetviewpublish_v1'

Streetviewpublish = Google::Apis::StreetviewpublishV1 # Alias the module
service = Streetviewpublish::StreetViewPublishService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeStreetViewPublishService

Returns a new instance of StreetViewPublishService


47
48
49
50
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 47

def initialize
  super('https://streetviewpublish.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


40
41
42
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 40

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


45
46
47
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#batch_delete_photos(batch_delete_photos_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::BatchDeletePhotosResponse

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

Parameters:

  • batch_delete_photos_request_object (Google::Apis::StreetviewpublishV1::BatchDeletePhotosRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


333
334
335
336
337
338
339
340
341
342
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 333

def batch_delete_photos(batch_delete_photos_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/photos:batchDelete', options)
  command.request_representation = Google::Apis::StreetviewpublishV1::BatchDeletePhotosRequest::Representation
  command.request_object = batch_delete_photos_request_object
  command.response_representation = Google::Apis::StreetviewpublishV1::BatchDeletePhotosResponse::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::BatchDeletePhotosResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_photo_get(language_code: nil, photo_ids: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::BatchGetPhotosResponse

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

Parameters:

  • language_code (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 will be used.

  • photo_ids (Array<String>, String)

    Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be photoIds=<id1>&photoIds=<id2>&....

  • view (String)

    Specifies if a download URL for the photo bytes should be returned in the Photo response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


389
390
391
392
393
394
395
396
397
398
399
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 389

def batch_photo_get(language_code: nil, photo_ids: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/photos:batchGet', options)
  command.response_representation = Google::Apis::StreetviewpublishV1::BatchGetPhotosResponse::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::BatchGetPhotosResponse
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['photoIds'] = photo_ids unless photo_ids.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_update_photos(batch_update_photos_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::BatchUpdatePhotosResponse

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 was an authentication error. Even if BatchUpdatePhotos succeeds, there may have been failures for single photos in the batch. These failures will be 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.

Parameters:

  • batch_update_photos_request_object (Google::Apis::StreetviewpublishV1::BatchUpdatePhotosRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


448
449
450
451
452
453
454
455
456
457
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 448

def batch_update_photos(batch_update_photos_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/photos:batchUpdate', options)
  command.request_representation = Google::Apis::StreetviewpublishV1::BatchUpdatePhotosRequest::Representation
  command.request_object = batch_update_photos_request_object
  command.response_representation = Google::Apis::StreetviewpublishV1::BatchUpdatePhotosResponse::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::BatchUpdatePhotosResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_photo(photo_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::Photo

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. The pose.heading, pose.pitch, pose.roll, pose.altitude, and pose.level fields in Pose are ignored for CreatePhoto. 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.

Parameters:

  • photo_object (Google::Apis::StreetviewpublishV1::Photo) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


87
88
89
90
91
92
93
94
95
96
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 87

def create_photo(photo_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/photo', options)
  command.request_representation = Google::Apis::StreetviewpublishV1::Photo::Representation
  command.request_object = photo_object
  command.response_representation = Google::Apis::StreetviewpublishV1::Photo::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::Photo
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_photo(photo_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::Empty

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.

Parameters:

  • photo_id (String)

    Required. ID of the Photo.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


122
123
124
125
126
127
128
129
130
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 122

def delete_photo(photo_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/photo/{photoId}', options)
  command.response_representation = Google::Apis::StreetviewpublishV1::Empty::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::Empty
  command.params['photoId'] = photo_id unless photo_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_photo(photo_id, language_code: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::Photo

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.

Parameters:

  • photo_id (String)

    Required. ID of the Photo.

  • language_code (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 will be used.

  • view (String)

    Specifies if a download URL for the photo bytes should be returned in the Photo response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


169
170
171
172
173
174
175
176
177
178
179
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 169

def get_photo(photo_id, language_code: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/photo/{photoId}', options)
  command.response_representation = Google::Apis::StreetviewpublishV1::Photo::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::Photo
  command.params['photoId'] = photo_id unless photo_id.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_photos(filter: nil, language_code: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::ListPhotosResponse

Lists all the Photos that belong to the user.

Parameters:

  • filter (String)

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

  • language_code (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 will be used.

  • page_size (Fixnum)

    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 will be 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.

  • page_token (String)

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

  • view (String)

    Specifies if a download URL for the photos bytes should be returned in the Photos response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


504
505
506
507
508
509
510
511
512
513
514
515
516
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 504

def list_photos(filter: nil, language_code: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/photos', options)
  command.response_representation = Google::Apis::StreetviewpublishV1::ListPhotosResponse::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::ListPhotosResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_photo_upload(empty_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::UploadRef

Creates an upload session to start uploading photo bytes. The upload URL of the returned UploadRef is used 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 also meet the following requirements:

Parameters:

  • empty_object (Google::Apis::StreetviewpublishV1::Empty) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


215
216
217
218
219
220
221
222
223
224
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 215

def start_photo_upload(empty_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/photo:startUpload', options)
  command.request_representation = Google::Apis::StreetviewpublishV1::Empty::Representation
  command.request_object = empty_object
  command.response_representation = Google::Apis::StreetviewpublishV1::UploadRef::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::UploadRef
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_photo(id, photo_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StreetviewpublishV1::Photo

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.

Parameters:

  • id (String)

    Required. A unique identifier for a photo.

  • photo_object (Google::Apis::StreetviewpublishV1::Photo) (defaults to: nil)
  • update_mask (String)

    Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata will be 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
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


287
288
289
290
291
292
293
294
295
296
297
298
# File 'generated/google/apis/streetviewpublish_v1/service.rb', line 287

def update_photo(id, photo_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1/photo/{id}', options)
  command.request_representation = Google::Apis::StreetviewpublishV1::Photo::Representation
  command.request_object = photo_object
  command.response_representation = Google::Apis::StreetviewpublishV1::Photo::Representation
  command.response_class = Google::Apis::StreetviewpublishV1::Photo
  command.params['id'] = id unless id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end