Schema

คําจํากัดความของสคีมาสําหรับแหล่งข้อมูล

การแสดง JSON 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
ช่อง
objectDefinitions[]

object (ObjectDefinition)

รายการออบเจ็กต์ระดับบนสุดของแหล่งข้อมูล จำนวนองค์ประกอบสูงสุดคือ 10 รายการ
operationIds[]

string

รหัสของการดำเนินการที่ใช้เวลานาน (LROs) ที่ทำงานอยู่สําหรับสคีมานี้ หลังจากแก้ไขสคีมาแล้ว ให้รอให้การดำเนินการเสร็จสมบูรณ์ก่อนจึงจะจัดทำดัชนีเนื้อหาเพิ่มเติมได้

ObjectDefinition

คําจํากัดความสําหรับออบเจ็กต์ภายในแหล่งข้อมูล

การแสดง JSON 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
ช่อง
name

string

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

object (ObjectOptions)

ตัวเลือกเฉพาะวัตถุที่ไม่บังคับ
propertyDefinitions[]

object (PropertyDefinition)

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

ObjectOptions

ตัวเลือกสำหรับออบเจ็กต์

การแสดง JSON 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
ช่อง
freshnessOptions

object (ObjectOptions.FreshnessOptions)

ตัวเลือกความใหม่สำหรับออบเจ็กต์
displayOptions

object (ObjectDisplayOptions)

ตัวเลือกที่กำหนดลักษณะที่วัตถุจะแสดงในหน้าผลการค้นหาของ Cloud Search
suggestionFilteringOperators[]

string

โอเปอเรเตอร์ที่ใช้กรองคำแนะนำได้ สําหรับ query.suggest API เฉพาะผู้ให้บริการที่ระบุไว้ที่นี่เท่านั้นที่จะได้รับการยอมรับใน FilterOptions รองรับเฉพาะโอเปอเรเตอร์ TEXT และ ENUM

หมายเหตุ: ระบบรองรับ "objecttype", "type" และ "mimetype" อยู่แล้ว พร็อพเพอร์ตี้นี้มีไว้สําหรับกําหนดค่าโอเปอเรเตอร์เฉพาะสคีมา

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

ระบบไม่รองรับโอเปอเรเตอร์ที่แมปกับพร็อพเพอร์ตี้หลายรายการภายในออบเจ็กต์เดียวกัน หากโอเปอเรเตอร์ครอบคลุมออบเจ็กต์ประเภทต่างๆ คุณต้องตั้งค่าตัวเลือกนี้ 1 ครั้งสําหรับคําจํากัดความออบเจ็กต์แต่ละรายการ

ObjectOptions.FreshnessOptions

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

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

string

พร็อพเพอร์ตี้นี้ระบุระดับความใหม่ของออบเจ็กต์ในดัชนี หากมีการตั้งค่าแล้ว พร็อพเพอร์ตี้นี้ต้องเป็นพร็อพเพอร์ตี้ระดับบนสุดภายใน property definitions และต้องเป็น timestamp type หรือ date type มิเช่นนั้น Indexing API จะใช้ updateTime เป็นตัวบ่งชี้ความใหม่ ความยาวสูงสุดคือ 256 อักขระ

เมื่อใช้พร็อพเพอร์ตี้ในการคำนวณความใหม่ ค่าเริ่มต้นจะเป็น 2 ปีนับจากปัจจุบัน
freshnessDuration

string (Duration format)

ระยะเวลาที่ควรถือว่าออบเจ็กต์ล้าสมัย ค่าเริ่มต้นคือ 180 วัน (เป็นวินาที)

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย s เช่น "3.5s"

ObjectDisplayOptions

ตัวเลือกการแสดงผลของวัตถุ

การแสดง JSON 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
ช่อง
objectDisplayLabel

string

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

object (ObjectDisplayOptions.Metaline)

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

ObjectDisplayOptions.Metaline

เมตาบรรทัดคือรายการพร็อพเพอร์ตี้ที่แสดงพร้อมกับผลการค้นหาเพื่อให้บริบท

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

object (ObjectDisplayOptions.DisplayedProperty)

รายการพร็อพเพอร์ตี้ที่แสดงสําหรับเมตาไลน์ จำนวนพร็อพเพอร์ตี้สูงสุดคือ 5 รายการ

