REST Resource: projects.deployments

Ресурс: Развертывание

Представление развертывания одного сценария.

JSON-представление
{
  "deploymentId": string,
  "deploymentConfig": {
    object (DeploymentConfig)
  },
  "updateTime": string,
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ]
}
Поля
deploymentId

string

Идентификатор развертывания для этого развертывания.

deploymentConfig

object ( DeploymentConfig )

Конфигурация развертывания.

updateTime

string ( Timestamp format)

Отметка даты и времени последнего изменения.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

entryPoints[]

object ( EntryPoint )

Точки входа в развертывание.

Конфигурация развертывания

Метаданные определяют, как настраивается развертывание.

JSON-представление
{
  "scriptId": string,
  "versionNumber": integer,
  "manifestFileName": string,
  "description": string
}
Поля
scriptId

string

Идентификатор диска проекта скрипта.

versionNumber

integer

Номер версии, на которой основано это развертывание.

manifestFileName

string

Имя файла манифеста для этого развертывания.

description

string

Описание этого развертывания.

Точка входа

Конфигурация, определяющая способ внешнего доступа к развертыванию.

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 )

Спецификация точки входа для вызовов выполнения API Apps Script.

addOn

object ( AddOnEntryPoint )

Дополнительные свойства.

Энтрипоинттипе

Типы точек входа.

Перечисления
ENTRY_POINT_TYPE_UNSPECIFIED Неуказанная точка входа.
WEB_APP Точка входа веб-приложения.
EXECUTION_API Точка входа исполняемого API.
ADD_ON Точка входа надстройки.

Веб-приложениеEntryPoint

Точка входа веб-приложения.

JSON-представление
{
  "url": string,
  "entryPointConfig": {
    object (WebAppConfig)
  }
}
Поля
url

string

URL-адрес веб-приложения.

entryPointConfig

object ( 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 Сценарий выполняется от имени пользователя, который развернул веб-приложение. Обратите внимание, что это не обязательно владелец проекта сценария.

ВыполнениеApiEntryPoint

Точка входа исполняемого API.

JSON-представление
{
  "entryPointConfig": {
    object (ExecutionApiConfig)
  }
}
Поля
entryPointConfig

object ( ExecutionApiConfig )

Конфигурация точки входа.

ВыполнениеApiConfig

Конфигурация исполняемой точки входа API.

JSON-представление
{
  "access": enum (Access)
}
Поля
access

enum ( Access )

У кого есть разрешение на запуск исполняемого файла API.

Аддонэнтрипоинт

Дополнительная точка входа.

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 Тип дополнения для Студии данных.

Методы

create

Создает развертывание проекта Apps Script.

delete

Удаляет развертывание проекта Apps Script.

get

Получает развертывание проекта Apps Script.

list

Перечисляет развертывания проекта Apps Script.

update

Обновляет развертывание проекта Apps Script.