Class PeopleResource.SearchContactsRequest

Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's names, nickNames, emailAddresses, phoneNumbers, and organizations fields that are from the CONTACT source. IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchResponse>
PeopleServiceBaseServiceRequest<SearchResponse>
PeopleResource.SearchContactsRequest
Implements
Inherited Members
Namespace: Google.Apis.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class PeopleResource.SearchContactsRequest : PeopleServiceBaseServiceRequest<SearchResponse>, IClientServiceRequest<SearchResponse>, IClientServiceRequest

Constructors

SearchContactsRequest(IClientService)

Constructs a new SearchContacts request.

Declaration
public SearchContactsRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.SearchResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.SearchResponse>.MethodName

PageSize

Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

Query

Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

ReadMask

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 * 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("readMask", RequestParameterType.Query)]
public virtual object ReadMask { get; set; }
Property Value
Type Description
object

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.SearchResponse>.RestPath

Sources

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual PeopleResource.SearchContactsRequest.SourcesEnum? Sources { get; set; }
Property Value
Type Description
PeopleResource.SearchContactsRequest.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 if not set.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual Repeatable<PeopleResource.SearchContactsRequest.SourcesEnum> SourcesList { get; set; }
Property Value
Type Description
Repeatable<PeopleResource.SearchContactsRequest.SourcesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Sources.

Methods

InitParameters()

Initializes SearchContacts parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements