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
  ]
}
Các 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ã nhận dạng của các hoạt động lâu 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 rồi mới lập chỉ mục nội dung bổ sung.

ObjectDefinition

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

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

string

Tên của đối tượng, sau đó sẽ xác định loại của đố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 tên là Tài liệu thì các 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 chữ cái và chỉ được chứa chữ cái (A-Z, a-z) hoặc 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 theo đối tượng.
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à 1.000.

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
  ]
}
Các 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ả Cloud Search.
suggestionFilteringOperators[]

string

Bạn có thể dùng các toán tử để 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ợ 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, bạn 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ợ 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ử mở rộng trên nhiều loại đối tượng, thì 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 làm mới nào cần 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 thì chất lượng càng cao. Sử dụng thuộc tính tùy 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à thời điểm phù hợp nhất. Đối với dữ liệu sự kiện trên lịch, thời điểm sự kiện xảy ra 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 với thời gian của cụm từ tìm kiếm hơn đượ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
}
Các 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 độ mới. Độ dài tối đa là 256 ký tự.

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

string (Duration format)

Thời lượng 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 có 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)
    }
  ]
}
Các 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 để cho biết loại mục. Đây là KHÔNG BẮT BUỘC; nếu không được cung cấp, nhãn đối tượng sẽ không 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 các thuộc tính được hiển thị trong siêu dữ liệu của kết quả tìm kiếm. Các giá trị thuộc tính hiển thị theo thứ tự đã cho ở đây. Nếu một thuộc tính chứa nhiều giá trị, tất cả các giá trị sẽ hiển thị trướ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 metaline tối đa là 3.

ObjectDisplayOptions.Metaline

Thẻ metaline là một 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)
    }
  ]
}
Các trường
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

Danh sách thuộc tính được hiển thị cho metaline. Số lượng thuộc tính 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ẽ 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ẽ hiển thị 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 một thuộc tính. Nếu bạn không chỉ định nhãn hiển thị thì chỉ có giá trị được hiển thị.

Biểu diễn dưới dạng JSON 
{
  "propertyName": string
}
Các 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 đã 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 về 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.
}
Các trường
name

string

Tên của thuộc tính. Những 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 với 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 được đă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 chữ cái và chỉ được 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 xác định dữ liệu sẽ được trả về trong kết quả tìm kiếm thông qua API Truy vấn. Nếu bạn đặt chính sách này thành true (đúng), hãy 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 phù hợp trong kết quả. Tuy nhiên, việc lưu trữ các trường đòi hỏi nhiều không gian hơn và sử dụng nhiều băng thông hơn cho các cụm từ tìm kiếm, từ đó ảnh hưởng đến hiệu suất của các tập dữ liệu lớn. Chỉ đặt thành true tại đây khi trường này là cần thiết cho kết quả tìm kiếm. Không thể đúng cho các thuộc tính có kiểu là một đối tượng.
isRepeatable

boolean

Cho biết tài sản này được phép sử dụng 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 được đúng cho các thuộc tính có kiểu là boolean. Nếu bạn đặt chính sách này thành false, thì những tài sản chứa nhiều giá trị sẽ khiến yêu cầu lập chỉ mục cho mặt hàng đó bị từ chối.
isSortable

boolean

Cho biết rằng bạn có thể dùng thuộc tính để sắp xếp. Không được đúng đối với các cơ sở lưu trú có thể lặp lại. Không thể đúng cho các thuộc tính có kiểu là đối tượng. IsReturnable phải có giá trị true để đặt tùy chọn này. Chỉ hỗ trợ 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 có thể dùng để tạo các thuộc tính. Không thể đúng cho các thuộc tính có kiểu là đối tượng. IsReturnable phải có giá trị true để đặt tùy 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 rằng bạn có thể dùng thuộc tính này để tạo các đề xuất truy vấn.
isWildcardSearchable

boolean

