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 ของทรัพยากร

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

บูลีนที่ระบุว่ามีการจัดทําดัชนีช่องหรือไม่ ค่าเริ่มต้น: 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

 อัปเดตสคีมา