Schema

Định nghĩa giản đồ cho một nguồn dữ liệu.

Biểu diễn dưới dạng JSON 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Trường
objectDefinitions[]

object (ObjectDefinition)

Danh sách đối tượng cấp cao nhất cho nguồn dữ liệu. Số lượng phần tử tối đa là 10.
operationIds[]

string

Mã của các Hoạt động chạy trong thời gian dài (LRO) hiện đang chạy cho giản đồ này. Sau khi sửa đổi giản đồ, hãy đợi các thao tác hoàn tất trước khi lập chỉ mục nội dung bổ sung.

ObjectDefinition

Định nghĩa về một đối tượng trong nguồn dữ liệu.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Trường
name

string

Tên cho đối tượng, sau đó xác định loại của đối tượng. Yêu cầu lập chỉ mục mặt hàng phải đặt trường objectType bằng giá trị này. Ví dụ: nếu tên là Tài liệu, thì yêu cầu lập chỉ mục cho các mục thuộc loại Tài liệu phải đặt objectType bằng Tài liệu. Mỗi định nghĩa đối tượng phải được đặt tên duy nhất trong một giản đồ. Tên phải bắt đầu bằng một chữ cái và chỉ được chứa chữ cái (A-Z, a-z) hoặc chữ số (0-9). Độ dài tối đa là 256 ký tự.
options

object (ObjectOptions)

Các tuỳ chọn dành riêng cho từng đối tượng (không bắt buộc).
propertyDefinitions[]

object (PropertyDefinition)

Các định nghĩa thuộc tính cho đối tượng. Số lượng phần tử tối đa là 1000.

ObjectOptions

Các tuỳ chọn cho một đối tượng.

Biểu diễn dưới dạng JSON 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Trường
freshnessOptions

object (ObjectOptions.FreshnessOptions)

Các tuỳ chọn làm mới cho một đối tượng.
displayOptions

object (ObjectDisplayOptions)

Các tuỳ chọn xác định cách đối tượng hiển thị trên trang kết quả của Cloud Search.
suggestionFilteringOperators[]

string

Các toán tử có thể dùng để lọc đề xuất. Đối với API query.suggest, chỉ những toán tử được đề cập ở đây mới được áp dụng trong FilterOptions. Chỉ hỗ trợ các toán tử TEXT và ENUM.

LƯU Ý: "objecttype", "type" và "mimetype" đã được hỗ trợ. Thuộc tính này dùng để định cấu hình các toán tử dành riêng cho giản đồ.

Mặc dù đây là một mảng nhưng chỉ có thể chỉ định một toán tử. Đây là một mảng để có thể mở rộng trong tương lai.

Không hỗ trợ toán tử ánh xạ đến nhiều thuộc tính trong cùng một đối tượng. Nếu toán tử trải rộng trên nhiều loại đối tượng, bạn phải đặt tuỳ chọn này một lần cho mỗi định nghĩa đối tượng.

ObjectOptions.FreshnessOptions

Cho biết cần sử dụng thuộc tính độ mới nào khi điều chỉnh thứ hạng tìm kiếm cho một mặt hàng. Ngày càng mới, chất lượng càng cao. Sử dụng thuộc tính lựa chọn làm mới phù hợp nhất với dữ liệu của bạn. Đối với tài liệu chia sẻ tệp, thời gian sửa đổi gần đây nhất là phù hợp nhất. Đối với dữ liệu sự kiện trên lịch, thời gian khi sự kiện xảy ra sẽ là chỉ báo độ mới phù hợp hơn. Bằng cách này, các sự kiện trên lịch xảy ra gần hơn với thời gian của cụm từ tìm kiếm sẽ được xem là có chất lượng cao hơn và được xếp hạng tương ứng.

Biểu diễn dưới dạng JSON 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Trường
freshnessProperty

string

Thuộc tính này cho biết mức độ làm mới của đối tượng trong chỉ mục. Nếu được đặt, thuộc tính này phải là thuộc tính cấp cao nhất trong property definitions và phải là timestamp type hoặc date type. Nếu không, API Lập chỉ mục sẽ sử dụng updateTime làm chỉ báo về độ mới. Độ dài tối đa là 256 ký tự.

