ทรัพยากร: สคีมา
ประเภทของทรัพยากร API สำหรับทรัพยากรของสคีมา ค่านี้จะเป็น admin#directory#schema
เสมอ
การแสดง JSON |
---|
{
"schemaId": string,
"schemaName": string,
"fields": [
{
object ( |
ช่อง | |
---|---|
schemaId |
ตัวระบุที่ไม่ซ้ำกันของสคีมา (อ่านอย่างเดียว) |
schemaName |
ชื่อสคีมา
|
fields[] |
รายการช่องในสคีมา |
displayName |
ชื่อที่แสดงสำหรับสคีมา |
kind |
นี่แหละแหล่งข้อมูล |
etag |
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 |
ชื่อของช่อง |
fieldId |
ตัวระบุที่ไม่ซ้ำกันของช่อง (อ่านอย่างเดียว) |
fieldType |
ประเภทของฟิลด์ ค่าที่ยอมรับมีดังนี้
|
multiValued |
บูลีนที่ระบุว่านี่เป็นช่องที่มีหลายค่าหรือไม่ ค่าเริ่มต้น: |
kind |
ประเภทของทรัพยากรนี้คือ สำหรับช่องสคีมา ค่านี้จะเป็น |
etag |
ETag ของช่อง |
indexed |
บูลีนที่ระบุว่ามีการจัดทำดัชนีช่องหรือไม่ ค่าเริ่มต้น: |
displayName |
ชื่อที่แสดงของช่อง |
readAccessType |
ระบุผู้ที่สามารถดูค่าของช่องนี้ได้ โปรดดูข้อมูลเพิ่มเติมที่เรียกข้อมูลผู้ใช้ในฐานะที่ไม่ใช่ผู้ดูแลระบบ หมายเหตุ: การเปลี่ยนแปลงในช่องนี้อาจใช้เวลาถึง 24 ชั่วโมงจึงจะมีผล ค่าที่ยอมรับมีดังนี้
|
numericIndexingSpec |
ข้อกำหนดการจัดทำดัชนีสำหรับช่องตัวเลข โดยค่าเริ่มต้น ฟิลด์ตัวเลขจะสนับสนุนเฉพาะข้อความค้นหาที่ทำงานแบบตรงทั้งหมดเท่านั้น การตั้งค่า |
numericIndexingSpec.minValue |
ค่าต่ำสุดของช่องนี้ โดยมีวัตถุประสงค์เพื่อชี้แนะ ไม่ใช่บังคับใช้ ค่าที่อยู่นอกช่วงนี้จะยังคงได้รับการจัดทำดัชนี แต่การค้นหาอาจมีประสิทธิภาพไม่ดีเท่าที่ควร |
numericIndexingSpec.maxValue |
ค่าสูงสุดของช่องนี้ โดยมีวัตถุประสงค์เพื่อชี้แนะ ไม่ใช่บังคับใช้ ค่าที่อยู่นอกช่วงนี้จะยังคงได้รับการจัดทำดัชนี แต่การค้นหาอาจมีประสิทธิภาพไม่ดีเท่าที่ควร |
วิธีการ |
|
---|---|
|
ลบสคีมา |
|
เรียกสคีมา |
|
สร้างสคีมา |
|
เรียกข้อมูลสคีมาทั้งหมดสำหรับลูกค้า |
|
แพตช์สคีมา |
|
อัปเดตสคีมา |