Schema

A definição do esquema para uma fonte de dados.

Representação JSON 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Campos
objectDefinitions[]

object (ObjectDefinition)

A lista de objetos de nível superior da fonte de dados. O número máximo de elementos é 10.
operationIds[]

string

IDs das operações de longa duração (LROs, na sigla em inglês) atualmente em execução para este esquema. Depois de modificar o esquema, aguarde a conclusão das operações antes de indexar conteúdos adicionais.

ObjectDefinition

A definição de um objeto em uma fonte de dados.

Representação JSON 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Campos
name

string

O nome do objeto, que define seu tipo. As solicitações de indexação de itens precisam definir o campo objectType igual a esse valor. Por exemplo, se name for Document, as solicitações de indexação de itens do tipo "Document" precisarão definir objectType igual a Document. Cada definição de objeto precisa ter um nome exclusivo em um esquema. O nome precisa começar com uma letra e só pode conter letras (A-Z, a-z) ou números (0-9). O tamanho máximo é de 256 caracteres.
options

object (ObjectOptions)

As opções opcionais específicas do objeto.
propertyDefinitions[]

object (PropertyDefinition)

As definições de propriedade para o objeto. O número máximo de elementos é 1.000.

ObjectOptions

As opções de um objeto.

Representação JSON 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Campos
freshnessOptions

object (ObjectOptions.FreshnessOptions)

As opções de atualização de um objeto.
displayOptions

object (ObjectDisplayOptions)

As opções que determinam como o objeto é exibido na página de resultados do Cloud Search.
suggestionFilteringOperators[]

string

Operadores que podem ser usados para filtrar sugestões. Para a API query.suggest, somente os operadores mencionados aqui serão seguidos no FilterOptions. Somente os operadores TEXT e ENUM são compatíveis.

OBSERVAÇÃO: "objecttype", "type" e "mimetype" já são suportados. Essa propriedade configura operadores específicos do esquema.

Ainda que seja uma matriz, apenas um operador pode ser especificado. Esta é uma matriz para extensibilidade futura.

Não há suporte para o mapeamento de operadores para várias propriedades no mesmo objeto. Se o operador se estender por diferentes tipos de objetos, essa opção precisará ser definida uma vez para cada definição de objeto.

ObjectOptions.FreshnessOptions

Indica qual propriedade de atualização deve ser usada ao ajustar a classificação de pesquisa de um item. Datas mais recentes e mais recentes indicam uma qualidade mais alta. Use a propriedade de opção de atualização que melhor funciona com seus dados. Para documentos com compartilhamento de arquivos, o horário da última modificação é o mais relevante. Para dados de eventos da agenda, o horário em que o evento ocorre é um indicador de atualização mais relevante. Dessa forma, os eventos da agenda que ocorrem mais perto do horário da consulta de pesquisa são considerados de maior qualidade e classificados de acordo com isso.

Representação JSON 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Campos
freshnessProperty

string

Esta propriedade indica o nível de atualização do objeto no índice. Se definida, essa propriedade precisa ser de nível superior dentro do property definitions e precisa ser timestamp type ou date type. Caso contrário, a API Indexing vai usar updateTime como o indicador de atualização. O tamanho máximo é de 256 caracteres.

Quando uma propriedade é usada para calcular a atualização, o valor padrão é de dois anos a partir do horário atual.
freshnessDuration

string (Duration format)

Período após o qual um objeto deve ser considerado desatualizado. O valor padrão é 180 dias (em segundos).

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

ObjectDisplayOptions

As opções de exibição de um objeto.

Representação JSON 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Campos
objectDisplayLabel

string

É o rótulo fácil de usar que aparece no resultado da pesquisa para indicar o tipo do item. Isso é OPCIONAL; Se não for fornecido, um rótulo de objeto não será exibido na linha de contexto dos resultados da pesquisa. O tamanho máximo é de 64 caracteres.
metalines[]

object (ObjectDisplayOptions.Metaline)

Define as propriedades que são exibidas nas metalinhas dos resultados da pesquisa. Os valores das propriedades são exibidos na ordem informada aqui. Se uma propriedade tiver vários valores, todos eles serão exibidos antes das próximas propriedades. Por esse motivo, é uma boa prática especificar propriedades singulares antes das repetidas na lista. Todas as propriedades precisam definir isReturnable como "true". O número máximo de metalinhas é três.

