REST Resource: projects.locations.collections.dataStores.siteSearchEngine.targetSites

Recurso: TargetSite

Um site de destino para o SiteSearchEngine.

Representação JSON 
{
  "name": string,
  "providedUriPattern": string,
  "type": enum (Type),
  "exactMatch": boolean,
  "generatedUriPattern": string,
  "rootDomainUri": string,
  "siteVerificationInfo": {
    object (SiteVerificationInfo)
  },
  "indexingStatus": enum (IndexingStatus),
  "updateTime": string,
  "failureReason": {
    object (FailureReason)
  }
}
Campos
name

string

Apenas saída. O nome do recurso totalmente qualificado do site de destino. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} O target_site_id é gerado pelo sistema.
providedUriPattern

string

Obrigatório. Somente entrada. O padrão de URI fornecido pelo usuário a partir do qual o generatedUriPattern é gerado.
type

enum (Type)

O tipo do site de destino, por exemplo, se o site será incluído ou excluído.
exactMatch

boolean

Imutável. Se definido como falso, um uri_pattern será gerado para incluir todas as páginas cujo endereço contenha o providedUriPattern. Se definido como verdadeiro, um uri_pattern será gerado para tentar ser uma correspondência exata do providedUriPattern ou apenas a página específica se o providedUriPattern for específico. O providedUriPattern é sempre normalizado para gerar o padrão de URI a ser usado pelo mecanismo de pesquisa.
generatedUriPattern

string

Apenas saída. Isso é gerado pelo sistema com base no providedUriPattern.
rootDomainUri

string

Apenas saída. Domínio raiz do providedUriPattern.
siteVerificationInfo

object (SiteVerificationInfo)

Apenas saída. Status de verificação de validade e propriedade do site.
indexingStatus

enum (IndexingStatus)

Apenas saída. Status de indexação.
updateTime

string (Timestamp format)

Apenas saída. A última hora atualizada do site de destino.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
failureReason

object (FailureReason)

Apenas saída. Motivo da falha.

Tipo

Possíveis tipos de locais de destino.

Tipos enumerados
TYPE_UNSPECIFIED Esse valor não é usado. Nesse caso, o comportamento padrão do servidor é Type.INCLUDE.
INCLUDE Incluir o site de destino.
EXCLUDE Excluir o site de destino.

SiteVerificationInfo

Informações de verificação para sites de destino na pesquisa avançada no site.

Representação JSON 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
Campos
siteVerificationState

enum (SiteVerificationState)

Estado de verificação do site que indica a propriedade e a validade.
verifyTime

string (Timestamp format)

Última hora de verificação do site.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SiteVerificationState

Estado de verificação do site.

Tipos enumerados
SITE_VERIFICATION_STATE_UNSPECIFIED O padrão é VERIFIED.
VERIFIED Propriedade do site verificada.
UNVERIFIED Propriedade do site pendente de verificação ou verificação falhou.
EXEMPTED Site isento de verificação, por exemplo, um site público que se abre para todos.

IndexingStatus

Enumeração do status de indexação do site de destino.

Tipos enumerados
INDEXING_STATUS_UNSPECIFIED O padrão é SUCCEEDED.
PENDING O site de destino está na fila de atualização e será selecionado pelo pipeline de indexação.
FAILED O site de destino não pode ser indexado.
SUCCEEDED O site de destino foi indexado.
DELETING O site de destino indexado anteriormente foi marcado para exclusão. Esse é um estado de transição que resultará em: 1. site de destino excluído se a desindexação for bem-sucedida; 2. o estado reverte para SUCCEEDED se a desindexação falhar.
CANCELLABLE A mudança do site de destino está pendente, mas pode ser cancelada.
CANCELLED A mudança do site de destino foi cancelada.

FailureReason

Motivos de falha na indexação da pesquisa no site.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of mutually exclusive fields.
}
Campos
Motivo da falha. A seguir, uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
quotaFailure

object (QuotaFailure)

Falha devido à cota insuficiente.
Fim dos campos mutuamente exclusivos.

QuotaFailure

Falha devido à cota insuficiente.

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

string (int64 format)

Esse número é uma estimativa de quanto a cota total desse projeto precisa para concluir a indexação.

Métodos

batchCreate

 Cria TargetSite em lote.

create

 Cria um TargetSite.

delete

 Exclui um TargetSite.

get

 Recebe um TargetSite.

list

 Recebe uma lista de TargetSites.

patch

 Atualiza um TargetSite.