REST Resource: indexing.datasources.items

ทรัพยากร: รายการ

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

การแสดง JSON 
{
  "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)
}
ช่อง
name

string

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

นี่เป็นฟิลด์ที่ต้องระบุ ความยาวสูงสุดคือ 1536 อักขระ
acl

object (ItemAcl)

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

object (ItemMetadata)

ข้อมูลเมตา
structuredData

object (ItemStructuredData)

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

object (ItemContent)

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

string (bytes format)

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

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

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

สตริงที่เข้ารหัสแบบ Base64
status

object (ItemStatus)

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

string

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

string (bytes format)

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

สตริงที่เข้ารหัสแบบ Base64
itemType

enum (Item.ItemType)

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

ItemAcl

เข้าถึงข้อมูลรายการควบคุมการเข้าถึงสำหรับรายการ ดูข้อมูลเพิ่มเติมได้ที่ ACL ของแผนที่

การแสดง JSON 
{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}
ช่อง
inheritAclFrom

string

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

enum (ItemAcl.AclInheritanceType)

ตั้งค่าประเภทของกฎการเข้าถึงที่จะใช้เมื่อรายการรับค่า ACL มาจากระดับบน ควรตั้งค่านี้ควบคู่ไปกับช่อง inheritAclFrom เสมอ นอกจากนี้ เมื่อตั้งค่าช่อง inheritAclFrom ควรตั้งค่าช่องนี้เป็น AclInheritanceType ที่ถูกต้อง
readers[]

object (Principal)

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

object (Principal)

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

object (Principal)

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

ItemAcl.AclInheritanceType

ประเภทของการรับช่วงค่า ACL

Enum
NOT_APPLICABLE ค่าเริ่มต้นเมื่อรายการนี้ไม่ได้รับค่า ACL ใช้ NOT_APPLICABLE เมื่อ inheritAclFrom ว่างเปล่า รายการที่ไม่มีการรับช่วงค่า ACL ยังสามารถมี ACL ที่กำหนดโดยฟิลด์ readers และ deniedReaders ของตัวเอง
CHILD_OVERRIDE ในระหว่างที่มีข้อขัดแย้งในการให้สิทธิ์ ACL ของรายการย่อยจะกำหนดสิทธิ์การอ่าน
PARENT_OVERRIDE ในระหว่างที่มีข้อขัดแย้งในการให้สิทธิ์ ACL ของรายการหลักที่ระบุในช่อง inheritAclFrom จะกำหนดสิทธิ์การอ่าน
BOTH_PERMIT คุณจะมีสิทธิ์เข้าถึงต่อเมื่อรายการนี้และรายการหลักที่ระบุในช่อง inheritAclFrom อนุญาตทั้ง 2 รายการนี้

ผู้ใช้หลัก

การอ้างอิงถึงผู้ใช้ กลุ่ม หรือโดเมน

การแสดง JSON 
{

  // 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.
}
ช่อง

ฟิลด์การรวม principal

principal ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
gsuitePrincipal

object (GSuitePrincipal)

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

string

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

string

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

ItemMetadata

ช่องข้อมูลเมตาที่ใช้ได้สำหรับรายการ

การแสดง JSON 
{
  "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)
    }
  ]
}
ช่อง
title

string

ชื่อของสินค้า หากระบุ จะเป็นชื่อที่แสดงของผลการค้นหา ความยาวสูงสุดคือ 2048 อักขระ
sourceRepositoryUrl

string

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

string

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

string

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

string (Timestamp format)

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

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

string (Timestamp format)

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

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

object (Interaction)

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

string

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

string

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

object (SearchQualityMetadata)

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

string

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

string

ค่าการแฮชที่ระบุโดยตัวเรียกใช้ API กรณีนี้ใช้กับเมธอด items.push เพื่อคํานวณสถานะที่แก้ไขได้ ความยาวสูงสุดคือ 2048 อักขระ
contextAttributes[]

object (ContextAttribute)

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

การโต้ตอบ

หมายถึงการโต้ตอบระหว่างผู้ใช้กับรายการ

การแสดง JSON 
{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}
ช่อง
type

enum (Interaction.InteractionType)
principal

object (Principal)

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

string (Timestamp format)

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

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

Interaction.InteractionType

ประเภทกิจกรรมที่ผู้ใช้ทำกับรายการ

Enum
UNSPECIFIED ค่าไม่ถูกต้อง
VIEW การโต้ตอบนี้ระบุว่าผู้ใช้ดูรายการแล้ว
EDIT การโต้ตอบนี้บ่งชี้ว่าผู้ใช้แก้ไขรายการแล้ว

SearchQualityMetadata

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

การแสดง JSON 
{
  "quality": number
}
ช่อง
quality

number

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

ContextAttribute

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

การแสดง JSON 
{
  "name": string,
  "values": [
    string
  ]
}
ช่อง
name

string

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

string

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

ItemStructuredData

ช่องข้อมูลที่มีโครงสร้างที่ใช้ได้สำหรับรายการ