Khi một thuộc tính được dùng để tính toán độ mới, giá trị mặc định là 2 năm tính từ thời điểm hiện tại.
freshnessDuration

string (Duration format)

Khoảng thời gian mà sau đó một đối tượng sẽ được coi là lỗi thời. Giá trị mặc định là 180 ngày (tính bằng giây).

Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng "s". Ví dụ: "3.5s".

ObjectDisplayOptions

Các tuỳ chọn hiển thị cho một đối tượng.

Biểu diễn dưới dạng JSON 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Trường
objectDisplayLabel

string

Nhãn thân thiện với người dùng được hiển thị trong kết quả tìm kiếm nhằm cho biết loại mục. Điều này KHÔNG BẮT BUỘC; nếu không được cung cấp, nhãn đối tượng sẽ không được hiển thị trên dòng ngữ cảnh của kết quả tìm kiếm. Độ dài tối đa là 64 ký tự.
metalines[]

object (ObjectDisplayOptions.Metaline)

Xác định những thuộc tính xuất hiện trong thẻ meta của kết quả tìm kiếm. Các giá trị thuộc tính được hiển thị theo thứ tự được cung cấp tại đây. Nếu một thuộc tính chứa nhiều giá trị thì tất cả các giá trị đó sẽ hiển thị trước các thuộc tính tiếp theo. Vì lý do này, bạn nên chỉ định các thuộc tính số ít trước các thuộc tính lặp lại trong danh sách này. Tất cả thuộc tính phải đặt isReturnable thành true. Số lượng dòng meta tối đa là 3.

ObjectDisplayOptions.Metaline

Thẻ metaline là danh sách các thuộc tính được hiển thị cùng với kết quả tìm kiếm để cung cấp ngữ cảnh.

Biểu diễn dưới dạng JSON 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Trường
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

Danh sách thuộc tính được hiển thị cho metaline. Số lượng tài sản tối đa là 5.

ObjectDisplayOptions.DisplayedProperty

Tham chiếu đến thuộc tính cấp cao nhất trong đối tượng sẽ được hiển thị trong kết quả tìm kiếm. Các giá trị của những thuộc tính đã chọn sẽ hiển thị trong kết quả tìm kiếm cùng với display label của thuộc tính đó nếu bạn chỉ định một thuộc tính. Nếu không chỉ định nhãn hiển thị thì chỉ có các giá trị được hiển thị.

Biểu diễn dưới dạng JSON 
{
  "propertyName": string
}
Trường
propertyName

string

Tên của thuộc tính cấp cao nhất như được xác định trong định nghĩa thuộc tính cho đối tượng. Nếu tên không phải là một thuộc tính được xác định trong giản đồ, sẽ xảy ra lỗi khi cố gắng cập nhật giản đồ.

PropertyDefinition

Định nghĩa thuộc tính trong một đối tượng.

Biểu diễn dưới dạng 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.
}
Trường
name

string

Tên của cơ sở lưu trú. Các yêu cầu lập chỉ mục mặt hàng được gửi đến API lập chỉ mục phải đặt property name bằng giá trị này. Ví dụ: nếu tên là subject_line, thì yêu cầu lập chỉ mục cho các mục tài liệu có trường tiêu đề phải đặt name cho trường đó bằng subject_line. Sử dụng tên làm giá trị nhận dạng cho thuộc tính đối tượng. Sau khi đăng ký làm thuộc tính cho một đối tượng, bạn không thể dùng lại tên này cho một thuộc tính khác trong đối tượng đó. Tên phải bắt đầu bằng một chữ cái và chỉ được chứa chữ cái (A-Z, a-z) hoặc chữ số (0-9). Độ dài tối đa là 256 ký tự.
isReturnable

boolean

