Class PeopleResource.UpdateContactRequest
Update contact data for an existing contact person. Any non-contact data will not be modified. Any
non-contact data in the person to update will be ignored. All fields specified in the update_mask
will be
replaced. The server returns a 400 error if person.metadata.sources
is not specified for the contact to be
updated or if there is no contact source. The server returns a 400 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 merge their updates into the
latest person. The server returns a 400 error if memberships
are being updated and there are no contact
group memberships specified on the person. The server returns a 400 error if more than one field is
specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names
Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Inheritance
Inherited Members
Namespace: Google.Apis.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class PeopleResource.UpdateContactRequest : PeopleServiceBaseServiceRequest<Person>, IClientServiceRequest<Person>, IClientServiceRequest
Constructors
UpdateContactRequest(IClientService, Person, string)
Constructs a new UpdateContact request.
Declaration
public UpdateContactRequest(IClientService service, Person body, string resourceName)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
Person | body | |
string | resourceName |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PersonFields
Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
Declaration
[RequestParameter("personFields", RequestParameterType.Query)]
public virtual object PersonFields { get; set; }
Property Value
Type | Description |
---|---|
object |
ResourceName
The resource name for the person, assigned by the server. An ASCII string in the form of
people/{person_id}
.
Declaration
[RequestParameter("resourceName", RequestParameterType.Path)]
public virtual string ResourceName { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Sources
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual PeopleResource.UpdateContactRequest.SourcesEnum? Sources { get; set; }
Property Value
Type | Description |
---|---|
PeopleResource.UpdateContactRequest.SourcesEnum? |
Remarks
Use this property to set a single value for the parameter, or SourcesList to set multiple values. Do not set both properties.
SourcesList
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual Repeatable<PeopleResource.UpdateContactRequest.SourcesEnum> SourcesList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<PeopleResource.UpdateContactRequest.SourcesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and Sources.
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 * calendarUrls * clientData * emailAddresses * events * externalIds
- genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames
- occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined
Declaration
[RequestParameter("updatePersonFields", RequestParameterType.Query)]
public virtual object UpdatePersonFields { get; set; }
Property Value
Type | Description |
---|---|
object |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes UpdateContact parameter list.
Declaration
protected override void InitParameters()