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 แต่ละรายการต้องไม่ซ้ำกันภายในลูกค้า 1 ราย การใช้ชื่อซ้ำจะทำให้เกิดข้อผิดพลาด 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

 อัปเดตสคีมา