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 các đố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 Thao tác thực hiện lâu (LRO) đ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 cho 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 của đối tượng, sau đó xác định loại đối tượng. Các 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 name là Document, thì các yêu cầu lập chỉ mục cho các mục thuộc loại Document phải đặt objectType bằng Document. Mỗi định nghĩa đối tượng phải có tên riêng biệt trong một giản đồ. Tên phải bắt đầu bằng một chữ cái và chỉ có thể 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 không bắt buộc dành riêng cho đối tượng.
propertyDefinitions[]

object (PropertyDefinition)

Đị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 về độ 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ị trong trang kết quả của Cloud Search.
suggestionFilteringOperators[]

string

Các toán tử có thể dùng để lọc nội dung đề xuất. Đối với API query.suggest, chỉ những toán tử được đề cập ở đây mới được thực thi trong FilterOptions. Chỉ hỗ trợ 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 bạn chỉ có thể chỉ định một toán tử. Đây là một mảng để mở rộng trong tương lai.

Không hỗ trợ các 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 dài 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 thuộc tính độ mới nào sẽ được sử dụng 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, càng gần đây cho thấy chất lượng càng cao. Sử dụng thuộc tính tuỳ chọn về độ 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à thông tin liên quan nhất. Đối với dữ liệu sự kiện trên lịch, thời điểm xảy ra sự kiện là chỉ báo độ mới mẻ phù hợp hơn. Bằng cách này, những sự kiện trên lịch diễn ra gần với thời điểm của cụm từ tìm kiếm sẽ được coi 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 độ 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 độ mới. Độ dài tối đa là 256 ký tự.

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

string (Duration format)

Thời lượng sau đó một đối tượng sẽ được coi là cũ. 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, có tối đa 9 chữ số thập phân, 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 để hiển thị trong kết quả tìm kiếm nhằm cho biết loại của mục. Đây là thông tin KHÔNG BẮT BUỘC; nếu không được cung cấp, nhãn đối tượng sẽ không xuất hiện 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 các thuộc tính hiển thị trong dòng siêu dữ liệu 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 đưa ra tại đây. Nếu một thuộc tính chứa nhiều giá trị, thì tất 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ả các thuộc tính phải đặt isReturnable thành true. Số lượng dòng siêu dữ liệu tối đa là 3.

ObjectDisplayOptions.Metaline

Dòng siêu dữ liệu là danh sách các thuộc tính 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 các thuộc tính hiển thị cho metaline. Số lượng tài sản tối đa là 5.

ObjectDisplayOptions.DisplayedProperty

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

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 đượ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à thuộc tính được xác định trong giản đồ, thì hệ thống sẽ báo lỗi khi bạn cố gắng cập nhật giản đồ.

PropertyDefinition

Định nghĩa của một thuộc tính trong đố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ì các yêu cầu lập chỉ mục cho các mục tài liệu có trường chủ đề 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ể sử 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ó thể chứa chữ cái (A-Z, a-z) hoặc số (0-9). Độ dài tối đa là 256 ký tự.
isReturnable

boolean

Cho biết rằng thuộc tính này xác định dữ liệu cần được trả về trong kết quả tìm kiếm thông qua Query API. Nếu được đặt thành true, thì cho biết rằng người dùng API truy vấn 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ữ các trường đòi hỏi phải phân bổ nhiều dung lượng 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 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 này cho phép 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 giá trị này thành false, thì các 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 có thể được dùng để sắp xếp. Không thể là đúng đối với các thuộc tính có thể lặp lại. Không thể là đúng đối với các thuộc tính có loại là đối tượng. Bạn phải đặt IsReturnable thành true để đặt tuỳ chọn này. Chỉ hỗ trợ cho các thuộc tính boolean, ngày, double, số nguyên và dấu thời gian.
isFacetable

boolean

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

boolean

Cho biết rằng bạn có thể sử dụng thuộc tính này để tạo cụm từ tìm kiếm được đề xuất.
isWildcardSearchable

boolean

Cho biết người dùng có thể tìm kiếm bằng ký tự đại diện cho tài sản này. Chỉ hỗ trợ cho tài sản Văn bản. Bạn phải đặt IsReturnable thành 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 thuộc tính là isWildcardSearchable. Để biết thêm thông tin chi tiết, hãy xem phần Xác định thuộc tính đối tượng
displayOptions

object (PropertyDisplayOptions)

