google_api_script

v0.1.0

google_api_script v0.1.0 GoogleApi.Script.V1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

script_projects_create(connection, opts \\ [])

Creates a new, empty script project with no script files and a base manifest file

script_projects_deployments_create(connection, script_id, opts \\ [])

Creates a deployment of an Apps Script project

script_projects_deployments_delete(connection, script_id, deployment_id, opts \\ [])

Deletes a deployment of an Apps Script project

script_projects_deployments_get(connection, script_id, deployment_id, opts \\ [])

Gets a deployment of an Apps Script project

script_projects_deployments_list(connection, script_id, opts \\ [])

Lists the deployments of an Apps Script project

script_projects_deployments_update(connection, script_id, deployment_id, opts \\ [])

Updates a deployment of an Apps Script project

script_projects_get(connection, script_id, opts \\ [])

Gets a script project's metadata

script_projects_get_content(connection, script_id, opts \\ [])

Gets the content of the script project, including the code source and metadata for each script file

script_projects_get_metrics(connection, script_id, opts \\ [])

Get metrics data for scripts, such as number of executions and active users

script_projects_update_content(connection, script_id, opts \\ [])

Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project

script_projects_versions_create(connection, script_id, opts \\ [])

Creates a new immutable version using the current code, with a unique version number

script_projects_versions_get(connection, script_id, version_number, opts \\ [])

Gets a version of a script project

script_projects_versions_list(connection, script_id, opts \\ [])

List the versions of a script project

Link to this section Functions

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

Creates a new, empty script project with no script files and a base manifest file.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_deployments_create(connection, script_id, opts \\ []) View Source 
script_projects_deployments_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Deployment.t()} | {:error, Tesla.Env.t()}

Creates a deployment of an Apps Script project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_deployments_delete(connection, script_id, deployment_id, opts \\ []) View Source 
script_projects_deployments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.Script.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a deployment of an Apps Script project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.
  • deployment_id (String.t): The deployment ID to be undeployed.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_deployments_get(connection, script_id, deployment_id, opts \\ []) View Source 
script_projects_deployments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.Script.V1.Model.Deployment.t()} | {:error, Tesla.Env.t()}

Gets a deployment of an Apps Script project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.
  • deployment_id (String.t): The deployment ID.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_deployments_list(connection, script_id, opts \\ []) View Source 
script_projects_deployments_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.ListDeploymentsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the deployments of an Apps Script project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.

  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :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.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :pageToken (String.t): The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
    • :pageSize (integer()): The maximum number of deployments on each returned page. Defaults to 50.

Returns

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

Link to this function script_projects_deployments_update(connection, script_id, deployment_id, opts \\ []) View Source 
script_projects_deployments_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.Script.V1.Model.Deployment.t()} | {:error, Tesla.Env.t()}

Updates a deployment of an Apps Script project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.
  • deployment_id (String.t): The deployment ID for this deployment.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_get(connection, script_id, opts \\ []) View Source 
script_projects_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Project.t()} | {:error, Tesla.Env.t()}

Gets a script project's metadata.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_get_content(connection, script_id, opts \\ []) View Source 
script_projects_get_content(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Content.t()} | {:error, Tesla.Env.t()}

Gets the content of the script project, including the code source and metadata for each script file.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.

  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :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.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :versionNumber (integer()): The version number of the project to retrieve. If not provided, the project's HEAD version is returned.

Returns

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

Link to this function script_projects_get_metrics(connection, script_id, opts \\ []) View Source 
script_projects_get_metrics(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Metrics.t()} | {:error, Tesla.Env.t()}

Get metrics data for scripts, such as number of executions and active users.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): Required field indicating the script to get metrics for.

  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :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.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :metricsFilter.deploymentId (String.t): Optional field indicating a specific deployment to retrieve metrics from.
    • :metricsGranularity (String.t): Required field indicating what granularity of metrics are returned.

Returns

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

Link to this function script_projects_update_content(connection, script_id, opts \\ []) View Source 
script_projects_update_content(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Content.t()} | {:error, Tesla.Env.t()}

Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_versions_create(connection, script_id, opts \\ []) View Source 
script_projects_versions_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Version.t()} | {:error, Tesla.Env.t()}

Creates a new immutable version using the current code, with a unique version number.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_versions_get(connection, script_id, version_number, opts \\ []) View Source 
script_projects_versions_get(
  Tesla.Env.client(),
  String.t(),
  integer(),
  keyword()
) :: {:ok, GoogleApi.Script.V1.Model.Version.t()} | {:error, Tesla.Env.t()}

Gets a version of a script project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.
  • version_number (integer()): The version number.

  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function script_projects_versions_list(connection, script_id, opts \\ []) View Source 
script_projects_versions_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.ListVersionsResponse.t()}
  | {:error, Tesla.Env.t()}

List the versions of a script project.

Parameters

  • connection (GoogleApi.Script.V1.Connection): Connection to server
  • script_id (String.t): The script project's Drive ID.

  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :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.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :pageToken (String.t): The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
    • :pageSize (integer()): The maximum number of versions on each returned page. Defaults to 50.

Returns

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