Cho biết rằng người dùng có thể thực hiện tìm kiếm theo ký tự đại diện cho tài sản này. Chỉ hỗ trợ các thuộc tính Văn bản. IsReturnable phải có giá trị true để đặt tùy chọn này. Trong một nguồn dữ liệu nhất định, tối đa 5 thuộc tính có thể được đánh dấu là ischaracterSearchable. Để biết thêm chi tiết, hãy xem phần Xác định thuộc tính của đố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ả Cloud Search nếu thuộc tính đó được chỉ định để hiển thị trong display options của đối tượng.
Trường nhóm property_options. Các tuỳ chọn theo loại cụ thể giúp xác định cách lập chỉ mục và sử dụng tài sản. Trong trường hợp các tuỳ chọn nê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ông tin 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 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)
  }
}
Các 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 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. Những 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 với trọng số tương đương với các mục được lập chỉ mục với 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. 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à xếp hạng với cùng trọng số với các mục được lập chỉ mục với 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 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 cần đượ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 cao hơn cho thấy tầm quan trọng lớn hơn. Ví dụ: đối với một số nguồn dữ liệu, mức độ ưu tiên càng thấp thì mức độ quan trọng càng cao, còn đối với những nguồn dữ liệu 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ú này. Kết quả không được điều chỉnh theo giá trị của tài sản này.
ASCENDING Cơ sở lưu trú 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. Thao tác này là không bắt buộc. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm ở các 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
}
Các trường
operatorName

string

Cho biết tên toán tử cần có trong truy vấn để tách biệt thuộc tính số nguyên. Ví dụ: nếu toán tử tên là ưu tiên và tên thuộc tính là ưu tiên, thì các truy vấn như ưu tiên:<giá_trị> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên ưu tiênVal khớp với <giá_trị>. Ngược lại, tìm kiếm sử dụng cùng một <giá_trị> mà không có toán tử sẽ trả về tất cả các mục trong đó <giá_trị> 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 các 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 cách sử dụng toán tử nhỏ hơn. Ví dụ: nếu lessThanOperatorName là Prioritybên dưới và tên thuộc tính là PriorityVal, thì các truy vấn như đã được ưu tiên:<giá trị>, chỉ hiển thị kết quả khi giá trị của thuộc tính có tên ưu tiênVal nhỏ hơn <value>. 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ự.
greaterThanOperatorName

string

Cho biết tên toán tử cần 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 growThanOperatorName là Prioritytop và tên thuộc tính là PriorityVal, thì các truy vấn như Prioritytop:<value> lại 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 chứa chữ thường (a-z). Độ dài tối đa là 32 ký tự.

DoublePropertyOptions

Các lựa chọn cho cơ sở lưu trú kép.

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

object (DoublePropertyOptions.DoubleOperatorOptions)

Nếu được đặt, hãy mô tả cách sử dụng toán tử 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 thuộc tính kép. Thao tác này là không bắt buộc. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm ở các 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
}
Các 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 dưới dạng thuộc tính. Tên toán tử chỉ có thể chứa các 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)
  }
}
Các trường
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Nếu được đặt, hãy mô tả cách 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. Thao tác này là không bắt buộc. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm ở các 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
}
Các trường
operatorName

string

Cho biết tên toán tử cần có 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 thuộc tính là closeDate, thì các truy vấn như closeon:<value> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên closeDate khớp với <value>. Ngược lại, một lượt tìm kiếm sử dụng cùng <value> mà không có toán tử sẽ trả về tất cả các mục trong đó <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 mục đó. Tên toán tử chỉ có thể chứa các 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ần có 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 lessThanOperatorName là closebefore và tên thuộc tính là closeDate, thì các truy vấn như closebefore:<value> sẽ chỉ hiển thị kết quả khi giá trị của thuộc tính có tên là closeDate sớm hơn <value>. 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ự.
greaterThanOperatorName

string

