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

デプロイに外部でアクセスする方法を定義する構成。

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)

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

実行 API 構成

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。

アドオンタイプ

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

Methods

create

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

delete

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

get

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

list

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

update

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