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)

アドオン プロパティ。

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 データポータルのアドオンタイプ。

メソッド

create

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

delete

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

get

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

list

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

update

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