getBatchGet method

Future<GetPeopleResponse> getBatchGet({ String? personFields, String? requestMask_includeField, List<String>? resourceNames, List<String>? sources, String? $fields, })

Provides information about a list of specific people by specifying a list of requested resource names.

Use people/me to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.

Request parameters:

personFields - 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 - 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 - Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1>&resourceNames=<name2>&... - 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 - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GetPeopleResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GetPeopleResponse> getBatchGet({
  core.String? personFields,
  core.String? requestMask_includeField,
  core.List<core.String>? resourceNames,
  core.List<core.String>? sources,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (personFields != null) 'personFields': [personFields],
    if (requestMask_includeField != null)
      'requestMask.includeField': [requestMask_includeField],
    if (resourceNames != null) 'resourceNames': resourceNames,
    if (sources != null) 'sources': sources,
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/people:batchGet';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GetPeopleResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}