ObjectDisplayOptions.DisplayedProperty

การอ้างอิงพร็อพเพอร์ตี้ระดับบนสุดภายในออบเจ็กต์ที่ควรแสดงในผลการค้นหา ค่าของพร็อพเพอร์ตี้ที่เลือกจะแสดงในผลการค้นหาพร้อมกับ display label ของพร็อพเพอร์ตี้นั้น หากระบุไว้ หากไม่ได้ระบุป้ายกำกับที่แสดง ระบบจะแสดงเฉพาะค่า

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

string

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

PropertyDefinition

คําจํากัดความของพร็อพเพอร์ตี้ภายในออบเจ็กต์

การแสดง JSON 
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
ช่อง
name

string

ชื่อที่พัก คำขอจัดทําดัชนีรายการที่ส่งไปยัง Indexing API ควรตั้งค่า property name เป็นค่านี้ เช่น หากชื่อคือ subject_line คำขอจัดทําดัชนีสำหรับรายการเอกสารที่มีช่องเรื่องควรตั้งค่า name สำหรับช่องนั้นเท่ากับ subject_line ใช้ชื่อเป็นตัวระบุพร็อพเพอร์ตี้ออบเจ็กต์ เมื่อจดทะเบียนเป็นพร็อพเพอร์ตี้สำหรับออบเจ็กต์แล้ว คุณจะไม่สามารถนําชื่อนี้ไปใช้กับพร็อพเพอร์ตี้อื่นภายในออบเจ็กต์นั้นได้อีก ชื่อต้องขึ้นต้นด้วยตัวอักษรและมีได้เฉพาะตัวอักษร (A-Z, a-z) หรือตัวเลข (0-9) เท่านั้น ความยาวสูงสุดคือ 256 อักขระ
isReturnable

boolean

บ่งบอกว่าพร็อพเพอร์ตี้ระบุข้อมูลที่ควรแสดงในผลการค้นหาผ่าน Query API หากตั้งค่าเป็น true จะระบุว่าผู้ใช้ Query API สามารถใช้ช่องพร็อพเพอร์ตี้ที่ตรงกันในผลการค้นหาได้ อย่างไรก็ตาม การจัดเก็บช่องต้องใช้การจัดสรรพื้นที่มากขึ้นและใช้แบนด์วิดท์มากขึ้นสําหรับคําค้นหา ซึ่งส่งผลต่อประสิทธิภาพในชุดข้อมูลขนาดใหญ่ ตั้งค่าเป็น true ที่นี่เฉพาะในกรณีที่จำเป็นต้องใช้ช่องนี้ในผลการค้นหา ต้องเป็นเท็จสำหรับพร็อพเพอร์ตี้ที่มีประเภทเป็นออบเจ็กต์
isRepeatable

boolean

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

boolean

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

boolean

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

boolean

ระบุว่าพร็อพเพอร์ตี้สามารถใช้ในการสร้างการแนะนำการค้นหา
isWildcardSearchable

boolean

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

object (PropertyDisplayOptions)

ตัวเลือกที่กำหนดวิธีแสดงพร็อพเพอร์ตี้ในหน้าผลการค้นหาของ Cloud Search หากมีการระบุให้แสดงใน display options ของออบเจ็กต์
ฟิลด์สหภาพ property_options ตัวเลือกเฉพาะประเภทที่กําหนดวิธีจัดทําดัชนีและใช้พร็อพเพอร์ตี้ ในกรณีที่ตัวเลือกควรเป็นตัวเลือกเริ่มต้นสำหรับประเภทหนึ่ง ช่องนี้ยังคงต้องตั้งค่าเป็นประเภทใดประเภทหนึ่ง หากไม่ได้ตั้งค่าช่องนี้ ระบบจะปฏิเสธการอัปเดตสคีมา property_options ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
integerPropertyOptions

object (IntegerPropertyOptions)
doublePropertyOptions

object (DoublePropertyOptions)
timestampPropertyOptions

object (TimestampPropertyOptions)
booleanPropertyOptions

object (BooleanPropertyOptions)
objectPropertyOptions

object (ObjectPropertyOptions)
enumPropertyOptions

object (EnumPropertyOptions)
datePropertyOptions

object (DatePropertyOptions)
textPropertyOptions

object (TextPropertyOptions)
htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

