Schema

{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}

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.

object (ObjectOptions)

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

object (PropertyDefinition)

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

{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}

object (ObjectOptions.FreshnessOptions)

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

object (ObjectDisplayOptions)

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

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.

{
  "freshnessProperty": string,
  "freshnessDuration": string
}

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.

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".

{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}

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.

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.

{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}

object (ObjectDisplayOptions.DisplayedProperty)

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

{
  "propertyName": string
}

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.

{
  "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.
}

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.

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.

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.

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.

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.

boolean

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

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.

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.

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}

enum (IntegerPropertyOptions.OrderedRanking)

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

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.

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.

object (IntegerPropertyOptions.IntegerOperatorOptions)

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

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.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

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.

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.

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.

{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}

object (DoublePropertyOptions.DoubleOperatorOptions)

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

{
  "operatorName": string
}

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.

{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}

object (TimestampPropertyOptions.TimestampOperatorOptions)

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

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

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.

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.

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.

{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}

object (BooleanPropertyOptions.BooleanOperatorOptions)

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

{
  "operatorName": string
}

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.

{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}

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.

{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}

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.

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.

object (EnumPropertyOptions.EnumOperatorOptions)

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

{
  "stringValue": string,
  "integerValue": integer
}

string

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

integer

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

{
  "operatorName": string
}

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.

{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}

object (DatePropertyOptions.DateOperatorOptions)

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

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

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.

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.

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.

{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}

object (RetrievalImportance)

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

object (TextPropertyOptions.TextOperatorOptions)

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

{
  "importance": enum (RetrievalImportance.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.

{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}

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.

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.

{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}

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.

object (HtmlPropertyOptions.HtmlOperatorOptions)

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

{
  "operatorName": string
}

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.

{
  "displayLabel": string
}

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.