Các tuỳ chọn xác định cách hiển thị thuộc tính trong trang kết quả của Cloud Search nếu thuộc tính đó được chỉ định hiển thị trong display options của đối tượng.
Trường hợp hợp nhất property_options. Các tuỳ chọn dành riêng cho loại xác định cách lập chỉ mục và sử dụng thuộc tính. Trong trường hợp các tuỳ chọn phải là tuỳ 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, các bản cập nhật giản đồ sẽ bị từ chối. property_options chỉ có thể là một trong những loại sau:
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 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 đã sắp xếp cho số nguyên. Chỉ có thể sử dụng nếu isRepeatable là sai.
minimumValue

string (Int64Value format)

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

string (Int64Value format)

Giá trị tối đa của thuộc tính. Giá trị tối thiểu và tối đa của thuộc tính này được dùng để xếp hạng kết quả theo ordered ranking. Các 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 bằng trọng số tương tự như các mục được lập chỉ mục bằng giá trị tối đa.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

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

object (IntegerFacetingOptions)

Nếu được đặt, mô tả các tuỳ chọn phân tích theo phương diện 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ứ hạng được sắp xếp cao hơn cho biết mức độ quan trọng cao hơn. Ví dụ: trong một số nguồn dữ liệu, mức độ ưu tiên thấp hơn cho biết mức độ quan trọng cao hơn, trong khi ở một số nguồn dữ liệu khác, mức độ ưu tiên cao hơn cho biết mức độ quan trọng cao hơn.

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 Thuộc tính này được xếp hạng theo thứ tự tăng dần. Giá trị thấp hơn cho biết thứ hạng thấp hơn.
DESCENDING Thuộc tính 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. Đây là phần không bắt buộc. Toán tử query.search cho phép người dùng hạn chế truy vấn ở một số trường cụ thể liên quan đến loại mặt hàng đ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ử bắt buộc trong truy vấn để tách riêng thuộc tính số nguyên. Ví dụ: nếu operatorName là priority và tên của thuộc tính là priorityVal, thì các cụm từ tìm kiếm như priority:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên priorityVal khớp với <value>. Ngược lại, một cụm từ tìm kiếm sử dụng cùng một <value> mà không có toán tử sẽ trả về tất cả các mục mà <value> 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 của mục đó. Tên toán tử chỉ được 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ử bắt buộc trong truy vấn để tách riêng thuộc tính số nguyên bằng toán tử nhỏ hơn. Ví dụ: nếu lessThanOperatorName là prioritybelow và tên của thuộc tính là priorityVal, thì các truy vấn như prioritybelow:<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ử bắt buộc trong truy vấn để tách riêng thuộc tính số nguyên bằng toán tử lớn hơn. Ví dụ: nếu greaterThanOperatorName là priorityabove và tên thuộc tính là priorityVal, thì các cụm từ tìm kiếm như priorityabove:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên 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 thuộc tính kép.

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

object (DoublePropertyOptions.DoubleOperatorOptions)

Nếu được đặt, hãy mô tả cách sử dụng dấu nhân đôi 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. Đây là phần không bắt buộc. Toán tử query.search cho phép người dùng hạn chế truy vấn ở một số trường cụ thể liên quan đến loại mặt hàng đ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ử bắt buộc trong truy vấn để sử dụng thuộc tính kép trong việc sắp xếp hoặc làm một phương diện. Tên toán tử chỉ được chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

TimestampPropertyOptions

Các tuỳ chọn cho 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 được đặ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. Đây là phần không bắt buộc. Toán tử query.search cho phép người dùng hạn chế truy vấn ở một số trường cụ thể liên quan đến loại mặt hàng đ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ử bắt buộc trong truy vấn để tách riêng thuộc tính dấu thời gian. Ví dụ: nếu operatorName là closedon và tên của thuộc tính là closeDate, thì các cụm từ tìm kiếm như closedon:<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, một cụm từ tìm kiếm sử dụng cùng một <value> mà không có toán tử sẽ trả về tất cả các mục mà <value> 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 của mục đó. Tên toán tử chỉ được 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ử bắt buộc trong truy vấn để tách riêng thuộc tính dấu thời gian bằng toán tử nhỏ hơn. Ví dụ: nếu lessThanOperatorName là closedbefore và tên của thuộc tính là closeDate, thì các cụm từ tìm kiếm như closedbefore:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closeDate sớm 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ử bắt buộc trong truy vấn để tách riêng thuộc tính dấu thời gian bằng toán tử lớn hơn. Ví dụ: nếu greaterThanOperatorName là closedafter và tên thuộc tính là closeDate, thì các cụm từ tìm kiếm như closedafter:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closeDate 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ự.

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 được đặt, hãy 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. Đây là phần không bắt buộc. Toán tử query.search cho phép người dùng hạn chế truy vấn ở một số trường cụ thể liên quan đến loại mặt hàng đ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ử bắt buộc trong truy vấn để tách riêng thuộc tính boolean. Ví dụ: nếu operatorName là closed và tên của thuộc tính là isClosed, thì các truy vấn như closed:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên isClosed khớp với <value>. Ngược lại, một lượt tìm kiếm sử dụng cùng một <value> mà không có toán tử sẽ trả về tất cả các mục mà <value> 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 của mục đó. Tên toán tử chỉ được 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 lồng nhau. Ví dụ: nếu thuộc tính này đại diện cho địa chỉ bưu chính, thì subobjectProperties có thể được đặt tên là street (đường), city (thành phố) và state (tiểu bang). Số lượng phần tử tối đa là 1000.