ตัวเลือกสำหรับพร็อพเพอร์ตี้จำนวนเต็ม

การแสดง JSON 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
ช่อง
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

ใช้เพื่อระบุลําดับการจัดอันดับสําหรับจํานวนเต็ม ใช้ได้เฉพาะในกรณีที่ isRepeatable เป็นเท็จ
minimumValue

string (Int64Value format)

ค่าต่ำสุดของพร็อพเพอร์ตี้ ระบบจะใช้ค่าต่ำสุดและสูงสุดของพร็อพเพอร์ตี้เพื่อจัดอันดับผลลัพธ์ตาม ordered ranking ระบบจะยอมรับคำขอจัดทําดัชนีที่มีค่าน้อยกว่าค่าขั้นต่ำและจัดอันดับด้วยน้ำหนักเดียวกับรายการที่จัดทําดัชนีด้วยค่าขั้นต่ำ
maximumValue

string (Int64Value format)

ค่าสูงสุดของพร็อพเพอร์ตี้ ระบบจะใช้ค่าต่ำสุดและสูงสุดของพร็อพเพอร์ตี้เพื่อจัดอันดับผลลัพธ์ตาม ordered ranking ระบบจะยอมรับคำขอจัดทําดัชนีที่มีค่ามากกว่าค่าสูงสุดและจัดอันดับด้วยน้ำหนักเดียวกับรายการที่จัดทําดัชนีด้วยค่าสูงสุด
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้จำนวนเต็มเป็นโอเปอเรเตอร์การค้นหา
integerFacetingOptions

object (IntegerFacetingOptions)

หากตั้งค่าไว้ จะอธิบายตัวเลือกการแยกแง่มุมของจำนวนเต็มสําหรับพร็อพเพอร์ตี้จำนวนเต็มที่ระบุ พร็อพเพอร์ตี้จำนวนเต็มที่เกี่ยวข้องควรมีการทำเครื่องหมาย isFacetable

IntegerPropertyOptions.OrderedRanking

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

Enum
NO_ORDER ที่พักไม่มีลําดับการจัดอันดับ ระบบจะไม่ปรับผลลัพธ์ตามค่าของพร็อพเพอร์ตี้นี้
ASCENDING พร็อพเพอร์ตี้นี้จะจัดอันดับจากน้อยไปมาก ค่าที่ต่ำลงหมายถึงการจัดอันดับที่ต่ำลง
DESCENDING พร็อพเพอร์ตี้นี้จะจัดอันดับจากมากไปน้อย ค่าที่ต่ำลงหมายถึงการจัดอันดับที่สูงขึ้น

IntegerPropertyOptions.IntegerOperatorOptions

ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้จำนวนเต็ม ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จํากัดการค้นหาในช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา

การแสดง JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
ช่อง
operatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็ม ตัวอย่างเช่น หาก operatorName คือ priority และชื่อพร็อพเพอร์ตี้คือ priorityVal การค้นหาอย่าง priority:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ priorityVal ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันนี้โดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาของรายการ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ
lessThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นสําหรับการค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็มโดยใช้โอเปอเรเตอร์ "น้อยกว่า" เช่น หาก lessThanOperatorName คือ prioritybelow และชื่อพร็อพเพอร์ตี้คือ priorityVal การค้นหาอย่าง prioritybelow:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ priorityVal น้อยกว่า <value> ชื่อโอเปอเรเตอร์ต้องมีตัวอักษรตัวพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ
greaterThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็มโดยใช้โอเปอเรเตอร์ "มากกว่า" เช่น หาก greaterThanOperatorName คือ priorityabove และชื่อพร็อพเพอร์ตี้คือ priorityVal การค้นหาอย่าง priorityabove:<value> จะแสดงเฉพาะในกรณีที่ค่าของพร็อพเพอร์ตี้ชื่อ priorityVal มากกว่า <value> ชื่อโอเปอเรเตอร์ต้องมีตัวอักษรตัวพิมพ์เล็กเท่านั้น (a-z) ความยาวสูงสุด 32 อักขระ

DoublePropertyOptions

ตัวเลือกสำหรับพร็อพเพอร์ตี้แบบคู่

การแสดง JSON 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
ช่อง
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้ตัวเลขทศนิยมเป็นโอเปอเรเตอร์การค้นหา