ObjectDisplayOptions.Metaline

Uma metaline é uma lista de propriedades exibidas junto com o resultado da pesquisa para fornecer contexto.

Representação JSON 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Campos
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

A lista de propriedades exibidas para a metaline. O número máximo de propriedades é cinco.

ObjectDisplayOptions.DisplayedProperty

Uma referência a uma propriedade de nível superior dentro do objeto que deve ser exibida nos resultados da pesquisa. Os valores das propriedades escolhidas são exibidos nos resultados da pesquisa com o display label dessa propriedade, se houver um especificado. Se um rótulo de exibição não for especificado, apenas os valores serão mostrados.

Representação JSON 
{
  "propertyName": string
}
Campos
propertyName

string

O nome da propriedade de nível superior conforme definido em uma definição de propriedade para o objeto. Se o nome não for uma propriedade definida no esquema, um erro será exibido ao tentar atualizar o esquema.

PropertyDefinition

A definição de uma propriedade dentro de um objeto.

Representação 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.
}
Campos
name

string

O nome da propriedade. As solicitações de indexação de itens enviadas à API Indexing precisam definir property name igual a esse valor. Por exemplo, se o nome for subject_line, as solicitações de indexação de itens de documentos com campos de assunto deverão definir name para esse campo igual a subject_line. Use o nome como o identificador da propriedade do objeto. Depois de registrado como uma propriedade para um objeto, você não pode reutilizar esse nome para outra propriedade dentro desse objeto. O nome precisa começar com uma letra e só pode conter letras (A-Z, a-z) ou números (0-9). O tamanho máximo é de 256 caracteres.
isReturnable

boolean

Indica que a propriedade identifica os dados que devem ser retornados nos resultados da pesquisa por meio da API Query. Se definido como true, indica que os usuários da API de consulta podem usar campos de propriedade correspondentes nos resultados. No entanto, o armazenamento de campos requer mais alocação de espaço e usa mais largura de banda para consultas de pesquisa, o que afeta o desempenho em grandes conjuntos de dados. Defina como true aqui somente se o campo for necessário para os resultados da pesquisa. Não pode ser verdadeiro para propriedades com um tipo de objeto.
isRepeatable

boolean

Indica que diversos valores são permitidos para a propriedade. Por exemplo, um documento tem apenas uma descrição, mas pode ter vários comentários. Não pode ser verdadeiro para propriedades com o tipo booleano. Se definida como falsa, as propriedades que contêm mais de um valor farão com que a solicitação de indexação desse item seja rejeitada.
isSortable

boolean

Indica que a propriedade pode ser usada para classificação. Não pode ser verdadeiro para propriedades que são repetíveis. Não pode ser verdadeiro para propriedades com o tipo objeto. IsReturnable precisa ser verdadeiro para definir essa opção. Compatível apenas com propriedades booleanas, de data, duplas, inteiras e de carimbo de data/hora.
isFacetable

boolean

Indica que a propriedade pode ser usada para gerar atributos. Não pode ser verdadeiro para propriedades com o tipo objeto. IsReturnable precisa ser verdadeiro para definir essa opção. Compatível apenas com propriedades booleanas, de tipo enumerado, de números inteiros e de texto.
isSuggestable

boolean

Indica que a propriedade pode ser usada para gerar sugestões de consulta.
isWildcardSearchable

boolean

Indica que os usuários podem realizar uma pesquisa de caracteres curinga para essa propriedade. Compatível apenas com propriedades de texto. IsReturnable precisa ser verdadeiro para definir essa opção. Em uma determinada fonte de dados, no máximo 5 propriedades podem ser marcadas como is curingaSearchable. Para mais detalhes, consulte Definir propriedades de objetos.
displayOptions

object (PropertyDisplayOptions)

As opções que determinam como a propriedade será exibida na página de resultados do Cloud Search, se estiver especificada para exibição no display options do objeto.
Campo de união property_options. As opções específicas do tipo que determinam como a propriedade é indexada e usada. Caso as opções sejam as opções padrão de um tipo, esse campo ainda precisará ser definido como um dos tipos. Se este campo não for definido, as atualizações do esquema serão rejeitadas. property_options pode ser apenas de um dos tipos a seguir:
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

