REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

ชื่อของสินค้า รูปแบบ: แหล่งข้อมูล/{sourceId}/items/{itemId}

นี่เป็นฟิลด์ที่ต้องระบุ ซึ่งมีความยาวสูงสุด 1,536 อักขระ

object (ItemAcl)

รายการควบคุมการเข้าถึงสำหรับรายการนี้

object (ItemMetadata)

ข้อมูลเมตา

object (ItemStructuredData)

ข้อมูลที่มีโครงสร้างสำหรับรายการที่ควรสอดคล้องกับคำจำกัดความของออบเจ็กต์ที่ลงทะเบียนในสคีมาสำหรับแหล่งข้อมูล

object (ItemContent)

เนื้อหาของรายการที่จะทำดัชนีและกำหนดให้ค้นหาข้อความได้

string (bytes format)

ต้องระบุ ระบบจัดทำดัชนีจะจัดเก็บเวอร์ชันจากแหล่งข้อมูลเป็นสตริงไบต์ และเปรียบเทียบเวอร์ชันรายการในดัชนีกับเวอร์ชันของรายการที่อยู่ในคิวโดยใช้การจัดลำดับแบบพจนานุกรม

การจัดทำดัชนีของ Cloud Search จะไม่จัดทำดัชนีหรือลบรายการที่อยู่ในคิวซึ่งมีค่าเวอร์ชันน้อยกว่าหรือเท่ากับเวอร์ชันของรายการที่จัดทำดัชนีในปัจจุบัน ความยาวสูงสุดของช่องนี้คือ 1024 ไบต์

ดูข้อมูลเกี่ยวกับผลกระทบที่เวอร์ชันของรายการมีต่อกระบวนการลบได้ที่จัดการการแก้ไขหลังจากลบด้วยตนเอง

สตริงที่เข้ารหัสฐาน 64

object (ItemStatus)

สถานะของสินค้า ฟิลด์เอาต์พุตเท่านั้น

string

จัดคิวที่เป็นของรายการนี้ มีความยาวได้สูงสุดไม่เกิน 100 อักขระ

string (bytes format)

เครื่องมือเชื่อมต่อสถานะเพิ่มเติมจัดเก็บรายการนี้ได้ ความยาวสูงสุดคือ 10,000 ไบต์

สตริงที่เข้ารหัสฐาน 64

enum (Item.ItemType)

ประเภทของรายการนี้

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

ชื่อของรายการที่รับช่วงรายการสิทธิ์การเข้าถึง (ACL) หมายเหตุ: การรับช่วงค่า ACL เท่านั้นจะให้สิทธิ์การเข้าถึงรายการย่อยและไม่ได้กำหนดความสัมพันธ์เชิงโครงสร้าง และไม่ได้ให้วิธีที่สะดวกในการลบกลุ่มรายการขนาดใหญ่ การลบ ACL ระดับบนสุดออกจากดัชนีจะเปลี่ยนเฉพาะสิทธิ์การเข้าถึงของรายการย่อยที่อ้างอิงรายการระดับบนสุดในช่อง inheritAclFrom เท่านั้น รายการยังคงอยู่ในดัชนี แต่อาจไม่ปรากฏในผลการค้นหา ในทางตรงกันข้าม การลบรายการคอนเทนเนอร์จะลบรายการทั้งหมดที่อ้างอิงคอนเทนเนอร์ผ่านทางช่อง containerName ด้วย ความยาวสูงสุดของช่องนี้คือ 1,536 อักขระ

enum (ItemAcl.AclInheritanceType)

ตั้งค่าประเภทกฎการเข้าถึงที่จะใช้เมื่อรายการรับค่า ACL มาจากรายการหลัก ควรตั้งค่านี้ควบคู่กับฟิลด์ inheritAclFrom เสมอ นอกจากนี้ เมื่อตั้งค่าช่อง inheritAclFrom แล้ว ควรตั้งค่าช่องนี้เป็น AclInheritanceType ที่ถูกต้อง

object (Principal)