Cho biết rằng thuộc tính xác định dữ liệu cần được trả về trong kết quả tìm kiếm qua API Truy vấn. Nếu bạn đặt thành true (đúng), cho biết rằng người dùng Query API có thể sử dụng các trường thuộc tính trùng khớp trong kết quả. Tuy nhiên, việc lưu trữ trường đòi hỏi nhiều không gian phân bổ hơn và sử dụng nhiều băng thông hơn cho các truy vấn tìm kiếm. Điều này ảnh hưởng đến hiệu suất trên các tập dữ liệu lớn. Chỉ đặt thành true tại đây nếu trường này là cần thiết cho kết quả tìm kiếm. Không thể đúng đối với các thuộc tính có loại là đối tượng.
isRepeatable

boolean

Cho biết thuộc tính được phép có nhiều giá trị. Ví dụ: một tài liệu chỉ có một nội dung mô tả nhưng có thể có nhiều nhận xét. Không thể đúng đối với các thuộc tính có loại là boolean. Nếu bạn đặt chính sách này thành false (sai), những thuộc tính chứa nhiều giá trị sẽ khiến yêu cầu lập chỉ mục cho mục đó bị từ chối.
isSortable

boolean

Cho biết thuộc tính này có thể được dùng để sắp xếp. Không thể đúng đối với những thuộc tính có thể lặp lại. Không thể đúng đối với các thuộc tính có loại là đối tượng. Giá trị IsReturnable phải được đặt là true để đặt tuỳ chọn này. Chỉ hỗ trợ cho các thuộc tính boolean, ngày, kép, số nguyên và dấu thời gian.
isFacetable

boolean

Cho biết rằng thuộc tính này có thể được dùng để tạo các thuộc tính. Không thể đúng đối với các thuộc tính có loại là đối tượng. Giá trị IsReturnable phải được đặt là true để đặt tuỳ chọn này. Chỉ hỗ trợ cho các thuộc tính boolean, enum, số nguyên và văn bản.
isSuggestable

boolean

Cho biết thuộc tính có thể được dùng để tạo các đề xuất truy vấn.
isWildcardSearchable

boolean

Cho biết rằng người dùng có thể tìm kiếm tài sản này theo ký tự đại diện. Chỉ hỗ trợ cho thuộc tính Văn bản. Giá trị IsReturnable phải được đặt là true để đặt tuỳ chọn này. Trong một nguồn dữ liệu nhất định, bạn có thể đánh dấu tối đa 5 tài sản là is SẽTìm kiếm được ký tự đại diện. Để biết thêm thông tin, hãy xem bài viết Xác định thuộc tính của đối tượng
displayOptions

object (PropertyDisplayOptions)

Các tuỳ chọn giúp xác định cách tài sản xuất hiện trong trang kết quả của Cloud Search nếu tài sản đó được chỉ định để xuất hiện trong display options của đối tượng.
Trường kết hợp property_options. Tuỳ chọn theo từng loại giúp xác định cách tài sản được lập chỉ mục và sử dụng. Trong trường hợp các lựa chọn là lựa chọn mặc định cho một loại, bạn vẫn phải đặt trường này thành một trong các loại đó. Nếu bạn không đặt trường này, thì nội dung cập nhật giản đồ sẽ bị từ chối. property_options chỉ có thể là một trong những trạng thái sau đây:
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

Các tuỳ chọn cho các thuộc tính số nguyên.

Biểu diễn dưới dạng JSON 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Trường
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

Dùng để chỉ định thứ hạng theo thứ tự cho số nguyên. Chỉ có thể sử dụng nếu isRepeatable là false.
minimumValue

string (Int64Value format)

Giá trị nhỏ nhất của thuộc tính. Các giá trị tối thiểu và tối đa của thuộc tính được dùng để xếp hạng các kết quả theo ordered ranking. Yêu cầu lập chỉ mục có giá trị nhỏ hơn giá trị tối thiểu sẽ được chấp nhận và được xếp hạng với cùng trọng số với các mục được lập chỉ mục có giá trị tối thiểu.
maximumValue

string (Int64Value format)