DoublePropertyOptions.DoubleOperatorOptions

ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้แบบคู่ ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จํากัดการค้นหาในช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา

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

string

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

TimestampPropertyOptions

ตัวเลือกสำหรับพร็อพเพอร์ตี้การประทับเวลา

การแสดง JSON 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
ช่อง
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้การประทับเวลาเป็นโอเปอเรเตอร์การค้นหา

TimestampPropertyOptions.TimestampOperatorOptions

ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสําหรับพร็อพเพอร์ตี้การประทับเวลา ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จํากัดการค้นหาในช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา

การแสดง JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
ช่อง
operatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นสําหรับการค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลา ตัวอย่างเช่น หาก operatorName คือ closedon และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่าง closedon:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ closeDate ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันนี้โดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาของรายการ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ
lessThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลาโดยใช้โอเปอเรเตอร์ "น้อยกว่า" เช่น หาก lessThanOperatorName คือ closedbefore และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่าง closedbefore:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ closeDate มาก่อน <value> ชื่อโอเปอเรเตอร์ต้องมีเฉพาะตัวอักษรตัวพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ
greaterThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นสําหรับการค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลาโดยใช้โอเปอเรเตอร์ "มากกว่า" เช่น หาก greaterThanOperatorName คือ closedafter และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่าง closedafter:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่หลัง <value> เท่านั้น ชื่อโอเปอเรเตอร์ต้องมีเฉพาะอักษรตัวพิมพ์เล็ก (a-z) ความยาวสูงสุด 32 อักขระ

BooleanPropertyOptions

ตัวเลือกสําหรับพร็อพเพอร์ตี้บูลีน

การแสดง JSON 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
ช่อง
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้บูลีนเป็นโอเปอเรเตอร์การค้นหา

BooleanPropertyOptions.BooleanOperatorOptions

ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้บูลีน ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จํากัดการค้นหาในช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา

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

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้บูลีน ตัวอย่างเช่น หาก operatorName คือ closed และชื่อพร็อพเพอร์ตี้คือ isClosed การค้นหาอย่าง closed:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ isClosed ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันนี้โดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาของรายการ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ

ObjectPropertyOptions

ตัวเลือกสำหรับพร็อพเพอร์ตี้ออบเจ็กต์

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

object (PropertyDefinition)

พร็อพเพอร์ตี้ของออบเจ็กต์ย่อย พร็อพเพอร์ตี้เหล่านี้แสดงถึงออบเจ็กต์ที่ฝังอยู่ เช่น หากพร็อพเพอร์ตี้นี้แสดงที่อยู่ไปรษณีย์ subobjectProperties อาจตั้งชื่อว่า street, city และ state จำนวนองค์ประกอบสูงสุดคือ 1,000 รายการ

EnumPropertyOptions

ตัวเลือกสำหรับพร็อพเพอร์ตี้ enum ซึ่งช่วยให้คุณกำหนดชุดสตริงที่จํากัดเพื่อจับคู่กับคําค้นหาของผู้ใช้ ตั้งค่าการจัดอันดับสําหรับค่าสตริงเหล่านั้น และกำหนดชื่อโอเปอเรเตอร์เพื่อจับคู่กับสตริงเหล่านั้นเพื่อให้ผู้ใช้จํากัดผลการค้นหาให้เหลือเฉพาะรายการที่มีค่าที่เฉพาะเจาะจงได้ เช่น สําหรับรายการในระบบการติดตามคําขอที่มีข้อมูลลําดับความสําคัญ คุณสามารถกําหนด p0 เป็นค่า Enum ที่อนุญาตและเชื่อมโยง Enum นี้กับชื่อโอเปอเรเตอร์ priority เพื่อให้ผู้ใช้การค้นหาเพิ่ม priority:p0 ลงในคําค้นหาเพื่อจํากัดชุดผลลัพธ์ให้แสดงเฉพาะรายการที่จัดทําดัชนีด้วยค่า p0

การแสดง JSON 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
ช่อง
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

