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
  • 연령대
  • 전기
  • 생일
  • 캘린더 URL
  • 고객 데이터
  • 표지사진
  • 이메일 주소
  • 이벤트
  • 외부 ID
  • 성별
  • imClient
  • 관심분야
  • locales
  • 위치
  • 멤버십
  • metadata
  • 기타 키워드
  • names
  • 닉네임
  • 직업
  • organizations
  • 전화번호
  • 포토
  • 관계
  • SIP주소
  • 기술
  • URL
  • 사용자 정의됨
sources[]

enum (ReadSourceType)

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

요청 본문

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

응답 본문

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

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

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/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

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