Giá trị tối đa của thuộc tính. Các giá trị tối thiểu và tối đa của thuộc tính được dùng để xếp hạng các kết quả theo ordered ranking. Yêu cầu lập chỉ mục có giá trị lớn hơn giá trị tối đa sẽ được chấp nhận và được xếp hạng với cùng trọng số với các mục được lập chỉ mục có giá trị tối đa.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Nếu đặt, mô tả cách số nguyên sẽ được sử dụng làm toán tử tìm kiếm.
integerFacetingOptions

object (IntegerFacetingOptions)

Nếu đặt, mô tả các tuỳ chọn thuộc tính số nguyên cho thuộc tính số nguyên đã cho. Thuộc tính số nguyên tương ứng phải được đánh dấu là isFacetable.

IntegerPropertyOptions.OrderedRanking

Dùng để chỉ định cách xếp hạng một giá trị số nguyên so với các giá trị khác. Số nguyên có thứ tự xếp hạng càng cao thì tầm quan trọng càng lớn. Ví dụ: trong một số nguồn dữ liệu, mức độ ưu tiên thấp hơn biểu thị mức độ quan trọng cao hơn, còn trong một số nguồn khác, mức độ ưu tiên càng cao thì mức độ quan trọng càng cao.

Enum
NO_ORDER Không có thứ tự xếp hạng cho cơ sở lưu trú. Kết quả không được điều chỉnh theo giá trị của thuộc tính này.
ASCENDING Tài sản này được xếp hạng theo thứ tự tăng dần. Giá trị càng thấp thì thứ hạng càng thấp.
DESCENDING Cơ sở lưu trú này được xếp hạng theo thứ tự giảm dần. Giá trị càng thấp thì thứ hạng càng cao.

IntegerPropertyOptions.IntegerOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các thuộc tính số nguyên. Bạn không bắt buộc phải làm việc này. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Trường
operatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính số nguyên. Ví dụ: nếu tên toán tử là mức độ ưu tiên và tên của thuộc tính là mức độ ưu tiênVal, thì các truy vấn như mức độ ưu tiên:<value> sẽ chỉ hiển thị các kết quả khi giá trị của thuộc tính có tên mức độ ưu tiênVal khớp với <giá trị>. Ngược lại, thao tác tìm kiếm sử dụng cùng một &lt;value&gt; mà không có toán tử sẽ trả về tất cả các mục trong đó &lt;value&gt; khớp với giá trị của bất kỳ thuộc tính Chuỗi hoặc văn bản nào trong trường nội dung cho mục đó. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
lessThanOperatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính số nguyên bằng toán tử nhỏ hơn. Ví dụ: nếu leastThanOperatorName là Priority Thường và tên của thuộc tính là PriorityVal, thì các truy vấn như PriorityDưới:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên PriorityVal nhỏ hơn <value>. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
greaterThanOperatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính số nguyên bằng toán tử lớn hơn. Ví dụ: Nếu lớnThanOperatorName được đặt mức độ ưu tiên cao hơn và tên của thuộc tính là PriorityVal, thì các truy vấn như ưu tiên trên:<value> sẽ chỉ hiển thị kết quả khi giá trị của thuộc tính có tên là PriorityVal lớn hơn <value>. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

DoublePropertyOptions

Các tuỳ chọn cho tài sản kép.

Biểu diễn dưới dạng JSON 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Trường
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Nếu đặt, hãy mô tả cách sử dụng giá trị kép làm toán tử tìm kiếm.

DoublePropertyOptions.DoubleOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các tài sản kép. Bạn không bắt buộc phải làm việc này. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string
}
Trường
operatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để sử dụng thuộc tính kép trong việc sắp xếp hoặc dưới dạng thuộc tính. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

TimestampPropertyOptions

Các lựa chọn đối với thuộc tính dấu thời gian.

Biểu diễn dưới dạng JSON 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Trường
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Nếu đặt, hãy mô tả cách sử dụng dấu thời gian làm toán tử tìm kiếm.

