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}

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

object (ItemAcl)

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

object (ItemMetadata)

ข้อมูลเมตา
structuredData

object (ItemStructuredData)

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

object (ItemContent)

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

string (bytes format)

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

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

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

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

object (ItemStatus)

สถานะของสินค้า ช่องเอาต์พุตเท่านั้น
queue

string

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

string (bytes format)

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

สตริงที่เข้ารหัส 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 ด้วย ความยาวสูงสุดของช่องนี้คือ 1,536 อักขระ
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 ทั้งคู่อนุญาตให้เข้าถึงระดับอ่าน

ผู้ใช้หลัก

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

การแสดง 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

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

string

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

string

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

string

ประเภทของสินค้า ซึ่งควรสอดคล้องกับชื่อของคําจํากัดความออบเจ็กต์ในสคีมาที่ลงทะเบียนสําหรับแหล่งข้อมูล เช่น หากสคีมาของแหล่งข้อมูลมีคำจำกัดความออบเจ็กต์ที่มีชื่อ "เอกสาร" คำขอการจัดทําดัชนีรายการสําหรับออบเจ็กต์ประเภทนั้นควรตั้งค่า objectType เป็น "เอกสาร" ความยาวสูงสุดคือ 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-type เดิมของ ItemContent.content ในที่เก็บต้นทาง ความยาวสูงสุดคือ 256 อักขระ
searchQualityMetadata

object (SearchQualityMetadata)

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

string

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

string

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

ช่อง Structured Data ที่พร้อมใช้งานสำหรับรายการ

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

object (StructuredDataObject)

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

string

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

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 เพื่อคํานวณสถานะที่แก้ไขแล้วได้ ความยาวสูงสุดคือ 2,048 อักขระ

ฟิลด์สหภาพ content

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

string (bytes format)

เนื้อหาที่ระบุไว้ภายในเมธอดการอัปเดต ความยาวสูงสุดคือ 102400 ไบต์ (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

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

ItemStatus

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

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

enum (ItemStatus.Code)

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

object (ProcessingError)

รายละเอียดข้อผิดพลาดในกรณีที่รายการอยู่ในสถานะ "ข้อผิดพลาด"
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, ข้อมูลเมตา หรือเนื้อหาของรายการมีรูปแบบไม่ถูกต้องหรืออยู่ในสถานะไม่ถูกต้อง FieldViolations มีรายละเอียดเพิ่มเติมเกี่ยวกับตําแหน่งที่เกิดปัญหา
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

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

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

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