REST Resource: projects.deployments

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: Deployment

単一のスクリプトのデプロイの表現。

JSON 表現 
{
  "deploymentId": string,
  "deploymentConfig": {
    object (DeploymentConfig)
  },
  "updateTime": string,
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ]
}
フィールド
deploymentId

string

このデプロイのデプロイ ID。
deploymentConfig

object (DeploymentConfig)

デプロイ構成。
updateTime

string (Timestamp format)

最終更新日のタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。解像度はナノ秒で、小数点以下 9 桁まで指定できます。（例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"）。
entryPoints[]

object (EntryPoint)

Deployment のエントリ ポイント。

DeploymentConfig

メタデータはデプロイの構成方法を定義します。

JSON 表現 
{
  "scriptId": string,
  "versionNumber": integer,
  "manifestFileName": string,
  "description": string
}
フィールド
scriptId

string

スクリプト プロジェクトのドライブ ID。
versionNumber

integer

このデプロイのベースとなるバージョン番号。
manifestFileName

string

このデプロイのマニフェスト ファイル名。
description

string

このデプロイメントの説明。

EntryPoint

デプロイメントに外部からアクセスする方法を定義する構成。

JSON 表現 
{
  "entryPointType": enum (EntryPointType),

  // Union field properties can be only one of the following:
  "webApp": {
    object (WebAppEntryPoint)
  },
  "executionApi": {
    object (ExecutionApiEntryPoint)
  },
  "addOn": {
    object (AddOnEntryPoint)
  }
  // End of list of possible types for union field properties.
}
フィールド
entryPointType

enum (EntryPointType)

エントリ ポイントのタイプ。
共用体フィールド properties。エントリ ポイントのタイプごとのエントリ ポイントのプロパティ。properties は次のいずれかになります。
webApp

object (WebAppEntryPoint)

ウェブアプリのエントリ ポイントの仕様。
executionApi

object (ExecutionApiEntryPoint)

Apps Script API 実行呼び出しのエントリ ポイントの仕様。
addOn

object (AddOnEntryPoint)

アドオンのプロパティ。

エントリ ポイント タイプ

エントリ ポイントのタイプ。

列挙型
ENTRY_POINT_TYPE_UNSPECIFIED 未指定のエントリ ポイント。
WEB_APP ウェブ アプリケーションのエントリ ポイント。
EXECUTION_API API 実行可能エントリ ポイント。
ADD_ON アドオンのエントリ ポイント。

WebAppEntryPoint

ウェブ アプリケーションのエントリ ポイント。

JSON 表現 
{
  "url": string,
  "entryPointConfig": {
    object (WebAppConfig)
  }
}
フィールド
url

string

ウェブ アプリケーションの URL。
entryPointConfig

object (WebAppConfig)

エントリ ポイントの構成。

WebAppConfig

ウェブアプリのエントリ ポイントの構成。

JSON 表現 
{
  "access": enum (Access),
  "executeAs": enum (ExecuteAs)
}
フィールド
access

enum (Access)

ウェブアプリの実行権限を持つユーザー。
executeAs

enum (ExecuteAs)

ウェブアプリを実行するユーザー。

知る

アクセス構成。

列挙型
UNKNOWN_ACCESS デフォルト値は使用しないでください。
MYSELF ウェブアプリまたは実行可能ファイルをデプロイしたユーザーのみがアクセスできます。これは、必ずしもスクリプト プロジェクトのオーナーであるとは限りません。
DOMAIN ウェブアプリまたは実行可能ファイルをデプロイしたユーザーと同じドメイン内のユーザーのみがアクセスできます。
ANYONE ログイン中のユーザーは、ウェブアプリまたは実行可能ファイルにアクセスできます。
ANYONE_ANONYMOUS ログインしていなくても、すべてのユーザーがウェブアプリまたは実行可能ファイルにアクセスできます。

実行

ウェブアプリの実行権限があるユーザーを指定する構成。

列挙型
UNKNOWN_EXECUTE_AS デフォルト値は使用しないでください。
USER_ACCESSING このスクリプトは、ユーザーがウェブアプリにアクセスすると実行されます。
USER_DEPLOYING このスクリプトは、ウェブアプリをデプロイしたユーザーとして実行されます。ただし、これは必ずしもスクリプト プロジェクトのオーナーであるとは限りません。

ExecutionApiEntryPoint

API 実行可能エントリ ポイント。

JSON 表現 
{
  "entryPointConfig": {
    object (ExecutionApiConfig)
  }
}
フィールド
entryPointConfig

object (ExecutionApiConfig)

エントリ ポイントの構成。

ExecutionApiConfig

API 実行可能エントリ ポイントの構成。

JSON 表現 
{
  "access": enum (Access)
}
フィールド
access

enum (Access)

API 実行可能ファイルを実行する権限を持つユーザー。

AddOnEntryPoint

アドオンのエントリ ポイント。

JSON 表現 
{
  "addOnType": enum (AddOnType),
  "title": string,
  "description": string,
  "helpUrl": string,
  "reportIssueUrl": string,
  "postInstallTipUrl": string
}
フィールド
addOnType

enum (AddOnType)

サポートされているコンテナタイプのアドオンの必須リスト。
title

string

アドオンの必須タイトル。
description

string

アドオンの説明（省略可）。
helpUrl

string

アドオンのヘルプ URL（省略可）。
reportIssueUrl

string

アドオンのレポートに関する問題（オプション）の URL。
postInstallTipUrl

string

アドオンで必要なインストール後のヒントの URL。

アドオンの種類

AddType はホスト アプリケーションが処理するアドオンのカテゴリを定義します。各アドオンタイプには、そのタイプのアドオンをデプロイまたは実行する際に使用されるスクリプト マニフェストのセクションがあります。

列挙型
UNKNOWN_ADDON_TYPE デフォルト値、不明なアドオンタイプ。
GMAIL Gmail のアドオンの種類。
DATA_STUDIO データポータルのアドオンタイプ。

Methods

create

 Apps Script プロジェクトのデプロイを作成します。

delete

 Apps Script プロジェクトのデプロイメントを削除します。

get

 Apps Script プロジェクトのデプロイを取得します。

list

 Apps Script プロジェクトのデプロイを一覧表示します。

update

 Apps Script プロジェクトのデプロイを更新します。