การแสดง JSON 
{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}
ช่อง
object

object (StructuredDataObject)

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

string

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

StructuredDataObject

ออบเจ็กต์ Structured Data ที่ประกอบด้วยพร็อพเพอร์ตี้ที่มีชื่อ

การแสดง JSON 
{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}
ช่อง
properties[]

object (NamedProperty)

พร็อพเพอร์ตี้ของออบเจ็กต์ จำนวนองค์ประกอบสูงสุดคือ 1,000

NamedProperty

คู่ชื่อ-ค่าที่พิมพ์สำหรับ Structured Data ประเภทของค่าควรเหมือนกับประเภทที่ลงทะเบียนไว้สำหรับพร็อพเพอร์ตี้ name ในคำจำกัดความออบเจ็กต์ของ objectType

การแสดง JSON 
{
  "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.
}
ช่อง
name

string

ชื่อของพร็อพเพอร์ตี้ ชื่อนี้ควรตรงกับชื่อพร็อพเพอร์ตี้ที่ลงทะเบียนไว้สำหรับการกำหนดออบเจ็กต์ในสคีมา ความยาวสูงสุดที่อนุญาตสำหรับพร็อพเพอร์ตี้นี้คือ 256 อักขระ
ฟิลด์การรวม value ค่าของพร็อพเพอร์ตี้ที่มีชื่อ โปรดทราบว่าพร็อพเพอร์ตี้จะเก็บค่าได้เพียงประเภทเดียวเท่านั้น value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
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)

NamedProperty.IntegerValues

รายการค่าจำนวนเต็ม

การแสดง JSON 
{
  "values": [
    string
  ]
}
ช่อง
values[]

string (int64 format)

NamedProperty.DoubleValues

รายการค่าทศนิยม

การแสดง JSON 
{
  "values": [
    number
  ]
}
ช่อง
values[]

number

NamedProperty.TimestampValues

รายการค่าการประทับเวลา

การแสดง JSON 
{
  "values": [
    string
  ]
}
ช่อง
values[]

string (Timestamp format)

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

NamedProperty.ObjectValues

รายการค่าของออบเจ็กต์

การแสดง JSON 
{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}
ช่อง
values[]

object (StructuredDataObject)

NamedProperty.EnumValues

รายการค่า enum

การแสดง JSON 
{
  "values": [
    string
  ]
}
ช่อง
values[]

string

ความยาวสูงสุดของค่าสตริงคือ 32 อักขระ

NamedProperty.DateValues

รายการค่าวันที่

การแสดง JSON 
{
  "values": [
    {
      object (Date)
    }
  ]
}
ช่อง
values[]

object (Date)

NamedProperty.TextValues

รายการค่าข้อความ

การแสดง JSON 
{
  "values": [
    string
  ]
}
ช่อง
values[]

string

ความยาวสูงสุดของค่าข้อความคือ 2,048 อักขระ

NamedProperty.HtmlValues

รายการค่า HTML

การแสดง JSON 
{
  "values": [
    string
  ]
}
ช่อง
values[]

string

ความยาวสูงสุดสำหรับค่า HTML คือ 2,048 อักขระ

ItemContent

เนื้อหาของรายการที่จะจัดทำดัชนีและแสดงโดย Cloud Search อนุญาตให้ใช้เฉพาะสตริงที่เข้ารหัส UTF-8 เป็น inlineContent หากอัปโหลดเนื้อหาไม่ใช่ไบนารี เนื้อหาดังกล่าวต้องเข้ารหัส UTF-8

การแสดง JSON 
{
  "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.
}
ช่อง
contentFormat

enum (ItemContent.ContentFormat)
hash

string

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

ฟิลด์การรวม content

content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
inlineContent

string (bytes format)

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

สตริงที่เข้ารหัสแบบ Base64
contentDataRef

object (UploadItemRef)

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

ItemContent.ContentFormat

รูปแบบของเนื้อหา หากรูปแบบเป็น RAW เนื้อหาควรอยู่ในรูปแบบที่ mimeType ระบุไว้

Enum
UNSPECIFIED ค่าไม่ถูกต้อง
HTML contentFormat คือ HTML
TEXT contentFormat คือข้อความอิสระ
RAW contentFormat เป็นไบต์ดิบ

UploadItemRef

แสดงการอ้างอิงเซสชันการอัปโหลด ข้อมูลอ้างอิงนี้สร้างผ่าน upload method ข้อมูลอ้างอิงนี้จะมีอายุ 30 วันนับจากวันที่สร้าง การอัปเดตเนื้อหารายการอาจหมายถึงเนื้อหาที่อัปโหลดนี้ผ่านทาง contentDataRef

การแสดง JSON 
{
  "name": string
}
ช่อง
name

string

ชื่อการอ้างอิงเนื้อหา ความยาวสูงสุดคือ 2048 อักขระ

ItemStatus

ซึ่งมีสถานะเป็นรายการและข้อผิดพลาด

