PeopleGetBatchGetOptions

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

Additional options for People#peopleGetBatchGet.

interface PeopleGetBatchGetOptions {

personFields?: string;

[requestMask.includeField]?: string;

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

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.

resourceNames?: string

[src]

Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&resourceNames=&... - To get information about the authenticated user, specify people/me. - To get information about a google account, specify people/{account_id}. - To get information about a contact, specify the resource name that identifies the contact as returned by people.connections.list. There is a maximum of 200 resource names.

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.