The "people" collection of methods. Typical usage is:
$peopleService = new Google_Service_PeopleService(...);
$people = $peopleService->people;
Methods summary
public
Google_Service_PeopleService_Person
|
#
createContact( Google_Service_PeopleService_Person $postBody, array $optParams = array() )
Create a new contact and return the person resource for that contact.
(people.createContact)
Create a new contact and return the person resource for that contact.
(people.createContact)
Parameters
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_PeopleService_PeopleEmpty
|
#
deleteContact( string $resourceName, array $optParams = array() )
Delete a contact person. Any non-contact data will not be deleted.
(people.deleteContact)
Delete a contact person. Any non-contact data will not be deleted.
(people.deleteContact)
Parameters
- $resourceName
- Required. The resource name of the contact to delete.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_PeopleService_DeleteContactPhotoResponse
|
#
deleteContactPhoto( string $resourceName, array $optParams = array() )
Delete a contact's photo. (people.deleteContactPhoto)
Delete a contact's photo. (people.deleteContactPhoto)
Parameters
- $resourceName
- Required. The resource name of the contact whose photo will be deleted.
- $optParams
- Optional parameters.
Returns
Opt_param
string personFields Optional. A field mask to restrict which fields on the
person are returned. Multiple fields can be specified by separating them with
commas. Defaults to empty if not set, which will skip the post mutate get. 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
|
public
Google_Service_PeopleService_Person
|
#
get( string $resourceName, array $optParams = array() )
Provides information about a person by specifying a resource name. Use
people/me to indicate the authenticated user.
Provides information about a person by specifying a resource name. Use
people/me to indicate the authenticated user.
The request throws a 400 error if 'personFields' is not specified.
(people.get)
Parameters
- $resourceName
- Required. The resource name of the person to provide information about. - To get
information about the authenticated user, specify <code>people/me</code>. - To
get information about a google account, specify
<code>people/{account_id}</code>. - To get information about a contact, specify
the resource name that identifies the contact as returned by <a
href="/people/api/rest/v1/people.connections/list"><code>people.connections.list</code></a>.
- $optParams
- Optional parameters.
Returns
Opt_param
string personFields Required. A field mask to restrict which fields on the
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 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.
|
public
Google_Service_PeopleService_GetPeopleResponse
|
#
getBatchGet( array $optParams = array() )
Provides information about a list of specific people by specifying a list of
requested resource names. Use people/me to indicate the
authenticated user.
Provides information about a list of specific people by specifying a list of
requested resource names. Use people/me to indicate the
authenticated user.
The request throws a 400 error if 'personFields' is not specified.
(people.getBatchGet)
Parameters
- $optParams
- Optional parameters.
Returns
Opt_param
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 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.
string resourceNames Required. The resource names of the people to provide
information about. - To get information about the authenticated user, specify
people/me. - To get information about a google account, specify
people/{account_id}. - To get information about a contact, specify
the resource name that identifies the contact as returned by people.connections.list.
You can include up to 50 resource names in one request.
|
public
Google_Service_PeopleService_Person
|
#
updateContact( string $resourceName, Google_Service_PeopleService_Person $postBody, array $optParams = array() )
Update contact data for an existing contact person. Any non-contact data will
not be modified.
Update contact data for an existing contact person. Any non-contact data will
not be modified.
The request throws a 400 error if updatePersonFields is not
specified.
The request throws a 400 error if person.metadata.sources is not
specified for the contact to be updated.
The request throws a 400 error with an error with reason
"failedPrecondition" if person.metadata.sources.etag
is different than the contact's etag, which indicates the contact has changed
since its data was read. Clients should get the latest person and re-apply their
updates to the latest person. (people.updateContact)
Parameters
- $resourceName
- The resource name for the person, assigned by the server. An ASCII string with a
max length of 27 characters, in the form of <code>people/{person_id}</code>.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
string updatePersonFields Required. A field mask to restrict which fields on the
person are updated. Multiple fields can be specified by separating them with
commas. All updated fields will be replaced. Valid values are: * addresses *
biographies * birthdays * emailAddresses * events * genders * imClients *
interests * locales * memberships * names * nicknames * occupations *
organizations * phoneNumbers * relations * residences * sipAddresses * urls *
userDefined
|
public
Google_Service_PeopleService_UpdateContactPhotoResponse
|
#
updateContactPhoto( string $resourceName, Google_Service_PeopleService_UpdateContactPhotoRequest $postBody, array $optParams = array() )
Update a contact's photo. (people.updateContactPhoto)
Update a contact's photo. (people.updateContactPhoto)
Parameters
- $resourceName
- Required. Person resource name
- $postBody
- $optParams
- Optional parameters.
Returns
|
Google_Service_PeopleService_People_Resource