การแสดง JSON 
{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}
ช่อง
code

enum (ItemStatus.Code)

รหัสสถานะ
processingErrors[]

object (ProcessingError)

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

object (RepositoryError)

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

ProcessingError

การแสดง JSON 
{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
ช่อง
code

enum (ProcessingErrorCode)

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

string

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

object (FieldViolation)

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

ProcessingErrorCode

รหัสสำหรับระบุข้อผิดพลาดที่พบระหว่างการประมวลผลรายการโดยเซิร์ฟเวอร์ Cloud Search รายการเดียวอาจมีข้อผิดพลาดในการประมวลผลหลายรายการ

Enum
PROCESSING_ERROR_CODE_UNSPECIFIED ค่าที่ป้อนเท่านั้น ใช้ค่านี้ในรายการ
MALFORMED_REQUEST ACL, ข้อมูลเมตา หรือเนื้อหาของรายการมีรูปแบบไม่ถูกต้องหรืออยู่ในสถานะที่ไม่ถูกต้อง
UNSUPPORTED_CONTENT_FORMAT ไม่รองรับรูปแบบการนับ
INDIRECT_BROKEN_ACL รายการที่มีข้อมูล ACL ที่ไม่สมบูรณ์เนื่องจากการรับช่วงรายการอื่นๆ ที่มี ACL ที่ไม่สมบูรณ์ หรือมีกลุ่มที่สืบทอดลงมาที่ไม่ได้แมป
ACL_CYCLE กราฟการรับช่วงค่า ACL ทำให้เกิดวงจร

FieldViolation

การแสดง JSON 
{
  "field": string,
  "description": string
}
ช่อง
field

string

เส้นทางฟิลด์ที่มีการละเมิด
description

string

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

RepositoryError

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

การแสดง JSON 
{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}
ช่อง
type

enum (RepositoryError.Type)

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

integer

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

string

ข้อความที่อธิบายข้อผิดพลาด ความยาวของข้อความสูงสุดที่อนุญาตคือ 8,192 อักขระ

RepositoryError.Type

รายการรหัสข้อผิดพลาดสำหรับการสื่อสารกับที่เก็บ

Enum
UNKNOWN ข้อผิดพลาดที่ไม่รู้จัก
NETWORK_ERROR โฮสต์ที่ไม่รู้จักหรือไม่สามารถเข้าถึงได้
DNS_ERROR ปัญหา DNS เช่น เซิร์ฟเวอร์ DNS ไม่ตอบสนอง
CONNECTION_ERROR เชื่อมต่อกับเซิร์ฟเวอร์ที่เก็บไม่ได้
AUTHENTICATION_ERROR ตรวจสอบสิทธิ์ไม่สำเร็จเนื่องจากข้อมูลเข้าสู่ระบบไม่ถูกต้อง
AUTHORIZATION_ERROR บัญชีบริการไม่ได้รับอนุญาตสำหรับที่เก็บ
SERVER_ERROR ข้อผิดพลาดของเซิร์ฟเวอร์ที่เก็บ
QUOTA_EXCEEDED เกินโควตา
SERVICE_UNAVAILABLE เซิร์ฟเวอร์ไม่พร้อมใช้งานชั่วคราว
CLIENT_ERROR ข้อผิดพลาดเกี่ยวกับไคลเอ็นต์ เช่น คำขอที่ไม่ถูกต้องจากเครื่องมือเชื่อมต่อไปยังเซิร์ฟเวอร์ที่เก็บ

Item.ItemType

Enum
UNSPECIFIED
CONTENT_ITEM รายการที่มีการจัดทําดัชนีเพื่อจุดประสงค์ในการแสดงข้อมูลเท่านั้น อ้างอิงรายการเหล่านี้ในช่อง containerName หรือ inheritAclFrom ไม่ได้
CONTAINER_ITEM รายการที่ได้รับการจัดทำดัชนีและมีวัตถุประสงค์เพื่อจัดหารายการอื่นๆ ที่มี ACL และ/หรือมีรายการอื่นๆ
VIRTUAL_CONTAINER_ITEM รายการที่ไม่ได้รับการจัดทำดัชนี แต่มีจุดประสงค์เหมือนกับ CONTAINER_ITEM

วิธีการ

delete

 ลบ Item resource สำหรับชื่อทรัพยากรที่ระบุ

deleteQueueItems

 ลบรายการทั้งหมดในคิว

get

 รับ Item resource ตามชื่อสินค้า

index

 อัปเดต ACL, ข้อมูลเมตา และเนื้อหา Item รายการ

list

 แสดงรายการทั้งหมดหรือบางส่วนของ Item resources

poll

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

push

 พุชรายการไปยังคิวเพื่ออัปเดตและการอัปเดตในภายหลัง

unreserve

 ยกเลิกการจองรายการทั้งหมดจากคิว ทำให้ทุกรายการมีสิทธิ์แสดงผล

upload

 สร้างเซสชันการอัปโหลดสำหรับการอัปโหลดเนื้อหารายการ