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)

デプロイのエントリ ポイント。

DeploymentConfig

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

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

string

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

versionNumber

integer

このデプロイのベースになっているバージョン番号。

manifestFileName

string

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

description

string

このデプロイの説明。

EntryPoint

Deployment に外部からアクセスする方法を定義する構成。

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)

アドオン プロパティ。

EntryPointType

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

列挙型
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 ログインの有無にかかわらず、すべてのユーザーがウェブアプリまたは実行可能ファイルにアクセスできます。

ExecuteAs

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

列挙型
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。

AddOnType

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

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

Methods

create

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

delete

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

get

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

list

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

update

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