As opções para propriedades de números inteiros.

Representação JSON 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Campos
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

Usado para especificar a classificação ordenada do número inteiro. Só poderá ser usado se isRepeatable for falso.
minimumValue

string (Int64Value format)

O valor mínimo da propriedade. Os valores mínimo e máximo da propriedade são usados para classificar os resultados de acordo com o ordered ranking. As solicitações de indexação com valores menores que o mínimo são aceitas e classificadas com o mesmo peso que os itens indexados com o valor mínimo.
maximumValue

string (Int64Value format)

O valor máximo da propriedade. Os valores mínimo e máximo da propriedade são usados para classificar os resultados de acordo com o ordered ranking. As solicitações de indexação com valores maiores que o máximo são aceitas e classificadas com o mesmo peso dos itens indexados com o valor máximo.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Se definido, descreve como o número inteiro deve ser usado como um operador de pesquisa.
integerFacetingOptions

object (IntegerFacetingOptions)

Se definido, descreve as opções de atributos de números inteiros para a propriedade de número inteiro especificada. A propriedade de número inteiro correspondente precisa ser marcada como isFacetable.

IntegerPropertyOptions.OrderedRanking

Usado para especificar como um valor inteiro deve ser classificado em relação a outros valores. Um número inteiro com uma classificação ordenada mais alta sugere maior importância. Por exemplo, em algumas fontes de dados, a prioridade mais baixa indica maior importância, enquanto em outras uma prioridade mais alta indica maior importância.

Enums
NO_ORDER Não há ordem de classificação para a propriedade. Os resultados não são ajustados pelo valor desta propriedade.
ASCENDING Esta propriedade está classificada em ordem crescente. Valores mais baixos indicam classificação mais baixa.
DESCENDING Esta propriedade é classificada em ordem decrescente. Valores mais baixos indicam classificação mais alta.

IntegerPropertyOptions.IntegerOperatorOptions

Usado para fornecer um operador de pesquisa para propriedades inteiras. Isso é opcional. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado.

Representação JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campos
operatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade "integer". Por exemplo, se "operatorName" for priority e o nome da propriedade for priorityVal, consultas como priority:<value> só mostram resultados quando o valor da propriedade chamada priorityVal corresponde a <value>. Por outro lado, uma pesquisa que usa o mesmo &lt;value&gt; sem um operador retorna todos os itens em que &lt;value&gt; corresponde ao valor de qualquer propriedade de string ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.
lessThanOperatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade de número inteiro usando o operador "menor que". Por exemplo, se menosThanOperatorName for priorityForeground e o nome da propriedade for priorityVal, consultas como priority below:<value> mostram resultados apenas quando o valor da propriedade denominada priorityVal é menor que <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.
greaterThanOperatorName

string

Indica o nome do operador necessário na consulta para isolar a propriedade de número inteiro usando o operador "maior que". Por exemplo, se maiorThanOperatorName for priority above e o nome da propriedade for priorityVal, consultas como priority above:<value> mostram resultados somente quando o valor da propriedade priorityVal é maior que <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

DoublePropertyOptions

As opções para propriedades duplas.

Representação JSON 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Campos
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Se definido, descreve como o duplo deve ser usado como um operador de pesquisa.

DoublePropertyOptions.DoubleOperatorOptions

Usado para fornecer um operador de pesquisa para propriedades duplas. Isso é opcional. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado.

Representação JSON 
{
  "operatorName": string
}
Campos
operatorName

string

Indica o nome do operador exigido na consulta para usar a propriedade double na classificação ou como um atributo. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

TimestampPropertyOptions

As opções para propriedades de carimbo de data/hora.

Representação JSON 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Campos
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Se definido, descreve como o carimbo de data/hora precisa ser usado como um operador de pesquisa.

TimestampPropertyOptions.TimestampOperatorOptions

Usado para fornecer um operador de pesquisa para propriedades de carimbo de data/hora. Isso é opcional. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado.