TimestampPropertyOptions.TimestampOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các thuộc tính dấu thời gian. Bạn không bắt buộc phải làm việc này. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Trường
operatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính dấu thời gian. Ví dụ: nếu providerName là closeon và tên của thuộc tính là closeDate, thì các truy vấn như closeon:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closeDate khớp với <value>. Ngược lại, thao tác tìm kiếm sử dụng cùng một &lt;value&gt; mà không có toán tử sẽ trả về tất cả các mục trong đó &lt;value&gt; khớp với giá trị của bất kỳ thuộc tính Chuỗi hoặc văn bản nào trong trường nội dung cho mục đó. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
lessThanOperatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính dấu thời gian bằng toán tử nhỏ hơn. Ví dụ: nếu leastThanOperatorName là closedbefore và tên của thuộc tính là closedbefore, thì các truy vấn như closedbefore chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closedbefore sớm hơn closedbefore. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
greaterThanOperatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính dấu thời gian bằng toán tử lớn hơn. Ví dụ: nếu largeThanOperatorName là closeafter và tên của thuộc tính là closeDate, thì các truy vấn như closeafter:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closeDate muộn hơn <value>. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

BooleanPropertyOptions

Các tuỳ chọn cho thuộc tính boolean.

Biểu diễn dưới dạng JSON 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Trường
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Nếu đặt, mô tả cách sử dụng boolean làm toán tử tìm kiếm.

BooleanPropertyOptions.BooleanOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các thuộc tính boolean. Bạn không bắt buộc phải làm việc này. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string
}
Trường
operatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính boolean. Ví dụ: nếu providerName là đóng và tên của thuộc tính là isClose, thì các truy vấn như close:<value> chỉ hiển thị các kết quả trong đó giá trị của thuộc tính có tên isClose khớp với <value>. Ngược lại, thao tác tìm kiếm sử dụng cùng một &lt;value&gt; mà không có toán tử sẽ trả về tất cả các mục trong đó &lt;value&gt; khớp với giá trị của bất kỳ thuộc tính Chuỗi hoặc văn bản nào trong trường nội dung cho mục đó. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

ObjectPropertyOptions

Các tuỳ chọn cho thuộc tính đối tượng.

Biểu diễn dưới dạng JSON 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Trường
subobjectProperties[]

object (PropertyDefinition)

Các thuộc tính của đối tượng phụ. Các thuộc tính này đại diện cho một đối tượng được lồng. Ví dụ: nếu thuộc tính này đại diện cho một địa chỉ bưu chính, thì subobjectProperties có thể là street, city và state. Số lượng phần tử tối đa là 1000.

EnumPropertyOptions

Tuỳ chọn cho các thuộc tính enum, cho phép bạn xác định một tập hợp chuỗi bị hạn chế để so khớp với truy vấn của người dùng, thiết lập thứ hạng cho các giá trị chuỗi đó và xác định tên toán tử sẽ được ghép với các chuỗi đó để người dùng có thể thu hẹp kết quả chỉ cho các mục có giá trị cụ thể. Ví dụ: đối với các mục trong hệ thống theo dõi yêu cầu có thông tin ưu tiên, bạn có thể xác định p0 là giá trị enum được phép và liên kết enum này với mức độ ưu tiên của toán tử để người dùng tìm kiếm có thể thêm Priority:p0 vào truy vấn nhằm hạn chế tập hợp kết quả chỉ với các mục được lập chỉ mục với giá trị p0.

Biểu diễn dưới dạng JSON 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Trường
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

