PeopleSearchContactsOptions

import type { PeopleSearchContactsOptions } from "https://googleapis.deno.dev/v1/people:v1.ts";

Additional options for People#peopleSearchContacts.

interface PeopleSearchContactsOptions {

pageSize?: number;

query?: string;

readMask?: string;

sources?:

| "READ_SOURCE_TYPE_UNSPECIFIED"

| "READ_SOURCE_TYPE_PROFILE"

| "READ_SOURCE_TYPE_CONTACT"

| "READ_SOURCE_TYPE_DOMAIN_CONTACT"

| "READ_SOURCE_TYPE_OTHER_CONTACT";

}

§Properties

pageSize?: number

[src]

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.

query?: string

[src]

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".

readMask?: string

[src]

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

sources?: "READ_SOURCE_TYPE_UNSPECIFIED" | "READ_SOURCE_TYPE_PROFILE" | "READ_SOURCE_TYPE_CONTACT" | "READ_SOURCE_TYPE_DOMAIN_CONTACT" | "READ_SOURCE_TYPE_OTHER_CONTACT"

[src]

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