รายการค่าที่เป็นไปได้สำหรับพร็อพเพอร์ตี้การแจกแจง EnumValuePairs ทั้งหมดต้องมีค่าสตริง หากคุณระบุค่าจำนวนเต็มสำหรับ EnumValuePair รายการหนึ่ง EnumValuePairs ที่เป็นไปได้ทั้งหมดจะต้องระบุค่าจำนวนเต็ม ทั้งค่าสตริงและค่าจำนวนเต็มที่ระบุต้องไม่ซ้ำกันสำหรับค่าที่เป็นไปได้ทั้งหมด เมื่อตั้งค่าแล้ว คุณจะนําค่าที่เป็นไปได้ออกหรือแก้ไขไม่ได้ หากคุณระบุการจัดอันดับตามลําดับและคิดว่าอาจแทรกค่า Enum เพิ่มเติมในอนาคต ให้เว้นวรรคในค่าจำนวนเต็มเริ่มต้นเพื่อให้เพิ่มค่าระหว่างค่าที่ลงทะเบียนไว้ก่อนหน้านี้ได้ จำนวนองค์ประกอบสูงสุดคือ 100 รายการ
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

ใช้เพื่อระบุการจัดอันดับตามลําดับสําหรับการแจกแจงซึ่งกําหนดวิธีใช้ค่าจํานวนเต็มที่ระบุไว้ใน EnumValuePairs ที่เป็นไปได้เพื่อจัดอันดับผลลัพธ์ หากระบุ ค่าต้องเป็นจำนวนเต็มสำหรับค่า EnumValuePair ที่เป็นไปได้ทั้งหมดสำหรับพร็อพเพอร์ตี้นี้ ใช้ได้เฉพาะในกรณีที่ isRepeatable เป็นเท็จ
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้ค่าแจกแจงเป็นโอเปอเรเตอร์การค้นหา

EnumPropertyOptions.EnumValuePair

คู่ค่าการแจกแจงจะกำหนด 2 สิ่ง ได้แก่ ค่าสตริงที่ต้องระบุและค่าจำนวนเต็มที่ไม่บังคับ ค่าสตริงจะกำหนดข้อความค้นหาที่จำเป็นในการดึงข้อมูลรายการนั้น เช่น p0 สำหรับรายการสำคัญ ค่าจำนวนเต็มจะกําหนดลําดับความสําคัญของค่าสตริงนั้นเทียบกับค่าที่แจกแจงไว้อื่นๆ สําหรับพร็อพเพอร์ตี้เดียวกัน เช่น คุณอาจเชื่อมโยง p0 กับ 0 และกำหนดคู่ Enum อื่น เช่น p1 และ 1 คุณต้องใช้ค่าจำนวนเต็มร่วมกับ ordered ranking เพื่อกำหนดลําดับความสําคัญของค่าหนึ่งๆ เทียบกับค่าที่แจกแจงไว้อื่นๆ สําหรับชื่อพร็อพเพอร์ตี้เดียวกัน ในกรณีนี้ ลําดับการจัดอันดับ DESCENDING สําหรับพร็อพเพอร์ตี้ priority จะทําให้รายการที่จัดทําดัชนีด้วยค่า p0 ได้รับการเพิ่มอันดับเมื่อเทียบกับรายการที่จัดทําดัชนีด้วยค่า p1 หากไม่ได้ระบุลําดับการจัดอันดับ ค่าจํานวนเต็มจะไม่มีผลต่อการจัดอันดับสินค้า

การแสดง JSON 
{
  "stringValue": string,
  "integerValue": integer
}
ช่อง
stringValue

string

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

integer

ค่าจำนวนเต็มที่ไม่เป็นลบของ EnumValuePair ไม่บังคับ

EnumPropertyOptions.OrderedRanking

ใช้เพื่อระบุทิศทางการจัดอันดับสําหรับจํานวนเต็ม EnumValuePair เทียบกับค่าจํานวนเต็ม EnumValuePair อื่นๆ สําหรับพร็อพเพอร์ตี้บางรายการ ค่าจำนวนเต็มยิ่งต่ำก็ยิ่งมีความสําคัญสูง ในขณะที่พร็อพเพอร์ตี้อื่นๆ ค่าจํานวนเต็มยิ่งสูงก็ยิ่งมีความสําคัญสูง

Enum
NO_ORDER ที่พักไม่มีลําดับการจัดอันดับ ระบบจะไม่ปรับผลลัพธ์ตามค่าของพร็อพเพอร์ตี้นี้
ASCENDING พร็อพเพอร์ตี้นี้จะจัดอันดับจากน้อยไปมาก ค่าที่ต่ำลงหมายถึงการจัดอันดับที่ต่ำลง
DESCENDING พร็อพเพอร์ตี้นี้จะจัดอันดับจากมากไปน้อย ค่าที่ต่ำลงหมายถึงการจัดอันดับที่สูงขึ้น

