| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="script_v1.html">Apps Script API</a> . <a href="script_v1.projects.html">projects</a> . <a href="script_v1.projects.deployments.html">deployments</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(scriptId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a deployment of an Apps Script project.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(scriptId, deploymentId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a deployment of an Apps Script project.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(scriptId, deploymentId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a deployment of an Apps Script project.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the deployments of an Apps Script project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(scriptId, deploymentId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a deployment of an Apps Script project.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(scriptId, body=None, x__xgafv=None)</code> |
| <pre>Creates a deployment of an Apps Script project. |
| |
| Args: |
| scriptId: string, The script project's Drive ID. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Metadata the defines how a deployment is configured. |
| "scriptId": "A String", # The script project's Drive ID. |
| "versionNumber": 42, # The version number on which this deployment is based. |
| "description": "A String", # The description for this deployment. |
| "manifestFileName": "A String", # The manifest file name for this deployment. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Representation of a single script deployment. |
| "entryPoints": [ # The deployment's entry points. |
| { # A configuration that defines how a deployment is accessed externally. |
| "webApp": { # A web application entry point. # An entry point specification for web apps. |
| "url": "A String", # The URL for the web application. |
| "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. |
| "executeAs": "A String", # Who to execute the web app as. |
| "access": "A String", # Who has permission to run the web app. |
| }, |
| }, |
| "addOn": { # An add-on entry point. # Add-on properties. |
| "description": "A String", # The add-on's optional description. |
| "postInstallTipUrl": "A String", # The add-on's required post install tip URL. |
| "helpUrl": "A String", # The add-on's optional help URL. |
| "addOnType": "A String", # The add-on's required list of supported container types. |
| "reportIssueUrl": "A String", # The add-on's optional report issue URL. |
| "title": "A String", # The add-on's required title. |
| }, |
| "entryPointType": "A String", # The type of the entry point. |
| "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. |
| "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. |
| "access": "A String", # Who has permission to run the API executable. |
| }, |
| }, |
| }, |
| ], |
| "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. |
| "scriptId": "A String", # The script project's Drive ID. |
| "versionNumber": 42, # The version number on which this deployment is based. |
| "description": "A String", # The description for this deployment. |
| "manifestFileName": "A String", # The manifest file name for this deployment. |
| }, |
| "deploymentId": "A String", # The deployment ID for this deployment. |
| "updateTime": "A String", # Last modified date time stamp. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(scriptId, deploymentId, x__xgafv=None)</code> |
| <pre>Deletes a deployment of an Apps Script project. |
| |
| Args: |
| scriptId: string, The script project's Drive ID. (required) |
| deploymentId: string, The deployment ID to be undeployed. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(scriptId, deploymentId, x__xgafv=None)</code> |
| <pre>Gets a deployment of an Apps Script project. |
| |
| Args: |
| scriptId: string, The script project's Drive ID. (required) |
| deploymentId: string, The deployment ID. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Representation of a single script deployment. |
| "entryPoints": [ # The deployment's entry points. |
| { # A configuration that defines how a deployment is accessed externally. |
| "webApp": { # A web application entry point. # An entry point specification for web apps. |
| "url": "A String", # The URL for the web application. |
| "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. |
| "executeAs": "A String", # Who to execute the web app as. |
| "access": "A String", # Who has permission to run the web app. |
| }, |
| }, |
| "addOn": { # An add-on entry point. # Add-on properties. |
| "description": "A String", # The add-on's optional description. |
| "postInstallTipUrl": "A String", # The add-on's required post install tip URL. |
| "helpUrl": "A String", # The add-on's optional help URL. |
| "addOnType": "A String", # The add-on's required list of supported container types. |
| "reportIssueUrl": "A String", # The add-on's optional report issue URL. |
| "title": "A String", # The add-on's required title. |
| }, |
| "entryPointType": "A String", # The type of the entry point. |
| "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. |
| "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. |
| "access": "A String", # Who has permission to run the API executable. |
| }, |
| }, |
| }, |
| ], |
| "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. |
| "scriptId": "A String", # The script project's Drive ID. |
| "versionNumber": 42, # The version number on which this deployment is based. |
| "description": "A String", # The description for this deployment. |
| "manifestFileName": "A String", # The manifest file name for this deployment. |
| }, |
| "deploymentId": "A String", # The deployment ID for this deployment. |
| "updateTime": "A String", # Last modified date time stamp. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the deployments of an Apps Script project. |
| |
| Args: |
| scriptId: string, The script project's Drive ID. (required) |
| pageSize: integer, The maximum number of deployments on each returned page. Defaults to 50. |
| pageToken: string, The token for continuing a previous list request on the next page. This |
| should be set to the value of `nextPageToken` from a previous response. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response with the list of deployments for the specified Apps Script project. |
| "deployments": [ # The list of deployments. |
| { # Representation of a single script deployment. |
| "entryPoints": [ # The deployment's entry points. |
| { # A configuration that defines how a deployment is accessed externally. |
| "webApp": { # A web application entry point. # An entry point specification for web apps. |
| "url": "A String", # The URL for the web application. |
| "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. |
| "executeAs": "A String", # Who to execute the web app as. |
| "access": "A String", # Who has permission to run the web app. |
| }, |
| }, |
| "addOn": { # An add-on entry point. # Add-on properties. |
| "description": "A String", # The add-on's optional description. |
| "postInstallTipUrl": "A String", # The add-on's required post install tip URL. |
| "helpUrl": "A String", # The add-on's optional help URL. |
| "addOnType": "A String", # The add-on's required list of supported container types. |
| "reportIssueUrl": "A String", # The add-on's optional report issue URL. |
| "title": "A String", # The add-on's required title. |
| }, |
| "entryPointType": "A String", # The type of the entry point. |
| "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. |
| "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. |
| "access": "A String", # Who has permission to run the API executable. |
| }, |
| }, |
| }, |
| ], |
| "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. |
| "scriptId": "A String", # The script project's Drive ID. |
| "versionNumber": 42, # The version number on which this deployment is based. |
| "description": "A String", # The description for this deployment. |
| "manifestFileName": "A String", # The manifest file name for this deployment. |
| }, |
| "deploymentId": "A String", # The deployment ID for this deployment. |
| "updateTime": "A String", # Last modified date time stamp. |
| }, |
| ], |
| "nextPageToken": "A String", # The token that can be used in the next call to get the next page of |
| # results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(scriptId, deploymentId, body=None, x__xgafv=None)</code> |
| <pre>Updates a deployment of an Apps Script project. |
| |
| Args: |
| scriptId: string, The script project's Drive ID. (required) |
| deploymentId: string, The deployment ID for this deployment. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request with deployment information to update an existing deployment. |
| "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. |
| "scriptId": "A String", # The script project's Drive ID. |
| "versionNumber": 42, # The version number on which this deployment is based. |
| "description": "A String", # The description for this deployment. |
| "manifestFileName": "A String", # The manifest file name for this deployment. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Representation of a single script deployment. |
| "entryPoints": [ # The deployment's entry points. |
| { # A configuration that defines how a deployment is accessed externally. |
| "webApp": { # A web application entry point. # An entry point specification for web apps. |
| "url": "A String", # The URL for the web application. |
| "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. |
| "executeAs": "A String", # Who to execute the web app as. |
| "access": "A String", # Who has permission to run the web app. |
| }, |
| }, |
| "addOn": { # An add-on entry point. # Add-on properties. |
| "description": "A String", # The add-on's optional description. |
| "postInstallTipUrl": "A String", # The add-on's required post install tip URL. |
| "helpUrl": "A String", # The add-on's optional help URL. |
| "addOnType": "A String", # The add-on's required list of supported container types. |
| "reportIssueUrl": "A String", # The add-on's optional report issue URL. |
| "title": "A String", # The add-on's required title. |
| }, |
| "entryPointType": "A String", # The type of the entry point. |
| "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. |
| "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. |
| "access": "A String", # Who has permission to run the API executable. |
| }, |
| }, |
| }, |
| ], |
| "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. |
| "scriptId": "A String", # The script project's Drive ID. |
| "versionNumber": 42, # The version number on which this deployment is based. |
| "description": "A String", # The description for this deployment. |
| "manifestFileName": "A String", # The manifest file name for this deployment. |
| }, |
| "deploymentId": "A String", # The deployment ID for this deployment. |
| "updateTime": "A String", # Last modified date time stamp. |
| }</pre> |
| </div> |
| |
| </body></html> |