Danh sách các giá trị có thể có cho thuộc tính liệt kê. Tất cả EnumValuePairs phải cung cấp một giá trị chuỗi. Nếu bạn chỉ định một giá trị số nguyên cho một EnumValuePairs, thì tất cả EnumValuePairs có thể có đều phải cung cấp giá trị số nguyên. Cả giá trị chuỗi và giá trị số nguyên đều phải là duy nhất trên tất cả các giá trị có thể có. Sau khi đặt, bạn không thể xoá hoặc sửa đổi các giá trị có thể có. Nếu bạn cung cấp thứ hạng theo thứ tự và cho rằng mình có thể chèn thêm các giá trị enum trong tương lai, hãy để trống các giá trị số nguyên ban đầu để có thể thêm một giá trị vào giữa các giá trị đã đăng ký trước đó. Số lượng phần tử tối đa là 100.
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Dùng để chỉ định thứ hạng theo thứ tự cho giá trị liệt kê nhằm xác định cách dùng các giá trị số nguyên đã cung cấp trong các EnumValuePairs có thể có để xếp hạng kết quả. Nếu được chỉ định, bạn phải cung cấp giá trị số nguyên cho tất cả các giá trị EnumValuePair có thể có cho thuộc tính này. Chỉ có thể sử dụng nếu isRepeatable là false.
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Nếu đặt, hãy mô tả cách sử dụng enum làm toán tử tìm kiếm.

EnumPropertyOptions.EnumValuePair

Cặp giá trị liệt kê xác định hai điều: giá trị chuỗi bắt buộc và giá trị số nguyên không bắt buộc. Giá trị chuỗi xác định cụm từ truy vấn cần thiết để truy xuất mục đó, chẳng hạn như p0 đối với một mục ưu tiên. Giá trị số nguyên xác định thứ hạng của giá trị chuỗi đó so với các giá trị được liệt kê khác cho cùng một thuộc tính. Ví dụ: bạn có thể liên kết p0 với 0 và xác định một cặp enum khác như p1 và 1. Bạn phải sử dụng giá trị số nguyên kết hợp với ordered ranking để thiết lập thứ hạng của một giá trị đã cho so với các giá trị được liệt kê khác cho cùng một tên thuộc tính. Ở đây, thứ tự xếp hạng DESCENDING cho thuộc tính mức độ ưu tiên sẽ dẫn đến việc tăng thứ hạng cho các mục được lập chỉ mục có giá trị p0 so với các mục được lập chỉ mục có giá trị p1. Nếu không có thứ tự xếp hạng cụ thể, giá trị số nguyên không ảnh hưởng đến việc xếp hạng mặt hàng.

Biểu diễn dưới dạng JSON 
{
  "stringValue": string,
  "integerValue": integer
}
Trường
stringValue

string

Giá trị chuỗi của EnumValuePair. Độ dài tối đa là 32 ký tự.
integerValue

integer

Giá trị số nguyên của EnumValuePair không được là số âm. Không bắt buộc.

EnumPropertyOptions.OrderedRanking

Dùng để chỉ định hướng xếp hạng cho một số nguyên EnumValuePair so với các giá trị số nguyên EnumValuePair khác. Đối với một số thuộc tính, giá trị số nguyên thấp hơn cho biết tầm quan trọng cao hơn, trong khi đối với các thuộc tính khác, số nguyên càng cao thì tầm quan trọng càng cao.

Enum
NO_ORDER Không có thứ tự xếp hạng cho cơ sở lưu trú. Kết quả không được điều chỉnh theo giá trị của tài sản này.
ASCENDING Tài sản này được xếp hạng theo thứ tự tăng dần. Giá trị càng thấp thì thứ hạng càng thấp.
DESCENDING Cơ sở lưu trú này được xếp hạng theo thứ tự giảm dần. Giá trị càng thấp thì thứ hạng càng cao.

EnumPropertyOptions.EnumOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các thuộc tính enum. Bạn không bắt buộc phải làm việc này. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm. Ví dụ: nếu bạn không cung cấp toán tử cho thuộc tính enum mức độ ưu tiên với các giá trị có thể có là p0 và p1, thì một truy vấn có chứa từ khoá p0 sẽ trả về các mục có p0 làm giá trị của thuộc tính mức độ ưu tiên, cũng như bất kỳ mục nào chứa chuỗi p0 trong các trường khác. Nếu bạn cung cấp tên toán tử cho enum, chẳng hạn như mức độ ưu tiên, thì người dùng tìm kiếm có thể sử dụng toán tử đó để chỉ tinh chỉnh kết quả thành các mục có p0 là giá trị của thuộc tính này, với truy vấn Priority:p0.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string
}
Trường
operatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính enum. Ví dụ: nếu tên toán tử là mức độ ưu tiên và tên của thuộc tính là mức độ ưu tiênVal, thì các truy vấn như mức độ ưu tiên:<value> sẽ chỉ hiển thị các kết quả khi giá trị của thuộc tính có tên mức độ ưu tiênVal khớp với <giá trị>. Ngược lại, thao tác tìm kiếm sử dụng cùng một &lt;value&gt; mà không có toán tử sẽ trả về tất cả các mục trong đó &lt;value&gt; khớp với giá trị của bất kỳ thuộc tính Chuỗi hoặc văn bản nào trong trường nội dung cho mục đó. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