EnumPropertyOptions.EnumOperatorOptions

ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสําหรับพร็อพเพอร์ตี้ enum ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จํากัดการค้นหาในช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา เช่น หากคุณไม่ได้ระบุโอเปอเรเตอร์สำหรับพร็อพเพอร์ตี้ priority แบบ Enum ที่มีค่าที่เป็นไปได้คือ p0 และ p1 การค้นหาที่มีคําว่า p0 จะแสดงรายการที่มี p0 เป็นค่าของพร็อพเพอร์ตี้ priority รวมถึงรายการที่มีสตริง p0 ในช่องอื่นๆ หากคุณระบุชื่อโอเปอเรเตอร์สำหรับ Enum เช่น priority ผู้ใช้การค้นหาจะใช้โอเปอเรเตอร์ดังกล่าวเพื่อปรับแต่งผลลัพธ์ให้แสดงเฉพาะรายการที่มี p0 เป็นค่าของพร็อพเพอร์ตี้นี้ได้ด้วยคําค้นหา priority:p0

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

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้ enum ตัวอย่างเช่น หาก operatorName คือ priority และชื่อพร็อพเพอร์ตี้คือ priorityVal การค้นหาอย่าง priority:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ priorityVal ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันนี้โดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาของรายการ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ

DatePropertyOptions

ตัวเลือกสำหรับพร็อพเพอร์ตี้วันที่

การแสดง JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
ช่อง
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้วันที่เป็นโอเปอเรเตอร์การค้นหา

DatePropertyOptions.DateOperatorOptions

ไม่บังคับ มีโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้วันที่ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาไปยังช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหาได้

การแสดง JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
ช่อง
operatorName

string

ระบุสตริงจริงที่จําเป็นในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่ ตัวอย่างเช่น สมมติว่าออบเจ็กต์สคีมาการติดตามปัญหามีพร็อพเพอร์ตี้ชื่อ closeDate ที่ระบุโอเปอเรเตอร์ที่มี operatorName เป็น closedon สําหรับการค้นหาข้อมูลดังกล่าว การค้นหาอย่าง closedon:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ closeDate ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันนี้โดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาสําหรับแหล่งข้อมูลที่จัดทำดัชนี ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ
lessThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในการค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่โดยใช้โอเปอเรเตอร์ "น้อยกว่า" เช่น หาก lessThanOperatorName คือ closedbefore และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่าง closedbefore:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ closeDate มาก่อน <value> ชื่อโอเปอเรเตอร์ต้องมีเฉพาะตัวอักษรตัวพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ
greaterThanOperatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในการค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่โดยใช้โอเปอเรเตอร์ "มากกว่า" เช่น หาก greaterThanOperatorName คือ closedafter และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่าง closedafter:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่หลัง <value> เท่านั้น ชื่อโอเปอเรเตอร์ต้องมีเฉพาะอักษรตัวพิมพ์เล็ก (a-z) ความยาวสูงสุด 32 อักขระ

TextPropertyOptions

ตัวเลือกสำหรับพร็อพเพอร์ตี้ข้อความ

การแสดง JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
ช่อง
retrievalImportance

object (RetrievalImportance)

ระบุความสำคัญของคุณภาพการค้นหาของโทเค็นภายในช่องเมื่อใช้สำหรับการดึงข้อมูล
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้พร็อพเพอร์ตี้เป็นโอเปอเรเตอร์การค้นหา

RetrievalImportance

การแสดง JSON 
{
  "importance": enum (RetrievalImportance.Importance)
}
ช่อง
importance

enum (RetrievalImportance.Importance)

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

RetrievalImportance.Importance

Enum
DEFAULT ถือว่าการจับคู่นั้นเป็นการจับคู่ข้อความเนื้อหา
HIGHEST ถือว่าการจับคู่นี้เหมือนกับการจับคู่กับชื่อของรายการ
HIGH ถือว่าการจับคู่มีความสําคัญมากกว่าข้อความเนื้อหา
LOW ถือว่าการจับคู่มีความสําคัญน้อยกว่าข้อความเนื้อหา
NONE อย่าจับคู่กับฟิลด์นี้ระหว่างการดึงข้อมูล พร็อพเพอร์ตี้จะยังคงใช้สำหรับการจับคู่โอเปอเรเตอร์ การจัดกลุ่ม และคำแนะนำได้หากต้องการ

