GoogleApi.Script.V1.Api.Projects (google_api_script v0.19.0)

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, optional_params \\ [], opts \\ [])

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

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

Gets a version of a script project.

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

List the versions of a script project.

Functions

script_projects_create(connection, optional_params \\ [], opts \\ [])

@spec script_projects_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Project.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
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.CreateProjectRequest.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_deployments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Deployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a deployment of an Apps Script project.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
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.DeploymentConfig.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_deployments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a deployment of an Apps Script project.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
deployment_id (type: String.t) - The deployment ID to be undeployed.
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").
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_deployments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Deployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a deployment of an Apps Script project.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
deployment_id (type: String.t) - The deployment ID.
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").
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_deployments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.ListDeploymentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the deployments of an Apps Script project.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
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").
- :pageSize (type: integer()) - The maximum number of deployments on each returned page. Defaults to 50.
- :pageToken (type: 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.
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_deployments_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Deployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a deployment of an Apps Script project.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
deployment_id (type: String.t) - The deployment ID for this deployment.
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.UpdateDeploymentRequest.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Script.V1.Model.Project.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a script project's metadata.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
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").
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_get_content(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Content.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
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").
- :versionNumber (type: integer()) - The version number of the project to retrieve. If not provided, the project's HEAD version is returned.
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_get_metrics(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Metrics.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - Required field indicating the script to get metrics for.
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").
- :"metricsFilter.deploymentId" (type: String.t) - Optional field indicating a specific deployment to retrieve metrics from.
- :metricsGranularity (type: String.t) - Required field indicating what granularity of metrics are returned.
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_update_content(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Content.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
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.Content.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_versions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
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.Version.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_versions_get(
  Tesla.Env.client(),
  String.t(),
  integer(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a version of a script project.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
version_number (type: integer()) - The version number.
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").
opts (type: keyword()) - Call options

Returns

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

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

@spec script_projects_versions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Script.V1.Model.ListVersionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List the versions of a script project.

Parameters

connection (type: GoogleApi.Script.V1.Connection.t) - Connection to server
script_id (type: String.t) - The script project's Drive ID.
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").
- :pageSize (type: integer()) - The maximum number of versions on each returned page. Defaults to 50.
- :pageToken (type: 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.
opts (type: keyword()) - Call options

Returns

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