EnumPropertyOptions

Các tuỳ chọn cho 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ế để khớp với cụm từ tìm kiếm của người dùng, đặt thứ hạng cho các giá trị chuỗi đó và xác định tên toán tử để ghép nối với các chuỗi đó để người dùng có thể thu hẹp kết quả chỉ còn các mục có một 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 về mức độ ư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 tên toán tử priority để người dùng tìm kiếm có thể thêm priority:p0 vào truy vấn của họ nhằm hạn chế tập hợp kết quả chỉ bao gồm những mục được lập chỉ mục bằng 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 EnumValuePair, thì tất cả EnumValuePairs có thể phải cung cấp một giá trị số nguyên. Cả giá trị chuỗi và giá trị số nguyên phải là duy nhất trong 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à nghĩ rằng có thể chèn thêm các giá trị enum trong tương lai, hãy để khoảng trống trong các giá trị số nguyên ban đầu để cho phép thêm giá trị 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 được sắp xếp cho enum xác định cách sử dụng các giá trị số nguyên được cung cấp trong 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ả giá trị EnumValuePair có thể có được cho thuộc tính này. Chỉ có thể sử dụng nếu isRepeatable là sai.
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Nếu được đặ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 giá trị: một giá trị chuỗi bắt buộc và một 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 cho 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ị 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 để đặt thứ hạng của một giá trị nhất định 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 là XUỐNG cho các thuộc tính priority (ưu tiên) sẽ giúp tăng thứ hạng cho các mục được lập chỉ mục bằng giá trị p0 so với các mục được lập chỉ mục bằng giá trị p1. Nếu không có thứ tự xếp hạng được chỉ định, giá trị số nguyên sẽ không ảnh hưởng đến thứ hạng của 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 phải là số không âm. Không bắt buộc.

EnumPropertyOptions.OrderedRanking

Dùng để chỉ định hướng xếp hạng cho 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 mức độ quan trọng cao hơn, trong khi đối với một số thuộc tính khác, giá trị số nguyên cao hơn cho biết mức độ quan trọng cao hơn.

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 Thuộc tính này được xếp hạng theo thứ tự tăng dần. Giá trị thấp hơn cho biết thứ hạng thấp hơn.
DESCENDING Thuộc tính 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. Đây là phần không bắt buộc. Toán tử query.search cho phép người dùng hạn chế truy vấn ở một số trường cụ thể liên quan đến loại mặt hàng đ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 priority có các giá trị có thể có là p0 và p1, thì truy vấn chứa cụm từ p0 sẽ trả về các mục có p0 làm giá trị của thuộc tính priority, cũng như mọi mục 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ư priority, thì người dùng tìm kiếm có thể sử dụng toán tử đó để chỉ tìm kiếm các mục có p0 làm 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ử bắt buộc trong truy vấn để tách riêng thuộc tính enum. Ví dụ: nếu operatorName là priority và tên của thuộc tính là priorityVal, thì các cụm từ tìm kiếm như priority:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên priorityVal khớp với <value>. Ngược lại, một cụm từ tìm kiếm sử dụng cùng một <value> mà không có toán tử sẽ trả về tất cả các mục mà <value> 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 của mục đó. Tên toán tử chỉ được chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

DatePropertyOptions

Các tuỳ chọn cho 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 được đặt, hãy mô tả cách sử dụng ngày làm toán tử tìm kiếm.

DatePropertyOptions.DateOperatorOptions

