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

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

 อัปเดตสคีมา