Documentation

Google_Service_Script_Resource_ProjectsDeployments extends Google_Service_Resource
in package

The "deployments" collection of methods.

Typical usage is: $scriptService = new Google_Service_Script(...); $deployments = $scriptService->deployments;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Script_Deployment
Creates a deployment of an Apps Script project. (deployments.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Script_ScriptEmpty
Deletes a deployment of an Apps Script project. (deployments.delete)
get()  : Google_Service_Script_Deployment
Gets a deployment of an Apps Script project. (deployments.get)
listProjectsDeployments()  : Google_Service_Script_ListDeploymentsResponse
Lists the deployments of an Apps Script project.
update()  : Google_Service_Script_Deployment
Updates a deployment of an Apps Script project. (deployments.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a deployment of an Apps Script project. (deployments.create)

public create(string $scriptId, Google_Service_Script_DeploymentConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_Deployment
Parameters
$scriptId : string

The script project's Drive ID.

$postBody : Google_Service_Script_DeploymentConfig
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Script_Deployment

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes a deployment of an Apps Script project. (deployments.delete)

public delete(string $scriptId, string $deploymentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_ScriptEmpty
Parameters
$scriptId : string

The script project's Drive ID.

$deploymentId : string

The deployment ID to be undeployed.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Script_ScriptEmpty

get()

Gets a deployment of an Apps Script project. (deployments.get)

public get(string $scriptId, string $deploymentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_Deployment
Parameters
$scriptId : string

The script project's Drive ID.

$deploymentId : string

The deployment ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Script_Deployment

listProjectsDeployments()

Lists the deployments of an Apps Script project.

public listProjectsDeployments(string $scriptId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_ListDeploymentsResponse

(deployments.listProjectsDeployments)

Parameters
$scriptId : string

The script project's Drive ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken 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.

opt_param

int pageSize The maximum number of deployments on each returned page. Defaults to 50.

Return values
Google_Service_Script_ListDeploymentsResponse

update()

Updates a deployment of an Apps Script project. (deployments.update)

public update(string $scriptId, string $deploymentId, Google_Service_Script_UpdateDeploymentRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_Deployment
Parameters
$scriptId : string

The script project's Drive ID.

$deploymentId : string

The deployment ID for this deployment.

$postBody : Google_Service_Script_UpdateDeploymentRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Script_Deployment

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results