DatePropertyOptions

Các lựa chọn đối với thuộc tính ngày.

Biểu diễn dưới dạng JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Trường
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Nếu đặt, hãy mô tả cách dùng ngày này làm toán tử tìm kiếm.

DatePropertyOptions.DateOperatorOptions

Không bắt buộc. Cung cấp một toán tử tìm kiếm cho các thuộc tính ngày. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Trường
operatorName

string

Cho biết chuỗi thực tế bắt buộc trong truy vấn để tách biệt thuộc tính ngày. Ví dụ: giả sử một đối tượng giản đồ theo dõi vấn đề có thuộc tính có tên closeDate chỉ định một toán tử có toán tử là closeon. Đối với các lượt tìm kiếm trên dữ liệu đó, các truy vấn như closedon:&lt;value&gt; chỉ hiển thị kết quả khi giá trị của thuộc tính closedon:&lt;value&gt; khớp với closedon:&lt;value&gt;. Ngược lại, thao tác tìm kiếm sử dụng cùng một &lt;value&gt; mà không có toán tử sẽ trả về tất cả các mục trong đó &lt;value&gt; khớp với giá trị của bất kỳ thuộc tính Chuỗi hoặc văn bản nào trong trường nội dung cho nguồn dữ liệu được lập chỉ mục. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
lessThanOperatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính ngày bằng toán tử nhỏ hơn. Ví dụ: nếu leastThanOperatorName là closedbefore và tên của thuộc tính là closedbefore, thì các truy vấn như closedbefore chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closedbefore sớm hơn closedbefore. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
greaterThanOperatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính ngày bằng toán tử lớn hơn. Ví dụ: nếu largeThanOperatorName là closeafter và tên của thuộc tính là closeDate, thì các truy vấn như closeafter:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closeDate muộn hơn <value>. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

TextPropertyOptions

Các tuỳ chọn cho thuộc tính văn bản.

Biểu diễn dưới dạng JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Trường
retrievalImportance

object (RetrievalImportance)

Cho biết tầm quan trọng về chất lượng tìm kiếm của các mã thông báo trong trường này khi dùng để truy xuất.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Nếu đặt, hãy mô tả cách sử dụng thuộc tính làm toán tử tìm kiếm.

RetrievalImportance

Biểu diễn dưới dạng JSON 
{
  "importance": enum (RetrievalImportance.Importance)
}
Trường
importance

enum (RetrievalImportance.Importance)

Cho biết tầm quan trọng của thứ hạng được cung cấp cho cơ sở lưu trú khi cơ sở lưu trú đó được so khớp trong quá trình truy xuất. Sau khi đặt, bạn sẽ không thể thay đổi mức độ quan trọng của mã thông báo cho một thuộc tính.

RetrievalImportance.Importance

Enum
DEFAULT Xem kết quả phù hợp như khớp văn bản nội dung.
HIGHEST Coi kết quả trùng khớp như một kết quả trùng khớp với tiêu đề của mặt hàng.
HIGH Coi kết quả phù hợp có tầm quan trọng cao hơn văn bản nội dung.
LOW Coi kết quả phù hợp có tầm quan trọng thấp hơn văn bản nội dung.
NONE Không khớp với trường này trong quá trình truy xuất. Bạn vẫn có thể sử dụng thuộc tính này để so khớp toán tử, phân thuộc tính và đề xuất nếu muốn.

