google_api_slides v0.1.0 GoogleApi.Slides.V1.Api.Presentations View Source

API calls for all endpoints tagged Presentations.

Link to this section Summary

Functions

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

Creates a new presentation using the title given in the request. If a presentationId is provided, uses it as the ID of the new presentation. Otherwise, a new presentationId is generated. Returns the created presentation

Gets the latest version of the specified presentation

Gets the latest version of the specified page in the presentation

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

Link to this section Functions

Link to this function slides_presentations_batch_update(connection, presentation_id, opts \\ []) View Source
slides_presentations_batch_update(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Slides.V1.Model.BatchUpdatePresentationResponse.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (GoogleApi.Slides.V1.Connection): Connection to server
  • presentation_id (String.t): The presentation to apply the updates to.
  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): 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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (BatchUpdatePresentationRequest):

Returns

{:ok, %GoogleApi.Slides.V1.Model.BatchUpdatePresentationResponse{}} on success {:error, info} on failure

Link to this function slides_presentations_create(connection, opts \\ []) View Source
slides_presentations_create(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Slides.V1.Model.Presentation.t()} | {:error, Tesla.Env.t()}

Creates a new presentation using the title given in the request. If a presentationId is provided, uses it as the ID of the new presentation. Otherwise, a new presentationId is generated. Returns the created presentation.

Parameters

  • connection (GoogleApi.Slides.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): 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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (Presentation):

Returns

{:ok, %GoogleApi.Slides.V1.Model.Presentation{}} on success {:error, info} on failure

Link to this function slides_presentations_get(connection, presentation_id, opts \\ []) View Source
slides_presentations_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Slides.V1.Model.Presentation.t()} | {:error, Tesla.Env.t()}

Gets the latest version of the specified presentation.

Parameters

  • connection (GoogleApi.Slides.V1.Connection): Connection to server
  • presentation_id (String.t): The ID of the presentation to retrieve.
  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): 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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.

Returns

{:ok, %GoogleApi.Slides.V1.Model.Presentation{}} on success {:error, info} on failure

Link to this function slides_presentations_pages_get(connection, presentation_id, page_object_id, opts \\ []) View Source
slides_presentations_pages_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.Slides.V1.Model.Page.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.Slides.V1.Connection): Connection to server
  • presentation_id (String.t): The ID of the presentation to retrieve.
  • page_object_id (String.t): The object ID of the page to retrieve.
  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): 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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.

Returns

{:ok, %GoogleApi.Slides.V1.Model.Page{}} on success {:error, info} on failure

Link to this function slides_presentations_pages_get_thumbnail(connection, presentation_id, page_object_id, opts \\ []) View Source
slides_presentations_pages_get_thumbnail(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.Slides.V1.Model.Thumbnail.t()} | {:error, Tesla.Env.t()}

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

  • connection (GoogleApi.Slides.V1.Connection): Connection to server
  • presentation_id (String.t): The ID of the presentation to retrieve.
  • page_object_id (String.t): The object ID of the page whose thumbnail to retrieve.
  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): 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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :thumbnailProperties.mimeType (String.t): The optional mime type of the thumbnail image. If you don't specify the mime type, the default mime type will be PNG.
    • :thumbnailProperties.thumbnailSize (String.t): The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image.

Returns

{:ok, %GoogleApi.Slides.V1.Model.Thumbnail{}} on success {:error, info} on failure