รายชื่อผู้ใช้หลักที่ได้รับอนุญาตให้ดูรายการนี้ในผลการค้นหา ไม่บังคับหากได้รับสิทธิ์มาจากรายการอื่นหรือไม่ใช่รายการโดยมีเจตนาที่จะแสดง เช่น virtual containers จำนวนองค์ประกอบสูงสุดคือ 1,000 รายการ

object (Principal)

รายชื่อผู้ใช้หลักที่ถูกปฏิเสธอย่างชัดแจ้งไม่ให้เข้าถึงรายการดังกล่าวในผลการค้นหา แม้ว่าผู้ใช้หลักจะถูกปฏิเสธการเข้าถึงโดยค่าเริ่มต้น แต่ให้ใช้ผู้อ่านที่ถูกปฏิเสธในการจัดการข้อยกเว้นและลบล้างผู้อ่านที่อนุญาตในรายการ จำนวนองค์ประกอบสูงสุดคือ 100 รายการ

object (Principal)

ไม่บังคับ รายชื่อเจ้าของรายการ ช่องนี้ไม่มีผลต่อสิทธิ์เข้าถึงเอกสาร อย่างไรก็ตาม การจัดอันดับเล็กน้อยจะกระตุ้นรายการที่ผู้ใช้ที่สอบถามเป็นเจ้าของ จำนวนองค์ประกอบสูงสุดคือ 5 รายการ

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object (GSuitePrincipal)

ผู้ใช้หลักรายนี้คือผู้ใช้ กลุ่ม หรือโดเมนของ Google Workspace

string

ผู้ใช้หลักรายนี้คือผู้ใช้ที่ระบุโดยใช้ข้อมูลประจำตัวภายนอก ช่องชื่อต้องระบุชื่อทรัพยากรผู้ใช้ในรูปแบบ: identitysources/{sourceId}/users/{ID}

string

ผู้ใช้หลักรายนี้คือกลุ่มที่ระบุโดยใช้ข้อมูลประจำตัวภายนอก ช่องชื่อต้องระบุชื่อทรัพยากรของกลุ่มในรูปแบบ: identitysources/{sourceId}/groups/{ID}

{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}

string

ชื่อของสินค้า หากระบุ ชื่อนี้จะเป็นชื่อที่แสดงของผลการค้นหา query.search โดยมีความยาวสูงสุดได้ 2,048 อักขระ

string

ลิงก์ไปยังที่เก็บต้นทางที่ให้บริการข้อมูล ผลการค้นหาใช้ลิงก์นี้กับชื่อ ช่องว่างหรือสัญลักษณ์พิเศษอาจทำให้ลิงก์ผลลัพธ์ของ Cloud Seach ทริกเกอร์การแจ้งเตือนการเปลี่ยนเส้นทาง เพื่อหลีกเลี่ยงปัญหานี้ ให้เข้ารหัส URL โดยมีความยาวสูงสุดได้ 2,048 อักขระ

string

ชื่อของคอนเทนเนอร์สำหรับรายการนี้ การลบรายการคอนเทนเนอร์จะนำไปสู่การลบรายการนี้โดยอัตโนมัติ หมายเหตุ: ACL จะไม่รับค่ามาจากรายการคอนเทนเนอร์ หากต้องการระบุการรับช่วงค่า ACL สำหรับรายการ ให้ใช้ช่อง inheritAclFrom ซึ่งมีความยาวสูงสุด 1,536 อักขระ

string

ประเภทของรายการ ข้อมูลนี้ควรตรงกับชื่อคำจำกัดความของออบเจ็กต์ในสคีมาที่ลงทะเบียนสำหรับแหล่งข้อมูล ตัวอย่างเช่น หากสคีมาของแหล่งข้อมูลมีคำจำกัดความของออบเจ็กต์ในชื่อ "document" คำขอการจัดทำดัชนีรายการสำหรับออบเจ็กต์ประเภทนั้นควรตั้งค่า objectType เป็น "document" มีความยาวได้สูงสุดไม่เกิน 256 อักขระ