Không bắt buộc. Cung cấp 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 truy vấn ở một số trường cụ thể 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ế cần thiết trong truy vấn để tách riêng thuộc tính ngày. Ví dụ: giả sử một đối tượng giản đồ theo dõi lỗi có một thuộc tính tên là closeDate chỉ định một toán tử có operatorName là closedon. Đối với các lượt tìm kiếm trên dữ liệu đó, các truy vấn như closedon:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính closeDate khớp với <value>. Ngược lại, một lượt tìm kiếm sử dụng cùng một <value> mà không có toán tử sẽ trả về tất cả các mục mà <value> 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 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ử bắt buộc trong truy vấn để tách riêng thuộc tính ngày bằng toán tử nhỏ hơn. Ví dụ: nếu lessThanOperatorName là closedbefore và tên của thuộc tính là closeDate, thì các cụm từ tìm kiếm như closedbefore:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closeDate sớm 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ử bắt buộc trong truy vấn để tách riêng thuộc tính ngày bằng toán tử lớn hơn. Ví dụ: nếu greaterThanOperatorName là closedafter và tên thuộc tính là closeDate, thì các cụm từ tìm kiếm như closedafter:<value> chỉ hiển thị kết quả khi giá trị của thuộc tính có tên closeDate 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ự.

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 của chất lượng tìm kiếm của các mã thông báo trong trường khi được dùng để truy xuất.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Nếu được đặt, hãy mô tả cách sử dụng thuộc tính này 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 thuộc tính khi thuộc tính đó được so khớp trong quá trình truy xuất. Sau khi đặt, bạn không thể thay đổi tầm quan trọng của mã thông báo đối với một tài sản.

RetrievalImportance.Importance

Enum
DEFAULT Xem xét kết quả trùng khớp như một kết quả trùng khớp với văn bản nội dung.
HIGHEST Xem kết quả khớp như một kết quả khớp với tiêu đề của mặt hàng.
HIGH Xem xét nội dung khớp có mức độ quan trọng cao hơn văn bản nội dung.
LOW Xem xét nội dung khớp có mức độ quan trọng thấp hơn so với văn bản nội dung.
NONE Không so 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 nhóm và đề xuất nếu muốn.

TextPropertyOptions.TextOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho các tài sản dạng văn bản. Đây là phần không bắt buộc. Toán tử query.search cho phép người dùng hạn chế truy vấn ở một số trường cụ thể liên quan đến loại mặt hàng đ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ử bắt buộc trong truy vấn để tách riêng thuộc tính văn bản. Ví dụ: nếu operatorName là subject và tên của thuộc tính là subjectLine, thì các cụm từ tìm kiếm 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, một cụm từ tìm kiếm sử dụng cùng một <value> mà không có toán tử sẽ trả về tất cả các mục mà <value> 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 của mục đó. Tên toán tử chỉ được chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.
exactMatchWithOperator

boolean

Nếu giá trị là true, 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 bằng toán tử và các lượt khớp theo phương diện. Ví dụ: nếu tên toán tử là "genre" (thể loại) và giá trị là "science-fiction" (khoa học viễn tưởng), thì các quy tắc hạn chế truy vấn "genre:science" (thể loại:khoa học) và "genre:fiction" (thể loại:viễn tưởng) sẽ không khớp với mục này; còn "genre:science-fiction" (thể loại:khoa học viễn tưởng) thì khớp. Việc 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, văn bản sẽ được tạo mã thông báo. Ví dụ: nếu giá trị là "khoa học viễn tưởng", thì cụm từ tìm kiếm "thể loại:khoa học" và "thể loại:viễn tưởng" sẽ khớp với mục đó.

HtmlPropertyOptions

Các 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 của chất lượng tìm kiếm của các mã thông báo trong trường khi được dùng để truy xuất. Chỉ có thể đặt thành MẶC ĐỊNH hoặc KHÔNG.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Nếu được đặt, hãy mô tả cách sử dụng thuộc tính này 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. Đây là phần không bắt buộc. Toán tử query.search cho phép người dùng hạn chế truy vấn ở một số trường cụ thể liên quan đến loại mặt hàng đ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ử bắt buộc trong truy vấn để tách riêng thuộc tính html. Ví dụ: nếu operatorName là subject và tên của thuộc tính là subjectLine, thì các cụm từ tìm kiếm 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, một cụm từ tìm kiếm sử dụng cùng một <value> mà không có toán tử sẽ trả về tất cả các mục mà <value> 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 của mục đó. Tên toán tử chỉ được chứa chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

PropertyDisplayOptions

Các lựa 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ị thuộc tính khi thuộc tính đó là một phần của 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 phải là ngữ cảnh hữu ích cho người dùng. Nếu tên hiển thị được cung cấp là "priority" (mức độ ưu tiên), thì người dùng sẽ thấy "priority : 1" (mức độ ưu tiên: 1) trong kết quả tìm kiếm. Tên này cung cấp ngữ cảnh rõ ràng cho người dùng tìm kiếm. Đây là thông tin KHÔNG BẮT BUỘC; nếu không được cung cấp, hệ thống sẽ chỉ hiển thị các giá trị thuộc tính. Độ dài tối đa là 64 ký tự.