Representação JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campos
operatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade do carimbo de data/hora. Por exemplo, se ooperatorName for closedon e o nome da propriedade for closeDate, consultas como closedon:<value> vão mostrar resultados apenas quando o valor da propriedade denominada closeDate corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo &lt;value&gt; sem um operador retorna todos os itens em que &lt;value&gt; corresponde ao valor de qualquer propriedade de string ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.
lessThanOperatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade do carimbo de data/hora usando o operador "menor que". Por exemplo, se menosThanOperatorName for closedbefore e o nome da propriedade for closeDate, as consultas como closedbefore:<value> vão mostrar resultados apenas quando o valor da propriedade denominada closeDate for anterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.
greaterThanOperatorName

string

Indica o nome do operador necessário na consulta para isolar a propriedade do carimbo de data/hora usando o operador "maior que". Por exemplo, se maiorThanOperatorName for closedafter e o nome da propriedade for closeDate, consultas como closedafter:<value> mostrarão resultados apenas onde o valor da propriedade denominada closeDate for posterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

BooleanPropertyOptions

Opções para propriedades booleanas.

Representação JSON 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Campos
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Se definido, descreve como o booleano deve ser usado como um operador de pesquisa.

BooleanPropertyOptions.BooleanOperatorOptions

Usado para fornecer um operador de pesquisa para propriedades booleanas. Isso é opcional. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado.

Representação JSON 
{
  "operatorName": string
}
Campos
operatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade booleana. Por exemplo, se "operatorName" for closed e o nome da propriedade for isClosed, consultas como closed:<value> vão mostrar resultados apenas quando o valor da propriedade chamada isClosed corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo &lt;value&gt; sem um operador retorna todos os itens em que &lt;value&gt; corresponde ao valor de qualquer propriedade de string ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

ObjectPropertyOptions

As opções de propriedades de objetos.

Representação JSON 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Campos
subobjectProperties[]

object (PropertyDefinition)

As propriedades do subobjeto. Essas propriedades representam um objeto aninhado. Por exemplo, se essa propriedade representa um endereço postal, os subobjectProperties podem ser nomeados como street, city e state. O número máximo de elementos é 1.000.

EnumPropertyOptions

As opções de propriedades enum, que permitem definir um conjunto restrito de strings para corresponder às consultas do usuário, definir classificações para esses valores de string e definir um nome de operador a ser pareado com essas strings, para que os usuários possam restringir os resultados a apenas itens com um valor específico. Por exemplo, para itens em um sistema de rastreamento de solicitações com informações de prioridade, você pode definir p0 como um valor de tipo enumerado permitido e vincular esse tipo enumerado ao nome do operador priority para que os usuários da pesquisa possam adicionar priority:p0 à consulta e restringir o conjunto de resultados apenas aos itens indexados com o valor p0.

Representação JSON 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Campos
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

A lista de valores possíveis para a propriedade de enumeração. Todos os EnumValuePairs precisam fornecer um valor de string. Se você especificar um valor inteiro para um EnumValuePair, todos os EnumValuePairs possíveis precisam fornecer um valor inteiro. O valor da string e o valor inteiro precisam ser exclusivos entre todos os valores possíveis. Uma vez definidos, os valores possíveis não podem ser removidos ou modificados. Se você fornecer uma classificação ordenada e achar que pode inserir mais valores de tipo enumerado no futuro, deixe lacunas nos valores inteiros iniciais para permitir a adição de um valor entre os valores registrados anteriormente. O número máximo de elementos é 100.
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Usado para especificar a classificação ordenada para a enumeração que determina como os valores inteiros fornecidos nos possíveis EnumValuePairs são usados para classificar os resultados. Se especificado, valores inteiros precisam ser fornecidos para todos os valores de EnumValuePair possíveis fornecidos para essa propriedade. Só poderá ser usado se isRepeatable for falso.
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Se definido, descreve como o tipo enumerado deve ser usado como um operador de pesquisa.

EnumPropertyOptions.EnumValuePair

