google_api_script v0.11.0 GoogleApi.Script.V1.Api.Scripts View Source

API calls for all endpoints tagged Scripts.

Link to this section Summary

Functions

Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project.

Link to this section Functions

Link to this function

script_scripts_run(connection, script_id, optional_params \\ [], opts \\ [])

View Source
script_scripts_run(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}

Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project.

This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the Authorization section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select File > Project properties and click the Scopes tab.

The error 403, PERMISSION_DENIED: The caller does not have permission indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.

Parameters

  • connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
  • script_id (type: String.t) - The script ID of the script to be executed. To find the script ID, open the project in the script editor and select File > Project properties.
  • optional_params (type: keyword()) - Optional parameters

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

Returns

  • {:ok, %GoogleApi.Script.V1.Model.Operation{}} on success
  • {:error, info} on failure