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 "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "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

شناسه Drive پروژه اسکریپت.

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 )

مشخصات نقطه ورودی برای فراخوانی های اجرای Apps Script API.

addOn

object ( AddOnEntryPoint )

ویژگی های افزودنی

EntryPointType

انواع نقاط ورودی

Enums
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 )

چه کسی برنامه وب را به عنوان اجرا کند.

دسترسی داشته باشید

پیکربندی دسترسی

Enums
UNKNOWN_ACCESS مقدار پیش فرض، نباید استفاده شود.
MYSELF فقط کاربری که برنامه وب یا فایل اجرایی را اجرا کرده است می تواند به آن دسترسی داشته باشد. توجه داشته باشید که این لزوماً مالک پروژه اسکریپت نیست.
DOMAIN فقط کاربرانی در همان دامنه با کاربری که برنامه وب یا فایل اجرایی را اجرا کرده است می توانند به آن دسترسی داشته باشند.
ANYONE هر کاربر وارد شده می تواند به برنامه وب یا فایل اجرایی دسترسی داشته باشد.
ANYONE_ANONYMOUS هر کاربری، اعم از وارد شده یا غیر وارد شده، می‌تواند به برنامه وب یا فایل اجرایی دسترسی داشته باشد.

ExecuteAs

پیکربندی که کاربری را مشخص می‌کند که برنامه وب تحت اختیار او باید به عنوان اجرا شود.

Enums
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

نشانی اینترنتی نکته نصب پست مورد نیاز افزونه.

AddOnType

AddType تعریف می کند که یک برنامه میزبان کدام دسته از افزونه ها را مدیریت می کند. هر نوع افزودنی دارای بخشی از مانیفست اسکریپت است که هنگام استقرار یا اجرای یک افزونه از نوع مشخص شده استفاده می شود.

Enums
UNKNOWN_ADDON_TYPE مقدار پیش‌فرض، نوع افزودنی ناشناخته.
GMAIL نوع افزونه برای جیمیل.
DATA_STUDIO نوع افزونه برای Data Studio.

مواد و روش ها

create

 استقرار یک پروژه Apps Script را ایجاد می کند.

delete

 استقرار یک پروژه Apps Script را حذف می کند.

get

 استقرار یک پروژه Apps Script را دریافت می کند.

list

 استقرار یک پروژه Apps Script را فهرست می کند.

update

 استقرار یک پروژه Apps Script را به روز می کند.