google-api-ruby-client/generated/google/apis/streetviewpublish_v1/service.rb

486 lines
26 KiB
Ruby
Raw Normal View History

Autogenerated update (2017-08-25) Add: - adexperiencereport_v1 - androiddeviceprovisioning_v1 - androidmanagement_v1 - bigquerydatatransfer_v1 - cloudtrace_v2 - clouduseraccounts_vm_alpha - consumersurveys_v2 - dlp_v2beta1 - oslogin_v1alpha - playcustomapp_v1 - playmoviespartner_v1 - safebrowsing_v4 - spectrum_v1explorer - speech_v1 - streetviewpublish_v1 - vault_v1 - videointelligence_v1beta1 Update: - acceleratedmobilepageurl_v1 - adexchangebuyer2_v2beta1 - adexchangebuyer_v1_4 - adsense_v1_4 - adsensehost_v4_1 - analytics_v3 - analyticsreporting_v4 - androidenterprise_v1 - androidpublisher_v2 - appengine_v1 - appsactivity_v1 - appstate_v1 - bigquery_v2 - calendar_v3 - classroom_v1 - cloudbilling_v1 - cloudbuild_v1 - clouddebugger_v2 - clouderrorreporting_v1beta1 - cloudfunctions_v1 - cloudkms_v1 - cloudmonitoring_v2beta2 - cloudresourcemanager_v1 - compute_beta - compute_v1 - container_v1 - content_v2 - dataflow_v1b3 - dataproc_v1 - datastore_v1 - deploymentmanager_v2 - dfareporting_v2_8 - dns_v1 - doubleclicksearch_v2 - drive_v3 - firebasedynamiclinks_v1 - firebaserules_v1 - fitness_v1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v1 - gmail_v1 - iam_v1 - identitytoolkit_v3 - language_v1 - logging_v2 - manufacturers_v1 - ml_v1 - monitoring_v3 - oauth2_v2 - partners_v2 - people_v1 - plus_domains_v1 - plus_v1 - proximitybeacon_v1beta1 - pubsub_v1 - runtimeconfig_v1 - script_v1 - searchconsole_v1 - servicecontrol_v1 - servicemanagement_v1 - serviceuser_v1 - sheets_v4 - slides_v1 - sourcerepo_v1 - spanner_v1 - sqladmin_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vision_v1 - webmasters_v3 - youtube_analytics_v1 - youtube_partner_v1 - youtubereporting_v1
2017-08-25 19:54:22 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module StreetviewpublishV1
# 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.
#
# @example
# require 'google/apis/streetviewpublish_v1'
#
# Streetviewpublish = Google::Apis::StreetviewpublishV1 # Alias the module
# service = Streetviewpublish::StreetViewPublishService.new
#
# @see https://developers.google.com/streetview/publish/
class StreetViewPublishService < Google::Apis::Core::BaseService
# @return [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.
attr_accessor :key
# @return [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.
attr_accessor :quota_user
def initialize
super('https://streetviewpublish.googleapis.com/', '')
@batch_path = 'batch'
end
# After the client finishes uploading the photo with the returned
# UploadRef,
# CreatePhoto
# publishes the uploaded Photo to
# Street View on Google Maps.
# This method returns the following error codes:
# * google.rpc.Code.INVALID_ARGUMENT if the request is malformed.
# * 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.
# @param [Google::Apis::StreetviewpublishV1::Photo] photo_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::Photo] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::Photo]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] photo_id
# Required. ID of the Photo.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] photo_id
# Required. ID of the Photo.
# @param [String] view
# Specifies if a download URL for the photo bytes should be returned in the
# Photo response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::Photo] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::Photo]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_photo(photo_id, 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['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
# 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:
# * 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 is complete, the
# UploadRef is used with
# CreatePhoto
# to create the Photo object entry.
# @param [Google::Apis::StreetviewpublishV1::Empty] empty_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::UploadRef] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::UploadRef]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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
# updateMask
# field are used. If `updateMask` is not present, the update applies to all
# fields.
# <aside class="note"><b>Note:</b> To update
# Pose.altitude,
# Pose.latLngPair has to be
# filled as well. Otherwise, the request will fail.</aside>
# 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.
# @param [String] id
# Required. A unique identifier for a photo.
# @param [Google::Apis::StreetviewpublishV1::Photo] photo_object
# @param [String] update_mask
# 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`
# <aside class="note"><b>Note:</b> Repeated fields in
# updateMask
# mean the entire set of repeated values will be replaced with the new
# contents. For example, if
# updateMask
# contains `connections` and `UpdatePhotoRequest.photo.connections` is empty,
# all connections will be removed.</aside>
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::Photo] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::Photo]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [Google::Apis::StreetviewpublishV1::BatchDeletePhotosRequest] batch_delete_photos_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::BatchDeletePhotosResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::BatchDeletePhotosResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [Array<String>, String] photo_ids
# Required. IDs of the Photos. For HTTP
# GET requests, the URL query parameter should be
# `photoIds=<id1>&photoIds=<id2>&...`.
# @param [String] view
# Specifies if a download URL for the photo bytes should be returned in the
# Photo response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::BatchGetPhotosResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::BatchGetPhotosResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_photo_get(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['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
# 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.
# <aside class="note"><b>Note:</b> To update
# Pose.altitude,
# Pose.latLngPair has to be
# filled as well. Otherwise, the request will fail.</aside>
# @param [Google::Apis::StreetviewpublishV1::BatchUpdatePhotosRequest] batch_update_photos_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::BatchUpdatePhotosResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::BatchUpdatePhotosResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists all the Photos that belong to
# the user.
# @param [String] filter
# The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.
# @param [Fixnum] page_size
# 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`.
# @param [String] page_token
# The
# nextPageToken
# value returned from a previous
# ListPhotos
# request, if any.
# @param [String] view
# Specifies if a download URL for the photos bytes should be returned in the
# Photos response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StreetviewpublishV1::ListPhotosResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StreetviewpublishV1::ListPhotosResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_photos(filter: 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['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
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end