REST Resource: schemas

منبع: طرحواره

نوع منبع API. برای منابع Schema، این همیشه 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

تگ ET منبع

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

ETag میدان.

indexed

boolean

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

 یک طرحواره را به روز می کند.