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

Inherits:
Core::BaseService
  • Object
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

Instance Method Summary collapse

Constructor Details

#initializeSlidesService

Returns a new instance of SlidesService.



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

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.



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

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.



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.

Parameters:

  • presentation_id (String)

    The presentation to apply the updates to.

  • batch_update_presentation_request_object (Google::Apis::SlidesV1::BatchUpdatePresentationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



83
84
85
86
87
88
89
90
91
92
93
# File 'generated/google/apis/slides_v1/service.rb', line 83

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.

Parameters:

  • presentation_object (Google::Apis::SlidesV1::Presentation) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



117
118
119
120
121
122
123
124
125
126
# File 'generated/google/apis/slides_v1/service.rb', line 117

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.

Parameters:

  • presentation_id (String)

    The ID of the presentation to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



148
149
150
151
152
153
154
155
156
# File 'generated/google/apis/slides_v1/service.rb', line 148

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.

Parameters:

  • presentation_id (String)

    The ID of the presentation to retrieve.

  • page_object_id (String)

    The object ID of the page to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



180
181
182
183
184
185
186
187
188
189
# File 'generated/google/apis/slides_v1/service.rb', line 180

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.

Parameters:

  • presentation_id (String)

    The ID of the presentation to retrieve.

  • page_object_id (String)

    The object ID of the page whose thumbnail to retrieve.

  • thumbnail_properties_mime_type (String) (defaults to: nil)

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

  • thumbnail_properties_thumbnail_size (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



221
222
223
224
225
226
227
228
229
230
231
232
# File 'generated/google/apis/slides_v1/service.rb', line 221

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