class Google::Apis::SlidesV1::SlidesService

Google Slides API

Reads and writes Google Slides presentations.

@example

require 'google/apis/slides_v1'

Slides = Google::Apis::SlidesV1 # Alias the module
service = Slides::SlidesService.new

@see developers.google.com/slides/

Attributes

key[RW]

@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.
quota_user[RW]

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

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/slides_v1/service.rb, line 45
def initialize
  super('https://slides.googleapis.com/', '',
        client_name: 'google-apis-slides_v1',
        client_version: Google::Apis::SlidesV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

batch_update_presentation(presentation_id, batch_update_presentation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Applies one or more updates to the presentation. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies: the reply to the third request, and another empty reply, in that order. Because other users may be editing the presentation, the presentation might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the presentation should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. @param [String] presentation_id

The presentation to apply the updates to.

@param [Google::Apis::SlidesV1::BatchUpdatePresentationRequest] batch_update_presentation_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::SlidesV1::BatchUpdatePresentationResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SlidesV1::BatchUpdatePresentationResponse]

@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

# File lib/google/apis/slides_v1/service.rb, line 85
def batch_update_presentation(presentation_id, batch_update_presentation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/presentations/{presentationId}:batchUpdate', options)
  command.request_representation = Google::Apis::SlidesV1::BatchUpdatePresentationRequest::Representation
  command.request_object = batch_update_presentation_request_object
  command.response_representation = Google::Apis::SlidesV1::BatchUpdatePresentationResponse::Representation
  command.response_class = Google::Apis::SlidesV1::BatchUpdatePresentationResponse
  command.params['presentationId'] = presentation_id unless presentation_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
create_presentation(presentation_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a blank presentation using the title given in the request. If a ` presentationId` is provided, it is used as the ID of the new presentation. Otherwise, a new ID is generated. Other fields in the request, including any provided content, are ignored. Returns the created presentation. @param [Google::Apis::SlidesV1::Presentation] presentation_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::SlidesV1::Presentation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SlidesV1::Presentation]

@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

# File lib/google/apis/slides_v1/service.rb, line 119
def create_presentation(presentation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/presentations', options)
  command.request_representation = Google::Apis::SlidesV1::Presentation::Representation
  command.request_object = presentation_object
  command.response_representation = Google::Apis::SlidesV1::Presentation::Representation
  command.response_class = Google::Apis::SlidesV1::Presentation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_presentation(presentation_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the latest version of the specified presentation. @param [String] presentation_id

The ID of the presentation to retrieve.

@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::SlidesV1::Presentation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SlidesV1::Presentation]

@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

# File lib/google/apis/slides_v1/service.rb, line 150
def get_presentation(presentation_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/presentations/{+presentationId}', options)
  command.response_representation = Google::Apis::SlidesV1::Presentation::Representation
  command.response_class = Google::Apis::SlidesV1::Presentation
  command.params['presentationId'] = presentation_id unless presentation_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_presentation_page(presentation_id, page_object_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the latest version of the specified page in the presentation. @param [String] presentation_id

The ID of the presentation to retrieve.

@param [String] page_object_id

The object ID of the page to retrieve.

@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::SlidesV1::Page] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SlidesV1::Page]

@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

# File lib/google/apis/slides_v1/service.rb, line 182
def get_presentation_page(presentation_id, page_object_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/presentations/{presentationId}/pages/{pageObjectId}', options)
  command.response_representation = Google::Apis::SlidesV1::Page::Representation
  command.response_class = Google::Apis::SlidesV1::Page
  command.params['presentationId'] = presentation_id unless presentation_id.nil?
  command.params['pageObjectId'] = page_object_id unless page_object_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_presentation_page_thumbnail(presentation_id, page_object_id, thumbnail_properties_mime_type: nil, thumbnail_properties_thumbnail_size: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](/slides/limits) for quota purposes. @param [String] presentation_id

The ID of the presentation to retrieve.

@param [String] page_object_id

The object ID of the page whose thumbnail to retrieve.

@param [String] thumbnail_properties_mime_type

The optional mime type of the thumbnail image. If you don't specify the mime
type, the mime type defaults to PNG.

@param [String] thumbnail_properties_thumbnail_size

The optional thumbnail image size. If you don't specify the size, the server
chooses a default size of the image.

@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::SlidesV1::Thumbnail] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SlidesV1::Thumbnail]

@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

# File lib/google/apis/slides_v1/service.rb, line 223
def get_presentation_page_thumbnail(presentation_id, page_object_id, thumbnail_properties_mime_type: nil, thumbnail_properties_thumbnail_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail', options)
  command.response_representation = Google::Apis::SlidesV1::Thumbnail::Representation
  command.response_class = Google::Apis::SlidesV1::Thumbnail
  command.params['presentationId'] = presentation_id unless presentation_id.nil?
  command.params['pageObjectId'] = page_object_id unless page_object_id.nil?
  command.query['thumbnailProperties.mimeType'] = thumbnail_properties_mime_type unless thumbnail_properties_mime_type.nil?
  command.query['thumbnailProperties.thumbnailSize'] = thumbnail_properties_thumbnail_size unless thumbnail_properties_thumbnail_size.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 Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/slides_v1/service.rb, line 238
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end