Class Google_Service_PeopleService_PeopleConnections_Resource
The "connections" collection of methods. Typical usage is:
$peopleService = new Google_Service_PeopleService(...);
$connections = $peopleService->connections;
-
Google_Service_Resource
-
Google_Service_PeopleService_PeopleConnections_Resource
Located at PeopleService.php
Methods summary
public
Google_Service_PeopleService_ListConnectionsResponse
|
#
listPeopleConnections( string $resourceName, array $optParams = array() )
Provides a list of the authenticated user's contacts merged with any
connected profiles.
Provides a list of the authenticated user's contacts merged with any
connected profiles.
The request throws a 400 error if 'personFields' is not specified.
(connections.listPeopleConnections)
Parameters
- $resourceName
- Required. The resource name to return connections for. Only
<code>people/me</code> is valid.
- $optParams
- Optional parameters.
Returns
Opt_param
string syncToken Optional. A sync token, received from a previous
ListConnections call. Provide this to retrieve only the resources
changed since the last request. Sync requests that specify
sync_token have an additional rate limit. When syncing, all other
parameters provided to ListConnections must match the call that
provided the sync token.
string personFields Required. A field mask to restrict which fields on each
person are returned. Multiple fields can be specified by separating them with
commas. Valid values are: * addresses * ageRanges * biographies * birthdays *
braggingRights * coverPhotos * emailAddresses * events * genders * imClients *
interests * locales * memberships * metadata * names * nicknames * occupations *
organizations * phoneNumbers * photos * relations * relationshipInterests *
relationshipStatuses * residences * sipAddresses * skills * taglines * urls *
userDefined
string sortOrder Optional. The order in which the connections should be sorted.
Defaults to LAST_MODIFIED_ASCENDING .
bool requestSyncToken Optional. Whether the response should include
next_sync_token , which can be used to get all changes since the
last request. For subsequent sync requests use the sync_token param
instead. Initial sync requests that specify request_sync_token have
an additional rate limit.
string pageToken Optional. A page token, received from a previous
ListConnections call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListConnections
must match the call that provided the page token.
int pageSize Optional. The number of connections to include in the response.
Valid values are between 1 and 2000, inclusive. Defaults to 100 if not set or
set to 0.
string requestMask.includeField Required. Comma-separated list of person fields
to be included in the response. Each path should start with
person. : for example, person.names or
person.photos .
|