TextPropertyOptions.TextOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các thuộc tính văn bản. Bạn không bắt buộc phải làm việc này. Toán tử query.search cho phép người dùng giới hạn truy vấn trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Trường
operatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính văn bản. Ví dụ: nếu toán tử tên là subject và tên của cơ sở lưu trú là subjectLine, thì các truy vấn như subject:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên subjectLine khớp với <value>. Ngược lại, thao tác tìm kiếm sử dụng cùng một &lt;value&gt; mà không có toán tử sẽ trả về tất cả các mục trong đó &lt;value&gt; khớp với giá trị của bất kỳ thuộc tính văn bản hoặc văn bản nào trong trường nội dung cho mục đó. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
exactMatchWithOperator

boolean

Nếu đúng, giá trị văn bản sẽ được mã hoá thành một giá trị nguyên tử trong các lượt tìm kiếm toán tử và so khớp thuộc tính. Ví dụ: nếu tên toán tử là "thể loại" và giá trị là "khoa học viễn tưởng" cụm từ tìm kiếm hạn chế "thể loại:khoa học" và "Thể loại:viễn tưởng" không khớp với mục; "thể loại:khoa học viễn tưởng" làm. Tính năng so khớp giá trị văn bản có phân biệt chữ hoa chữ thường và không xoá các ký tự đặc biệt. Nếu giá trị là false (sai), văn bản đó sẽ được mã hoá kỹ thuật số. Ví dụ: nếu giá trị là "khoa học viễn tưởng" các truy vấn "thể loại:khoa học" và "Thể loại:viễn tưởng" khớp với mục.

HtmlPropertyOptions

Tuỳ chọn cho thuộc tính html.

Biểu diễn dưới dạng JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Trường
retrievalImportance

object (RetrievalImportance)

Cho biết tầm quan trọng về chất lượng tìm kiếm của các mã thông báo trong trường này khi dùng để truy xuất. Chỉ có thể đặt thành DEFAULT hoặc NONE.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Nếu đặt, hãy mô tả cách sử dụng thuộc tính làm toán tử tìm kiếm.

HtmlPropertyOptions.HtmlOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các thuộc tính html. Bạn không bắt buộc phải làm việc này. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm trong một số trường cụ thể có liên quan đến loại mục đang được tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string
}
Trường
operatorName

string

Cho biết tên toán tử được yêu cầu trong truy vấn để tách biệt thuộc tính html. Ví dụ: nếu toán tử tên là subject và tên của cơ sở lưu trú là subjectLine, thì các truy vấn như subject:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên subjectLine khớp với <value>. Ngược lại, thao tác tìm kiếm sử dụng cùng một &lt;value&gt; mà không có toán tử sẽ trả về tất cả các mục trong đó &lt;value&gt; khớp với giá trị của bất kỳ thuộc tính html hoặc văn bản nào trong trường nội dung cho mục đó. Tên toán tử chỉ có thể chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

PropertyDisplayOptions

Các tuỳ chọn hiển thị cho một cơ sở lưu trú.

Biểu diễn dưới dạng JSON 
{
  "displayLabel": string
}
Trường
displayLabel

string

Nhãn thân thiện với người dùng cho thuộc tính được sử dụng nếu thuộc tính đó được chỉ định để hiển thị trong ObjectDisplayOptions. Nếu được cung cấp, nhãn hiển thị sẽ xuất hiện trước các giá trị của thuộc tính khi thuộc tính đó nằm trong các tuỳ chọn hiển thị đối tượng. Ví dụ: nếu giá trị thuộc tính là "1", thì bản thân giá trị đó có thể không hữu ích cho người dùng. Nếu tên hiển thị đã cho là "mức độ ưu tiên", thì người dùng sẽ thấy "mức độ ưu tiên : 1" trong kết quả tìm kiếm, cung cấp ngữ cảnh rõ ràng cho người dùng tìm kiếm. Đây là KHÔNG BẮT BUỘC; nếu không được cung cấp thì chỉ có các giá trị của thuộc tính được hiển thị. Độ dài tối đa là 64 ký tự.