PeopleConnectionsListOptions

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

Additional options for People#peopleConnectionsList.

interface PeopleConnectionsListOptions {

pageSize?: number;

pageToken?: string;

personFields?: string;

[requestMask.includeField]?: string;

requestSyncToken?: boolean;

sortOrder?:

| "LAST_MODIFIED_ASCENDING"

| "LAST_MODIFIED_DESCENDING"

| "FIRST_NAME_ASCENDING"

| "LAST_NAME_ASCENDING";

sources?:

| "READ_SOURCE_TYPE_UNSPECIFIED"

| "READ_SOURCE_TYPE_PROFILE"

| "READ_SOURCE_TYPE_CONTACT"

| "READ_SOURCE_TYPE_DOMAIN_CONTACT"

| "READ_SOURCE_TYPE_OTHER_CONTACT";

syncToken?: string;

}

§Properties

pageSize?: number

[src]

Optional. The number of connections 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.connections.list must match the first call that provided the page token.

personFields?: 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

[requestMask.includeField]?: string

[src]

Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person.photos.

requestSyncToken?: boolean

[src]

Optional. Whether the response should return next_sync_token on the last page of results. 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.connections.list.

sortOrder?: "LAST_MODIFIED_ASCENDING" | "LAST_MODIFIED_DESCENDING" | "FIRST_NAME_ASCENDING" | "LAST_NAME_ASCENDING"

[src]

Optional. The order in which the connections should be sorted. Defaults to LAST_MODIFIED_ASCENDING.

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 and READ_SOURCE_TYPE_PROFILE if not set.

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.connections.list must match the first call that provided the sync token. More details about sync behavior at people.connections.list.