PeopleSearchDirectoryPeopleOptions

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

Additional options for People#peopleSearchDirectoryPeople.

interface PeopleSearchDirectoryPeopleOptions {

mergeSources?: "DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED" | "DIRECTORY_MERGE_SOURCE_TYPE_CONTACT";

pageSize?: number;

pageToken?: string;

query?: string;

readMask?: string;

sources?: "DIRECTORY_SOURCE_TYPE_UNSPECIFIED" | "DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT" | "DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE";

}

§Properties

mergeSources?: "DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED" | "DIRECTORY_MERGE_SOURCE_TYPE_CONTACT"

[src]

Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.

pageSize?: number

[src]

Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.

pageToken?: string

[src]

Optional. A page token, received from a previous response next_page_token. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchDirectoryPeople must match the first call that provided the page token.

query?: string

[src]

Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.

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?: "DIRECTORY_SOURCE_TYPE_UNSPECIFIED" | "DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT" | "DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE"

[src]

Required. Directory sources to return.