REST Resource: schemas

Zasób: Schemat

Typ zasobu interfejsu API. W przypadku zasobów schema zawsze jest to 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 identyfikator schemaName musi być unikalny w przypadku danego 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

Rodzaj zasobu.
etag

string

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 lub inne informacje odpowiadające Twoim potrzebom biznesowym. 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.

Akceptowane wartości:

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

boolean

Wartość logiczna określająca, czy jest to pole wielowartościowe. Domyślnie: false.
kind

string

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

string

ETag pola.
indexed

boolean

Wartość logiczna określająca, czy pole jest zindeksowane. Domyślnie: 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 inny niż administrator.

Uwaga: zanim zmiany w tym polu zaczną obowiązywać, może minąć do 24 godzin.

Akceptowane wartości:

  • ADMINS_AND_SELF: wartości są widoczne tylko dla administratorów i powiązanych użytkowników.
  • ALL_DOMAIN_USERS: wartości mogą widzieć wszyscy użytkownicy w Twojej domenie.
numericIndexingSpec

object

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

number

Minimalna wartość tego pola. Jest to wartość orientacyjna, a nie wymuszająca. Wartości spoza tego zakresu będą nadal indeksowane, ale wyszukiwanie może nie być tak skuteczne.
numericIndexingSpec.maxValue

number

Maksymalna wartość tego pola. Jest to wartość orientacyjna, a nie wymuszająca. Wartości spoza tego zakresu będą nadal indeksowane, ale wyszukiwanie może nie być tak wydajne.

Metody

delete

 Usuwa schemat.

get

 Pobiera schemat.

insert

 Tworzy schemat.

list

 Pobiera wszystkie schematy klienta.

patch

 Wprowadza poprawki w schemacie.

update

 Aktualizuje schemat.