string (Timestamp format)

เวลาที่สร้างรายการในที่เก็บต้นทาง

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

string (Timestamp format)

เวลาที่แก้ไขรายการครั้งล่าสุดในที่เก็บต้นทาง

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

object (Interaction)

รายการการโต้ตอบสำหรับรายการ ระบบจะใช้การโต้ตอบเพื่อปรับปรุงคุณภาพของ query.search แต่จะไม่แสดงต่อผู้ใช้ปลายทาง จำนวนองค์ประกอบสูงสุดคือ 1,000 รายการ

string

รหัสภาษา BCP-47 ของสินค้า เช่น "en-US" หรือ "sr-Latn" ดูข้อมูลเพิ่มเติมได้ที่ http://www.unicode.org/reports/tr35/#Unicode_locale_identifier มีความยาวได้สูงสุดไม่เกิน 32 อักขระ

string

ประเภท MIME ดั้งเดิมของ ItemContent.content ในที่เก็บต้นทาง มีความยาวได้สูงสุดไม่เกิน 256 อักขระ

object (SearchQualityMetadata)

ข้อมูลเมตาเกี่ยวกับคุณภาพการค้นหาเพิ่มเติมของรายการ

string

คีย์เวิร์ดหรือวลีเพิ่มเติมที่ควรตรงกับรายการ ใช้เป็นการภายในสำหรับเนื้อหาที่ผู้ใช้สร้างขึ้น จำนวนองค์ประกอบสูงสุดคือ 100 รายการ โดยมีความยาวสูงสุด 8,192 อักขระ

string

ค่าการแฮชที่ระบุโดยผู้เรียก API ซึ่งสามารถใช้ร่วมกับเมธอด items.push เพื่อคํานวณสถานะที่แก้ไข โดยมีความยาวสูงสุดได้ 2,048 อักขระ

object (ContextAttribute)

ชุดแอตทริบิวต์ที่มีชื่อซึ่งเชื่อมโยงกับสินค้า ซึ่งอาจใช้เพื่อให้มีผลต่อการจัดอันดับรายการตามบริบทในคำขอ จำนวนองค์ประกอบสูงสุดคือ 10 รายการ

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum (Interaction.InteractionType)

object (Principal)

ผู้ใช้ที่ดำเนินการกับรายการ

string (Timestamp format)

เวลาที่ผู้ใช้ดำเนินการกับสินค้า หากมีการดำเนินการประเภทเดียวกันหลายรายการสำหรับผู้ใช้รายเดียว ระบบจะบันทึกเฉพาะการดำเนินการล่าสุดเท่านั้น

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

{
  "quality": number
}

number

ตัวบ่งชี้คุณภาพของรายการ ซึ่งใช้เพื่อส่งผลต่อคุณภาพการค้นหา ค่าควรอยู่ระหว่าง 0.0 (คุณภาพต่ำสุด) และ 1.0 (คุณภาพสูงสุด) ค่าเริ่มต้นคือ 0.0

{
  "name": string,
  "values": [
    string
  ]
}

string

ชื่อของแอตทริบิวต์ ต้องระบุแอตทริบิวต์นี้ มีความยาวได้สูงสุดไม่เกิน 32 อักขระ ชื่อต้องขึ้นต้นด้วยตัวอักษรและมีได้เฉพาะตัวอักษร (A-Z, a-z) หรือตัวเลข (0-9) เท่านั้น ระบบจะปรับชื่อให้เป็นมาตรฐาน (ตัวพิมพ์เล็ก) ก่อนที่จะจับคู่

string

ค่าข้อความของแอตทริบิวต์ จำนวนองค์ประกอบสูงสุดคือ 10 รายการ ความยาวสูงสุดขององค์ประกอบในอาร์เรย์คือ 32 อักขระ ระบบจะแปลงค่าให้เป็นมาตรฐาน (ตัวพิมพ์เล็ก) ก่อนที่จะจับคู่

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object (StructuredDataObject)

