REST Resource: schemas

Zasób: Schema

Typ zasobu interfejsu API. W przypadku zasobów schematu to zawsze admin#directory#schema.

Zapis JSON 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Pola
schemaId

string

Unikalny identyfikator schematu (tylko do odczytu).
schemaName

string

Nazwa schematu.

Każdy element schemaName musi być unikalny w obrębie klienta. Ponowne użycie nazwy spowoduje błąd 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Lista pól w schemacie.
displayName

string

Wyświetlana nazwa schematu.
kind

string

To pewnego rodzaju zasób.
etag

string

Wartość ETag zasobu.

SchemaFieldSpec

Za pomocą schematów możesz dodawać pola niestandardowe do profili użytkowników. W tych polach możesz przechowywać takie informacje, jak projekty, nad którymi pracują Twoi użytkownicy, ich lokalizacje, daty zatrudnienia i inne informacje, które pasują do Twoich potrzeb biznesowych. Więcej informacji znajdziesz w artykule Niestandardowe pola użytkowników.

Zapis JSON 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
Pola
fieldName

string

Nazwa pola.
fieldId

string

unikalny identyfikator pola (tylko do odczytu),
fieldType

string

Typ pola.

Dopuszczalne wartości:

  • BOOL: wartości logiczne.
  • DATE: daty w formacie ISO-8601.
  • DOUBLE: wartości zmiennoprzecinkowe o podwójnej precyzji.
  • EMAIL: adresy e-mail.
  • INT64: 64-bitowe wartości całkowite.
  • PHONE: numery telefonów.
  • STRING: wartości tekstowe.
multiValued

boolean

Wartość logiczna określająca, czy jest to pole o wielu wartościach, czy nie. Wartość domyślna: false.
kind

string

Rodzaj tego zasobu. W przypadku pól schematu jest to zawsze admin#directory#schema#fieldspec.
etag

string

Wartość ETag pola.
indexed

boolean

Wartość logiczna określająca, czy pole jest zindeksowane. Wartość domyślna: true.
displayName

string

Wyświetlana nazwa pola.
readAccessType

string

Określa, kto może wyświetlać wartości tego pola. Więcej informacji znajdziesz w artykule Pobieranie użytkowników jako użytkownik bez uprawnień administratora.

Uwaga: odzwierciedlenie zmian w tym polu może potrwać do 24 godzin.

Dopuszczalne wartości:

  • ADMINS_AND_SELF: tylko administratorzy i powiązany użytkownik mogą zobaczyć wartości.
  • ALL_DOMAIN_USERS: każdy użytkownik w Twojej domenie może zobaczyć wartości.
numericIndexingSpec

object

Specyfikacja indeksowania pola liczbowego. Domyślnie w przypadku pól liczbowych obsługiwane są tylko zapytania w dopasowaniu ścisłym. Ustawienie numericIndexingSpec umożliwia obsługę zapytań dotyczących zakresów.
numericIndexingSpec.minValue

number

Minimalna wartość w tym polu. Ta funkcja ma charakter orientacyjny, a nie egzekwowana. Wartości spoza tego zakresu nadal będą indeksowane, ale wyniki wyszukiwania mogą być mniej skuteczne.
numericIndexingSpec.maxValue

number

Maksymalna wartość tego pola. Ta funkcja ma charakter orientacyjny, a nie egzekwowana. Wartości spoza tego zakresu nadal będą indeksowane, ale wyniki wyszukiwania mogą być mniej skuteczne.

Metody

delete

 Usuwa schemat.

get

 Pobiera schemat.

insert

 Tworzy schemat.

list

 Pobiera wszystkie schematy klienta.

patch

 Poprawia schemat.

update

 Aktualizuje schemat.