Documentation

Google_Service_Script_Resource_Projects extends Google_Service_Resource
in package

The "projects" collection of methods.

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

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_Project
Creates a new, empty script project with no script files and a base manifest file. (projects.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Script_Project
Gets a script project's metadata. (projects.get)
getContent()  : Google_Service_Script_Content
Gets the content of the script project, including the code source and metadata for each script file. (projects.getContent)
getMetrics()  : Google_Service_Script_Metrics
Get metrics data for scripts, such as number of executions and active users.
updateContent()  : Google_Service_Script_Content
Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.
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

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

get()

Gets a script project's metadata. (projects.get)

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

The script project's Drive ID.

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

Optional parameters.

Return values
Google_Service_Script_Project

getContent()

Gets the content of the script project, including the code source and metadata for each script file. (projects.getContent)

public getContent(string $scriptId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_Content
Parameters
$scriptId : string

The script project's Drive ID.

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

Optional parameters.

Tags
opt_param

int versionNumber The version number of the project to retrieve. If not provided, the project's HEAD version is returned.

Return values
Google_Service_Script_Content

getMetrics()

Get metrics data for scripts, such as number of executions and active users.

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

(projects.getMetrics)

Parameters
$scriptId : string

Required field indicating the script to get metrics for.

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

Optional parameters.

Tags
opt_param

string metricsGranularity Required field indicating what granularity of metrics are returned.

opt_param

string metricsFilter.deploymentId Optional field indicating a specific deployment to retrieve metrics from.

Return values
Google_Service_Script_Metrics

updateContent()

Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.

public updateContent(string $scriptId, Google_Service_Script_Content $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_Content

(projects.updateContent)

Parameters
$scriptId : string

The script project's Drive ID.

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

Optional parameters.

Return values
Google_Service_Script_Content

convertToArrayAndStripNulls()

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

Search results