Method: people.getBatchGet

요청된 리소스 이름 목록을 지정하여 특정 사용자 목록에 대한 정보를 제공합니다. people/me를 사용하여 인증된 사용자를 나타냅니다.

'personFields'가 지정되지 않은 경우 요청에서 400 오류가 반환됩니다.

HTTP 요청

GET https://people.googleapis.com/v1/people:batchGet

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
resourceNames[]

string

필수 항목입니다. 정보를 제공할 사용자의 리소스 이름입니다. 반복할 수 있습니다. URL 쿼리 매개변수는 다음과 같아야 합니다.

resourceNames=<name1>&resourceNames=<name2>&...

  • 인증된 사용자에 대한 정보를 가져오려면 people/me를 지정하세요.
  • Google 계정에 대한 정보를 가져오려면 people/{account_id}를 지정합니다.
  • 연락처에 대한 정보를 가져오려면 people.connections.list에서 반환된 연락처를 식별하는 리소스 이름을 지정합니다.

최대 200개의 리소스 이름을 사용할 수 있습니다.
requestMask
(deprecated)

object (RequestMask)

지원 중단됨 (대신 personFields 사용)

결과를 사용자 필드의 하위 집합으로 제한하는 마스크입니다.
personFields

string (FieldMask format)

필수 항목입니다. 각 사용자의 어떤 필드가 반환되는지를 제한하는 필드 마스크입니다. 여러 필드를 쉼표로 구분하여 지정할 수 있습니다. 유효한 값은 다음과 같습니다.

  • addresses
  • ageRanges
  • 전기
  • 생일
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 이벤트
  • externalIds
  • 성별
  • imClients
  • 관심분야
  • locales
  • 위치
  • 멤버십
  • 메타데이터
  • miscKeywords
  • 이름
  • 닉네임
  • 직업
  • organizations
  • phoneNumbers
  • 사진
  • 관계
  • sipAddresses
  • 기술
  • URL
  • userDefined
sources[]

enum (ReadSourceType)

선택사항입니다. 반환할 소스 유형의 마스크입니다. 설정하지 않으면 기본값은 READ_SOURCE_TYPE_CONTACT 및 READ_SOURCE_TYPE_PROFILE입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

리소스 이름별 사용자 목록 가져오기 요청에 대한 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
필드
responses[]

object (PersonResponse)

요청된 각 리소스 이름에 대한 응답입니다.

승인 범위

공개 데이터에 액세스하는 데 승인이 필요하지 않습니다. 비공개 데이터의 경우 다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile
  • https://www.googleapis.com/auth/profile.language.read

자세한 내용은 승인 가이드를 참고하세요.