TextPropertyOptions.TextOperatorOptions

ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้ข้อความ ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จํากัดการค้นหาในช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา

การแสดง JSON 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
ช่อง
operatorName

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้ข้อความ ตัวอย่างเช่น หาก operatorName คือ subject และชื่อพร็อพเพอร์ตี้คือ subjectLine การค้นหาอย่าง subject:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ subjectLine ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันนี้โดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้ข้อความหรือข้อความภายในช่องเนื้อหาของรายการ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ
exactMatchWithOperator

boolean

หากเป็น "จริง" ระบบจะแบ่งค่าข้อความออกเป็นโทเค็นเป็นค่าเดี่ยวในการค้นหาด้วยโอเปอเรเตอร์และการจับคู่แง่มุม เช่น หากชื่อโอเปอเรเตอร์คือ "genre" และค่าคือ "science-fiction" ข้อจำกัดการค้นหา "genre:science" และ "genre:fiction" จะไม่ตรงกับรายการ แต่ "genre:science-fiction" จะตรง การจับคู่ค่าข้อความจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ และไม่นำอักขระพิเศษออก หากเป็น "เท็จ" ระบบจะแบ่งข้อความออกเป็นโทเค็น เช่น หากค่าคือ "science-fiction" การค้นหา "genre:science" และ "genre:fiction" จะตรงกับรายการ

HtmlPropertyOptions

ตัวเลือกสําหรับพร็อพเพอร์ตี้ HTML

การแสดง JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
ช่อง
retrievalImportance

object (RetrievalImportance)

ระบุความสำคัญของคุณภาพการค้นหาของโทเค็นภายในช่องเมื่อใช้สำหรับการดึงข้อมูล ตั้งค่าได้เฉพาะเป็น DEFAULT หรือ NONE
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

หากตั้งค่าไว้ จะอธิบายวิธีใช้พร็อพเพอร์ตี้เป็นโอเปอเรเตอร์การค้นหา

HtmlPropertyOptions.HtmlOperatorOptions

ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสําหรับพร็อพเพอร์ตี้ html ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จํากัดการค้นหาในช่องที่เฉพาะเจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา

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

string

ระบุชื่อโอเปอเรเตอร์ที่จําเป็นในคําค้นหาเพื่อแยกพร็อพเพอร์ตี้ html ตัวอย่างเช่น หาก operatorName คือ subject และชื่อพร็อพเพอร์ตี้คือ subjectLine การค้นหาอย่าง subject:<value> จะแสดงเฉพาะผลลัพธ์ที่ค่าของพร็อพเพอร์ตี้ชื่อ subjectLine ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันนี้โดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้ html หรือข้อความภายในช่องเนื้อหาของรายการ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น ความยาวสูงสุด 32 อักขระ

PropertyDisplayOptions

ตัวเลือกการแสดงผลสำหรับที่พัก

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

string

ป้ายกำกับที่เข้าใจง่ายสำหรับพร็อพเพอร์ตี้ที่จะใช้หากมีการระบุพร็อพเพอร์ตี้ให้แสดงใน ObjectDisplayOptions หากระบุไว้ ป้ายกำกับที่แสดงจะแสดงอยู่หน้าค่าพร็อพเพอร์ตี้เมื่อพร็อพเพอร์ตี้เป็นส่วนหนึ่งของตัวเลือกการแสดงออบเจ็กต์ เช่น หากค่าพร็อพเพอร์ตี้คือ "1" ค่าเพียงอย่างเดียวอาจไม่ใช่บริบทที่เป็นประโยชน์สําหรับผู้ใช้ หากชื่อที่แสดงคือ "priority" ผู้ใช้จะเห็น "priority : 1" ในผลการค้นหา ซึ่งให้บริบทที่ชัดเจนแก่ผู้ใช้การค้นหา ข้อมูลนี้ไม่บังคับ หากไม่ระบุ ระบบจะแสดงเฉพาะค่าพร็อพเพอร์ตี้ ความยาวสูงสุด 64 อักขระ