Documentation

Google_Service_People_Resource_People extends Google_Service_Resource
in package

The "people" collection of methods.

Typical usage is: $peopleService = new Google_Service_People(...); $people = $peopleService->people;

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_People_Person
Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user. (people.get)
getBatchGet()  : Google_Service_People_GetPeopleResponse
Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.
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()

Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user. (people.get)

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

The resource name of the person to provide information about.

  • To get information about the authenticated user, specify people/me. - To get information about any user, specify the resource name that identifies the user, such as the resource names returned by people.connections.list.
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMask.includeField Comma-separated list of fields to be included in the response. Omitting this field will include all fields except for connections.list requests, which have a default mask that includes common fields like metadata, name, photo, and profile url. Each path should start with person.: for example, person.names or person.photos.

Return values
Google_Service_People_Person —

getBatchGet()

Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.

public getBatchGet([array<string|int, mixed> $optParams = array() ]) : Google_Service_People_GetPeopleResponse

(people.getBatchGet)

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

Optional parameters.

Tags
opt_param

string requestMask.includeField Comma-separated list of fields to be included in the response. Omitting this field will include all fields except for connections.list requests, which have a default mask that includes common fields like metadata, name, photo, and profile url. Each path should start with person.: for example, person.names or person.photos.

opt_param

string resourceNames The resource name, such as one returned by people.connections.list, of one of the people to provide information about. You can include this parameter up to 50 times in one request.

Return values
Google_Service_People_GetPeopleResponse —

convertToArrayAndStripNulls()

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

Search results