REST Resource: schemas

Zasób: schemat

Typ zasobu interfejsu API. W przypadku zasobów schematu jest 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 powoduje wystąpienie błędu 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Lista pól w schemacie.
displayName

string

Wyświetlana nazwa schematu.
kind

string

To jest rodzaj tego zasobu.
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 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 o podwójnej precyzji.
  • EMAIL: adresy e-mail.
  • INT64: 64-bitowe wartości całkowite.
  • PHONE: numery telefonów.
  • STRING: ciągi znaków.
multiValued

boolean

Wartość logiczna określająca, czy jest to pole z wieloma wartościami. Domyślnie: false.
kind

string

rodzaj tego zasobu, W przypadku pól schematu ta wartość to zawsze admin#directory#schema#fieldspec.
etag

string

ETag pola.
indexed

boolean

Wartość logiczna określająca, czy pole jest zindeksowane, czy nie. 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 bez uprawnień administratora.

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

Akceptowane wartości:

  • ADMINS_AND_SELF: wartości widzą tylko administratorzy i powiązany użytkownik.
  • ALL_DOMAIN_USERS: każdy użytkownik w 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ść tego pola. Ma to na celu charakter poglądowy, a nie wymuszanie. Wartości spoza tego zakresu będą nadal indeksowane, ale wyszukiwanie może nie być tak wydajne.
numericIndexingSpec.maxValue

number

Maksymalna wartość w tym polu. Ma to na celu charakter poglądowy, a nie wymuszanie. 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 dla klienta.

patch

 Poprawia schemat.

update

 Aktualizuje schemat.