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

ETag ресурса.

СхемаПолеСпец

Вы можете использовать схемы для добавления настраиваемых полей в профили пользователей. Вы можете использовать эти поля для хранения такой информации, как проекты, над которыми работают ваши пользователи, их физическое местоположение, даты приема на работу или что-то еще, соответствующее потребностям вашего бизнеса. Дополнительную информацию см. в разделе Пользовательские поля пользователя .

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

ETag поля.

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

 Обновляет схему.