ออบเจ็กต์ข้อมูลที่มีโครงสร้างซึ่งควรสอดคล้องกับคำจำกัดความของออบเจ็กต์ที่ลงทะเบียนในสคีมาสำหรับแหล่งข้อมูล

string

ค่าการแฮชที่ระบุโดยผู้เรียก API ซึ่งสามารถใช้ร่วมกับเมธอด items.push เพื่อคํานวณสถานะที่แก้ไข โดยมีความยาวสูงสุดได้ 2,048 อักขระ

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object (NamedProperty)

คุณสมบัติของออบเจ็กต์ จำนวนองค์ประกอบสูงสุดคือ 1,000 รายการ

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

ชื่อที่พัก ชื่อนี้ควรตรงกับชื่อพร็อพเพอร์ตี้ที่ลงทะเบียนไว้สำหรับการกำหนดออบเจ็กต์ในสคีมา ความยาวสูงสุดของพร็อพเพอร์ตี้นี้คือ 256 อักขระ

object (NamedProperty.IntegerValues)

object (NamedProperty.DoubleValues)

object (NamedProperty.TimestampValues)

boolean

object (NamedProperty.ObjectValues)

object (NamedProperty.EnumValues)

object (NamedProperty.DateValues)

object (NamedProperty.TextValues)

object (NamedProperty.HtmlValues)

{
  "values": [
    string
  ]
}

string (int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string (Timestamp format)

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

ความยาวสูงสุดที่อนุญาตสำหรับค่าสตริงคือ 32 อักขระ

{
  "values": [
    {
      object (Date)
    }
  ]
}

object (Date)

{
  "values": [
    string
  ]
}

string

ความยาวสูงสุดที่อนุญาตสำหรับค่าข้อความคือ 2,048 อักขระ

{
  "values": [
    string
  ]
}

string

ความยาวสูงสุดที่อนุญาตสำหรับค่า HTML คือ 2048 อักขระ

{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}

enum (ItemContent.ContentFormat)

string

ข้อมูลการแฮชที่คำนวณและระบุไว้โดยไคลเอ็นต์ API สำหรับเนื้อหา ใช้ได้กับเมธอด items.push เพื่อคำนวณสถานะที่แก้ไข โดยมีความยาวสูงสุดได้ 2,048 อักขระ

string (bytes format)

เนื้อหาที่ใส่ในบรรทัดภายในเมธอดการอัปเดต ความยาวสูงสุดคือ 102,400 ไบต์ (100 KiB)

สตริงที่เข้ารหัสฐาน 64

object (UploadItemRef)

อัปโหลดรหัสอ้างอิงของเนื้อหาที่อัปโหลดก่อนหน้านี้ผ่านวิธีการเขียน

{
  "name": string
}

string

ชื่อของการอ้างอิงเนื้อหา โดยมีความยาวสูงสุดได้ 2,048 อักขระ

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum (ItemStatus.Code)

รหัสสถานะ

object (ProcessingError)

รายละเอียดข้อผิดพลาดในกรณีที่รายการอยู่ในสถานะ ERROR

object (RepositoryError)

รายงานข้อผิดพลาดของที่เก็บโดยเครื่องมือเชื่อมต่อ

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum (ProcessingErrorCode)

รหัสข้อผิดพลาดที่ระบุลักษณะของข้อผิดพลาด

string

คำอธิบายข้อผิดพลาด

object (FieldViolation)

ในกรณีที่ช่องรายการไม่ถูกต้อง ช่องนี้จะมีรายละเอียดเกี่ยวกับข้อผิดพลาดในการตรวจสอบความถูกต้อง

{
  "field": string,
  "description": string
}

string

เส้นทางของช่องที่มีการละเมิด

string

คำอธิบายข้อผิดพลาด

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum (RepositoryError.Type)

ประเภทของข้อผิดพลาด

integer

รหัสข้อผิดพลาด ตรงกับคำจำกัดความของรหัสสถานะ HTTP

string

ข้อความที่อธิบายข้อผิดพลาด ความยาวสูงสุดของข้อความคือ 8192 อักขระ