REST Resource: schemas

리소스: 스키마

API 리소스의 유형입니다. 스키마 리소스의 경우 항상 admin#directory#schema입니다.

JSON 표현 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
필드
schemaId

string

스키마의 고유 식별자 (읽기 전용)
schemaName

string

스키마의 이름입니다.

각 schemaName은 고객 내에서 고유해야 합니다. 이름을 재사용하면 409: Entity already exists 오류가 발생합니다.
fields[]

object (SchemaFieldSpec)

스키마의 필드 목록입니다.
displayName

string

스키마의 표시 이름입니다.
kind

string

리소스의 유형입니다.
etag

string

리소스의 eETag입니다.

SchemaFieldSpec

스키마를 사용하여 사용자 프로필에 맞춤 입력란을 추가할 수 있습니다. 이 입력란을 사용하여 사용자가 작업 중인 프로젝트, 물리적 위치, 고용일 또는 비즈니스 니즈에 맞는 기타 정보와 같은 정보를 저장할 수 있습니다. 자세한 내용은 맞춤 사용자 입력란을 참조하세요.

JSON 표현 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
필드
fieldName

string

필드의 이름입니다.
fieldId

string

필드의 고유 식별자입니다 (읽기 전용).
fieldType

string

필드 유형입니다.

사용 가능한 값:

  • BOOL: 불리언 값입니다.
  • DATE: ISO-8601 형식의 날짜입니다.
  • DOUBLE: 배정밀도 부동 소수점 값입니다.
  • EMAIL: 이메일 주소입니다.
  • INT64: 64비트 정수 값.
  • PHONE: 전화번호입니다.
  • STRING: 문자열 값입니다.
multiValued

boolean

이 필드가 다중 값 필드인지 여부를 지정하는 불리언입니다. 기본값: false
kind

string

리소스의 종류입니다. 스키마 필드의 경우 항상 admin#directory#schema#fieldspec입니다.
etag

string

필드의 eETag입니다.
indexed

boolean

필드의 색인 생성 여부를 지정하는 부울입니다. 기본값: true
displayName

string

필드의 표시 이름입니다.
readAccessType

string

이 필드의 값을 볼 수 있는 사용자를 지정합니다. 자세한 내용은 관리자가 아닌 사용자로서 사용자 검색을 참고하세요.

참고: 이 입력란에 변경사항이 적용되려면 최대 24시간이 소요될 수 있습니다.

사용 가능한 값:

  • ADMINS_AND_SELF: 관리자 및 연결된 사용자만 값을 볼 수 있습니다.
  • ALL_DOMAIN_USERS: 도메인의 모든 사용자가 값을 볼 수 있습니다.
numericIndexingSpec

object

숫자 필드의 색인 생성 사양입니다. 기본적으로 숫자 필드에는 일치검색 쿼리만 지원됩니다. numericIndexingSpec를 설정하면 범위 쿼리를 지원할 수 있습니다.
numericIndexingSpec.minValue

number

이 필드의 최솟값입니다. 이는 강제되기보다는 지시하기 위한 것입니다. 이 범위를 벗어나는 값에는 계속 색인이 생성되지만 검색 성능이 떨어질 수 있습니다.
numericIndexingSpec.maxValue

number

이 필드의 최댓값입니다. 이는 강제되기보다는 지시하기 위한 것입니다. 이 범위를 벗어나는 값에는 계속 색인이 생성되지만 검색 성능이 떨어질 수 있습니다.

메서드

delete

 스키마를 삭제합니다.

get

 스키마를 검색합니다.

insert

 스키마를 생성합니다.

list

 고객의 모든 스키마를 검색합니다.

patch

 스키마를 패치합니다.

update

 스키마를 업데이트합니다.