Class: Google::Apis::SlidesV1::SlidesService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/slides_v1/service.rb

Overview

Google Slides API

Reads and writes Google Slides presentations.

Examples:

require 'google/apis/slides_v1'

Slides = Google::Apis::SlidesV1 # Alias the module
service = Slides::SlidesService.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

#initializeSlidesService


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

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

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/slides_v1/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/slides_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_update_presentation(presentation_id, batch_update_presentation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SlidesV1::BatchUpdatePresentationResponse

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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) {|result, err| ... } ⇒ Google::Apis::SlidesV1::Presentation

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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) {|result, err| ... } ⇒ Google::Apis::SlidesV1::Presentation

Gets the latest version of the specified presentation.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


153
154
155
156
157
158
159
160
161
# File 'generated/google/apis/slides_v1/service.rb', line 153

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) {|result, err| ... } ⇒ Google::Apis::SlidesV1::Page

Gets the latest version of the specified page in the presentation.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


185
186
187
188
189
190
191
192
193
194
# File 'generated/google/apis/slides_v1/service.rb', line 185

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) {|result, err| ... } ⇒ Google::Apis::SlidesV1::Thumbnail

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 for quota purposes.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


228
229
230
231
232
233
234
235
236
237
238
239
# File 'generated/google/apis/slides_v1/service.rb', line 228

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