O par de valores de enumeração define duas coisas: um valor de string obrigatório e um valor inteiro opcional. O valor da string define o termo de consulta necessário para recuperar esse item, como p0 para um item de prioridade. O valor inteiro determina a classificação desse valor de string em relação a outros valores enumerados para a mesma propriedade. Por exemplo, é possível associar p0 a 0 e definir outro par de tipos enumerados, como p1 e 1. Use o valor inteiro em combinação com ordered ranking para definir a classificação de um determinado valor em relação a outros valores enumerados para o mesmo nome de propriedade. Aqui, uma ordem de classificação DESCENDING para as propriedades de prioridade resulta em uma classificação maior para itens indexados com um valor de p0 em comparação com itens indexados com um valor de p1. Sem uma ordem de classificação especificada, o valor inteiro não afeta a classificação do item.

Representação JSON 
{
  "stringValue": string,
  "integerValue": integer
}
Campos
stringValue

string

O valor de string do EnumValuePair. O tamanho máximo é de 32 caracteres.
integerValue

integer

O valor inteiro de EnumValuePair que não pode ser negativo. Opcional.

EnumPropertyOptions.OrderedRanking

Usado para especificar a direção de classificação de um número inteiro EnumValuePair em relação a outros valores inteiros de EnumValuePair. Para algumas propriedades, valores inteiros mais baixos indicam maior importância, enquanto em outras um número inteiro maior indica maior importância.

Enums
NO_ORDER Não há ordem de classificação para a propriedade. Os resultados não são ajustados pelo valor desta propriedade.
ASCENDING Esta propriedade está classificada em ordem crescente. Valores mais baixos indicam classificação mais baixa.
DESCENDING Esta propriedade é classificada em ordem decrescente. Valores mais baixos indicam classificação mais alta.

EnumPropertyOptions.EnumOperatorOptions

Usado para fornecer um operador de pesquisa para propriedades de tipo enumerado. Isso é opcional. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado. Por exemplo, se você não fornecer um operador para uma propriedade de tipo enumerado priority com os valores possíveis p0 e p1, uma consulta que contenha o termo p0 retornará itens com p0 como valor da propriedade priority, bem como itens que contenham a string p0 em outros campos. Se você fornecer um nome de operador para o tipo enumerado, como priority, os usuários da pesquisa poderão usar esse operador para refinar os resultados somente para itens que tenham p0 como o valor dessa propriedade, com a consulta priority:p0.

Representação JSON 
{
  "operatorName": string
}
Campos
operatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade "enum". Por exemplo, se "operatorName" for priority e o nome da propriedade for priorityVal, consultas como priority:<value> só mostram resultados quando o valor da propriedade chamada priorityVal corresponde a <value>. Por outro lado, uma pesquisa que usa o mesmo &lt;value&gt; sem um operador retorna todos os itens em que &lt;value&gt; corresponde ao valor de qualquer propriedade de string ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

DatePropertyOptions

As opções de propriedades de data.

Representação JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Campos
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Se definido, descreve como a data deverá ser usada como um operador de pesquisa.

DatePropertyOptions.DateOperatorOptions

Opcional. Fornece um operador de pesquisa para propriedades de data. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado.

Representação JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campos
operatorName

string

Indica a string real necessária na consulta para isolar a propriedade date. Por exemplo, suponha que um objeto de esquema de acompanhamento de problemas tenha uma propriedade chamada closeDate que especifica um operador com umoperatorName de closedon. Para pesquisas sobre esses dados, consultas como closedon:&lt;value&gt; mostram resultados apenas quando o valor da propriedade closedon:&lt;value&gt; corresponde a closedon:&lt;value&gt;. Por outro lado, uma pesquisa que usa o mesmo &lt;value&gt; sem um operador retorna todos os itens em que &lt;value&gt; corresponde ao valor de qualquer propriedade de string ou texto no campo de conteúdo da fonte de dados indexada. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.
lessThanOperatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade de data usando o operador "menor que". Por exemplo, se menosThanOperatorName for closedbefore e o nome da propriedade for closeDate, as consultas como closedbefore:<value> vão mostrar resultados apenas quando o valor da propriedade denominada closeDate for anterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.
greaterThanOperatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade da data usando o operador "maior que". Por exemplo, se maiorThanOperatorName for closedafter e o nome da propriedade for closeDate, consultas como closedafter:<value> mostrarão resultados apenas onde o valor da propriedade denominada closeDate for posterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