Cho biết tên toán tử cần có trong truy vấn để phân tách thuộc tính dấu thời gian bằng toán tử lớn hơn. Ví dụ: nếulargeThanOperatorName là closeafter và tên thuộc tính là closeDate, thì các truy vấn như Closedafter:<value> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên closeDate sau <value>. 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ự.

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)
  }
}
Các 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. Thao tác này là không bắt buộc. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm ở các 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
}
Các trường
operatorName

string

Cho biết tên toán tử bắt buộc trong truy vấn để tách biệt thuộc tính boolean. Ví dụ: nếu Toán tử là đóng và tên thuộc tính là isClosed, thì các truy vấn như đã đóng:<value> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên là isClosed khớp với <value>. Ngược lại, một tìm kiếm sử dụng cùng <value> mà không có toán tử sẽ trả về tất cả các mục trong đó <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 mục đó. Tên toán tử chỉ có thể chứa các 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 của đối tượng.

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

object (PropertyDefinition)

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ể được đặt tên là street, city và state. Số lượng phần tử tối đa là 1.000.

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 truy vấn 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ử cần 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ó 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 mức độ ưu tiên, bạn có thể xác định p0 là giá trị enum được phép và gắn enum này với tên toán tử Priority sao cho người dùng tìm kiếm có thể thêm Priority:p0 vào truy vấn nhằm giới hạn tập hợp kết quả ở 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)
  }
}
Các trường
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

Danh sách các giá trị có thể sử dụng 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 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 đề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 giá trị enum trong tương lai, hãy để trống các giá trị số nguyên ban đầu để cho phép thêm 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ự của bảng liệt kê giúp xác định cách dùng các giá trị số nguyên đã cung cấp trong EnumValuePairs có thể dùng để xếp hạng kết quả. Nếu được chỉ định, bạn phải cung cấp giá trị số nguyên tương ứng với tất cả giá trị EnumValuePair có thể có được cung cấp cho thuộc tính này. Chỉ có thể sử dụng nếu isRepeatable 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 thứ: 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 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, chẳng hạn 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ị liệt kê khác cho cùng tên thuộc tính. Ở đây, thứ tự xếp hạng của MÔ TẢ NGẮN đối với các thuộc tính ưu tiên sẽ giúp tăng thứ hạng của các mục được lập chỉ mục với 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 chỉ định, giá trị số nguyên 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
}
Các 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ố â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 càng thấp thì mức độ quan trọng càng cao, trong khi ở những thuộc tính khác, số nguyê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ú này. Kết quả không được điều chỉnh theo giá trị của thuộc tính này.
ASCENDING Cơ sở lưu trú 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. Thao tác này là không bắt buộc. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm ở các 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 có các giá trị có thể có là p0 và p1, thì truy vấn chứa thuật ngữ p0 sẽ trả về các mục có p0 là 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ư Priority, 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ó giá trị thuộc tính này là p0, với truy vấn Priority:p0.

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

string

Cho biết tên toán tử cần có trong truy vấn để tách biệt thuộc tính enum. Ví dụ: nếu toán tử tên là ưu tiên và tên thuộc tính là ưu tiên, thì các truy vấn như ưu tiên:<giá_trị> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên ưu tiênVal khớp với <giá_trị>. Ngược lại, tìm kiếm sử dụng cùng một <giá_trị> mà không có toán tử sẽ trả về tất cả các mục trong đó <giá_trị> 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 các chữ cái viết thường (a-z). Độ dài tối đa là 32 ký tự.

DatePropertyOptions

Tuỳ chọn cho thuộc tính ngày.

Biểu diễn dưới dạng JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Các 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 cụm từ tìm kiếm ở các trường cụ thể có liên quan đến loại mục đang tìm kiếm.

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

string

Cho biết chuỗi thực tế cần có 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 vấn đề có một thuộc tính có tên là closeDate chỉ định một toán tử có toán tử là closedon. Đối với các lượt tìm kiếm về dữ liệu đó, những truy vấn như closedon:<value> chỉ hiển thị kết quả trong đó 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 trong đó <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 đã lập chỉ mục. Tên toán tử chỉ có thể chứa các 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à closebefore và tên thuộc tính là closeDate, thì các truy vấn như closebefore:<value> sẽ chỉ hiển thị kết quả khi giá trị của thuộc tính có tên là closeDate sớm hơn <value>. 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ự.
greaterThanOperatorName

