Documentation

Google_Service_Devprojects_Resource_Projects extends Google_Service_Resource
in package

The "projects" collection of methods.

Typical usage is: $devprojectsService = new Google_Service_Devprojects(...); $projects = $devprojectsService->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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a resource. (projects.delete)
developerkeytoprojectid()  : Google_Service_Devprojects_ProjectsDeveloperKeyToProjectIdResponse
Converts a developer key into a project id.
get()  : Google_Service_Devprojects_ProjectData
Get a project. (projects.get)
getprojectclientstructure()  : Google_Service_Devprojects_ProjectsGetProjectClientStructureResponse
Obtain the structure of clients within the project for use in abuse control and takedowns. (projects.getprojectclientstructure)
insert()  : Google_Service_Devprojects_ProjectData
Create a new project. Note that only the base data of a project will be transferred. Everything else needs to go through an update request.
listProjects()  : Google_Service_Devprojects_ProjectsListResponse
Query projects (projects.listProjects)
notifyowners()  : Google_Service_Devprojects_ProjectsNotifyOwnersResponse
Uses DevConsole notification endpoint to notify project owners of important events, such as quota breaching. Currently only supports emailing the users of a project who fill the OWNER role, though there's been talk of adding support for other notification formats as well. (projects.notifyowners)
patch()  : Google_Service_Devprojects_ProjectData
Update a project. This method supports patch semantics. (projects.patch)
stringidtonumericid()  : Google_Service_Devprojects_ProjectsStringIdToNumericIdResponse
Looks-up a project specified via a string ID in app-engine app ID form and if found returns its numeric ID. Note: in the case of Dasher-based projects the string ID is in the form "domain:appId" (e.g., "google.com:cohesive- bonbon-301") If the lookup fails a PROJECT_NOT_FOUND error is returned.
undelete()  : mixed
Undelete a project (projects.undelete)
update()  : Google_Service_Devprojects_ProjectData
Update a project. (projects.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 —

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 resource. (projects.delete)

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

The Devconsole project ID.

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

Optional parameters.

Tags
opt_param

bool disableAuthorizationCheck If set to true, authorization checks will be disabled for this request. This field is intended to be used as part of rolling out IAM authorization checks in the CRM Projects API. Initially, we will perform IAM authorization checks in the Projects API, but ignore the result and simply log differences between IAM and DevConsole authorization checks. Once we have confidence in IAM, we will enforce the IAM check authorization checks and use this field to disable authorization checking in DevConsole.

opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
mixed —

developerkeytoprojectid()

Converts a developer key into a project id.

public developerkeytoprojectid(string $developerKey[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectsDeveloperKeyToProjectIdResponse

(projects.developerkeytoprojectid)

Parameters
$developerKey : string

The developer key

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

Optional parameters.

Tags
opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectsDeveloperKeyToProjectIdResponse —

get()

Get a project. (projects.get)

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

The Devconsole project ID.

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

Optional parameters.

Tags
opt_param

string locale The language code, country code and locale variant encoded as a single string. This is intended to be the locale for the end user, and hence the target of translations. Presence of the language code indicates that the response should include translation strings for the requested sections, as appropriate.

opt_param

bool retrieveCurrentUserRole Whether to also retrieve the role of the user for which the project is currently fetched

opt_param

string section The list of sections that should be returned. By default, the API will only prefill the basic project data, since loading a project in its entirety can take relatively long and is often not needed.

opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectData —

getprojectclientstructure()

Obtain the structure of clients within the project for use in abuse control and takedowns. (projects.getprojectclientstructure)

public getprojectclientstructure(Google_Service_Devprojects_ProjectsGetProjectClientStructureRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectsGetProjectClientStructureResponse
Parameters
$postBody : Google_Service_Devprojects_ProjectsGetProjectClientStructureRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Devprojects_ProjectsGetProjectClientStructureResponse —

insert()

Create a new project. Note that only the base data of a project will be transferred. Everything else needs to go through an update request.

public insert(Google_Service_Devprojects_ProjectData $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectData

(projects.insert)

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

Optional parameters.

Tags
opt_param

string initialOwner Gaia id of the initial project owner. Currently,this should always be provided, but that might change in the future.

opt_param

bool retryRequest Set to true to indicate that this is a retry request

opt_param

string section The list of sections that should be created.

opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectData —

listProjects()

Query projects (projects.listProjects)

public listProjects([array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectsListResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string fillSection Return projects with the following sections included if possible.

opt_param

bool includeNonActive Whether also non-active projects should be included in results

opt_param

string includedShard If this list is nonempty, projects are only returned if they contain some shard in the list. If the list is empty, no filtering occurs

opt_param

string requiredApiId Return only projects that have all the given APIs active

opt_param

string requiredSection Return only projects that have all the given sections

opt_param

bool retrieveCurrentUserRole Whether to also retrieve the role of the user for which projects are currently listed

opt_param

string user Return only projects that the given user has access to. For now, this is always required. Later, this will be required for LOAS based access only, and we can infer the user from the access control. As such the user will need to be a team member of the project. Also the user might be logged as the initiator of the update.

opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectsListResponse —

notifyowners()

Uses DevConsole notification endpoint to notify project owners of important events, such as quota breaching. Currently only supports emailing the users of a project who fill the OWNER role, though there's been talk of adding support for other notification formats as well. (projects.notifyowners)

public notifyowners(string $projectsId, Google_Service_Devprojects_ProjectsNotifyOwnersRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectsNotifyOwnersResponse
Parameters
$projectsId : string

The resource ID.

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

Optional parameters.

Tags
opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectsNotifyOwnersResponse —

patch()

Update a project. This method supports patch semantics. (projects.patch)

public patch(string $projectId, Google_Service_Devprojects_ProjectData $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectData
Parameters
$projectId : string

The Devconsole project ID.

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

Optional parameters.

Tags
opt_param

string section The list of sections that should be updated. Any parts of the project entity that are not listed here will not be considered for updates.

opt_param

string user If specified, the user to check accepted TOSes against. This is needed when an update (e.g., enabling the BigStore Apiary API requires the user to accept a specific ToS. In the future the nuser could be inferred from the access control.

opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectData —

stringidtonumericid()

Looks-up a project specified via a string ID in app-engine app ID form and if found returns its numeric ID. Note: in the case of Dasher-based projects the string ID is in the form "domain:appId" (e.g., "google.com:cohesive- bonbon-301") If the lookup fails a PROJECT_NOT_FOUND error is returned.

public stringidtonumericid(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectsStringIdToNumericIdResponse

(projects.stringidtonumericid)

Parameters
$project : string

The string project id to lookup

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

Optional parameters.

Tags
opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectsStringIdToNumericIdResponse —

undelete()

Undelete a project (projects.undelete)

public undelete(string $projectId, Google_Service_Devprojects_ProjectsUndeleteRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$projectId : string

The resource ID.

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

Optional parameters.

Tags
opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
mixed —

update()

Update a project. (projects.update)

public update(string $projectId, Google_Service_Devprojects_ProjectData $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ProjectData
Parameters
$projectId : string

The Devconsole project ID.

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

Optional parameters.

Tags
opt_param

string section The list of sections that should be updated. Any parts of the project entity that are not listed here will not be considered for updates.

opt_param

string user If specified, the user to check accepted TOSes against. This is needed when an update (e.g., enabling the BigStore Apiary API requires the user to accept a specific ToS. In the future the nuser could be inferred from the access control.

opt_param

string whitelistId The whitelist project ID. See Projects.Insert.whitelist_id documentation for details.

Return values
Google_Service_Devprojects_ProjectData —

convertToArrayAndStripNulls()

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

Search results