TextPropertyOptions

As opções de propriedades de texto.

Representação JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Campos
retrievalImportance

object (RetrievalImportance)

Indica a importância da qualidade de pesquisa dos tokens no campo quando usados para recuperação.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Se definido, descreve como a propriedade deve ser usada como um operador de pesquisa.

RetrievalImportance

Representação JSON 
{
  "importance": enum (RetrievalImportance.Importance)
}
Campos
importance

enum (RetrievalImportance.Importance)

Indica a importância de classificação dada à propriedade quando esta é correspondida durante a recuperação. Depois de definida, a importância do token de uma propriedade não pode ser alterada.

RetrievalImportance.Importance

Enums
DEFAULT Trate a correspondência como uma correspondência de corpo de texto.
HIGHEST Trate a correspondência como uma correspondência com o título do item.
HIGH Trate a correspondência com mais importância do que o corpo do texto.
LOW Trate a correspondência com menor importância do que o corpo do texto.
NONE Não correspondem a esse campo durante a recuperação. A propriedade ainda pode ser usada para correspondência de operadores, facetas e sugestões, se desejado.

TextPropertyOptions.TextOperatorOptions

Usado para fornecer um operador de pesquisa para propriedades de texto. Isso é opcional. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado.

Representação JSON 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Campos
operatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade de texto. Por exemplo, seoperatorName for subject e o nome da propriedade for subjectLine, consultas como subject:<value> mostrarão resultados somente onde o valor da propriedade chamada subjectLine corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo &lt;value&gt; sem um operador retorna todos os itens em que &lt;value&gt; corresponde ao valor de qualquer propriedade de texto ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.
exactMatchWithOperator

boolean

Se verdadeiro, o valor de texto é tokenizado como um valor atômico em pesquisas do operador e correspondências de atributo. Por exemplo, se o nome do operador for "genre" e o valor é "ficção científica" as restrições de consulta "genre:science" e "genre:ficção" não corresponde ao item; "gênero:ficção científica" faz. A correspondência de valores de texto diferencia maiúsculas de minúsculas e não remove caracteres especiais. Se for falso, o texto é tokenizado. Por exemplo, se o valor for "ficção científica" as consultas "genre:science" e "genre:ficção" corresponde ao item.

HtmlPropertyOptions

As opções para propriedades html.

Representação JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Campos
retrievalImportance

object (RetrievalImportance)

Indica a importância da qualidade de pesquisa dos tokens no campo quando usados para recuperação. Só pode ser definido como DEFAULT ou NONE.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Se definido, descreve como a propriedade deve ser usada como um operador de pesquisa.

HtmlPropertyOptions.HtmlOperatorOptions

Usado para fornecer um operador de pesquisa para propriedades html. Isso é opcional. Os operadores query.search permitem que os usuários restrinjam a consulta a campos específicos relevantes ao tipo de item que está sendo pesquisado.

Representação JSON 
{
  "operatorName": string
}
Campos
operatorName

string

Indica o nome do operador exigido na consulta para isolar a propriedade html. Por exemplo, seoperatorName for subject e o nome da propriedade for subjectLine, consultas como subject:<value> mostrarão resultados somente onde o valor da propriedade chamada subjectLine corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo &lt;value&gt; sem um operador retorna todos os itens em que &lt;value&gt; corresponde ao valor de qualquer propriedade HTML ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

PropertyDisplayOptions

As opções de exibição de uma propriedade.

Representação JSON 
{
  "displayLabel": string
}
Campos
displayLabel

string

O rótulo fácil de usar para a propriedade usada se a propriedade for especificada para ser mostrada em ObjectDisplayOptions. Se fornecido, o rótulo de exibição será mostrado na frente dos valores da propriedade quando ela fizer parte das opções de exibição do objeto. Por exemplo, se o valor da propriedade for "1", o valor por si só pode não ser um contexto útil para o usuário. Se o nome de exibição fornecido for "prioridade", o usuário verá "prioridade : 1". nos resultados da pesquisa, que fornece um contexto claro para os usuários da pesquisa. Isso é OPCIONAL; Se não for informado, apenas os valores da propriedade serão exibidos. O tamanho máximo é de 64 caracteres.