string

Cho biết tên toán tử bắt buộc trong truy vấn để phân tách thuộc tính ngày bằng toán tử lớn hơn. Ví dụ: nếulargeThanOperatorName là closeafter và tên thuộc tính là closeDate, thì các truy vấn như Closedafter:<value> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên closeDate sau <value>. 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ự.

TextPropertyOptions

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)
  }
}
Các 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 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 làm toán tử tìm kiếm.

RetrievalImportance

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

enum (RetrievalImportance.Importance)

Cho biết tầm quan trọng của việc xếp hạng tài sản khi tài sản đó được so khớp trong quá trình truy xuất. Sau khi đặt, bạn sẽ không thể thay đổi tầm quan trọng của mã thông báo của một thuộc tính.

RetrievalImportance.Importance

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

TextPropertyOptions.TextOperatorOptions

Dùng để cung cấp toán tử tìm kiếm cho thuộc tính văn bản. Thao tác này là không bắt buộc. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm ở các 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
}
Các trường
operatorName

string

Cho biết tên toán tử cần có trong truy vấn để tách biệt thuộc tính văn bản. Ví dụ: nếu tên Toán tử là subject và tên thuộc tính là subjectLine, thì các truy vấn như subject:<value> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên subjectLine khớp với <value>. Ngược lại, một lần 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 trong đó <value> khớp với giá trị của mọi thuộc tính văn bản hoặc văn bản trong trường nội dung cho mặt hàng đó. Tên toán tử chỉ có thể chứa các 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à 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", thì hạn chế truy vấn "thể loại:khoa học" và "thể loại:thể loại tiểu thuyết" không khớp với mục; thể loại:"khoa học viễn tưởng" sẽ không khớp với mục. 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 sai, văn bản sẽ được mã hoá. Ví dụ: nếu giá trị là "Khoa học viễn tưởng", thì các cụm từ tìm kiếm "thể loại:khoa học" và "thể loại:tiểu thuyết" 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)
  }
}
Các 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 khi được dùng để truy xuất. Chỉ có thể đặt thành DEFAULT hoặc NONE.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Nếu được đặ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. Thao tác này là không bắt buộc. Toán tử query.search cho phép người dùng giới hạn cụm từ tìm kiếm ở các 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
}
Các trường
operatorName

string

Cho biết tên toán tử cần có trong truy vấn để tách riêng thuộc tính html. Ví dụ: nếu tên Toán tử là subject và tên thuộc tính là subjectLine, thì các truy vấn như subject:<value> chỉ hiển thị kết quả trong đó giá trị của thuộc tính có tên subjectLine khớp với <value>. Ngược lại, một lần tìm kiếm sử dụng cùng <value> mà không có toán tử sẽ trả về tất cả các mục trong đó <value> khớp với giá trị của mọi thuộc tính html hoặc văn bản trong trường nội dung của mặt hàng đó. Tên toán tử chỉ có thể chứa các 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
}
Các 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ẽ hiện trước các giá trị thuộc tính khi thuộc tính này là một phần của các lựa chọn hiển thị đối tượng. Ví dụ: nếu giá trị thuộc tính là "1", thì giá trị đó có thể không hữu ích cho người dùng. Nếu tên hiển thị đã cung cấp có giá trị "mức độ ưu tiên" thì người dùng sẽ thấy giá trị "mức độ ưu tiên : 1" trong kết quả tìm kiếm, điều này cung cấp ngữ cảnh rõ ràng cho người dùng tìm kiếm. Giá trị này là KHÔNG BẮT BUỘC; nếu không được cung cấp, thì chỉ các giá trị thuộc tính được hiển thị. Độ dài tối đa là 64 ký tự.