PeopleListDirectoryPeopleOptions

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

Additional options for People#peopleListDirectoryPeople.

interface PeopleListDirectoryPeopleOptions {

mergeSources?: "DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED" | "DIRECTORY_MERGE_SOURCE_TYPE_CONTACT";

pageSize?: number;

pageToken?: string;

readMask?: string;

requestSyncToken?: boolean;

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

syncToken?: string;

}

§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 1000, 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 people.listDirectoryPeople must match the first call that provided the page token.

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

requestSyncToken?: boolean

[src]

Optional. Whether the response should return next_sync_token. It can be used to get incremental changes since the last request by setting it on the request sync_token. More details about sync behavior at people.listDirectoryPeople.

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

[src]

Required. Directory sources to return.

syncToken?: string

[src]

Optional. A sync token, received from a previous response next_sync_token Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to people.listDirectoryPeople must match the first call that provided the sync token. More details about sync behavior at people.listDirectoryPeople.