Documentation

Google_Service_Devprojects_Resource_Apis extends Google_Service_Resource
in package

The "apis" collection of methods.

Typical usage is: $devprojectsService = new Google_Service_Devprojects(...); $apis = $devprojectsService->apis;

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.
get()  : Google_Service_Devprojects_ApiData
Get the ApiData definition details for a given API. (apis.get)
listApis()  : Google_Service_Devprojects_ApisListResponse
Retrieves a list of resources, possibly filtered based on visibility settings related to the originator of the current end-user request. (apis.listApis)
listconsumed()  : Google_Service_Devprojects_ApisListConsumedResponse
List APIs consumed by a given project (apis.listconsumed)
listproduced()  : Google_Service_Devprojects_ApisListProducedResponse
List APIs produced by a given project (apis.listproduced)
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()

Get the ApiData definition details for a given API. (apis.get)

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

The resource 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

string projectId The numeric ID of the project for which to get the API definition. It has to be either the ID of the project producing the API or the ID of a project having the API available for consumption

opt_param

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

Return values
Google_Service_Devprojects_ApiData —

listApis()

Retrieves a list of resources, possibly filtered based on visibility settings related to the originator of the current end-user request. (apis.listApis)

public listApis([array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ApisListResponse
Parameters
$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

string projectId The numeric ID of the project for which to list APIs. If present the API definition list will include all the first-party APIs available to the current user as well as all the third party APIs produced on the specified project or made available for "consumption" to the current project - independently of their activation (enablement) status. If not present only first-party APIs available to the current user are returned.

opt_param

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

Return values
Google_Service_Devprojects_ApisListResponse —

listconsumed()

List APIs consumed by a given project (apis.listconsumed)

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

Optional parameters.

Tags
opt_param

string consumerProjectId The numeric ID of the project for which consumed APIs are listed

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

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

Return values
Google_Service_Devprojects_ApisListConsumedResponse —

listproduced()

List APIs produced by a given project (apis.listproduced)

public listproduced([array<string|int, mixed> $optParams = array() ]) : Google_Service_Devprojects_ApisListProducedResponse
Parameters
$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

string producerProjectId The producer project ID to list APIs for.

opt_param

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

Return values
Google_Service_Devprojects_ApisListProducedResponse —

convertToArrayAndStripNulls()

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

Search results