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. Apenas entrada. O padrão de URI fornecido pelo utilizador a partir do qual o generatedUriPattern é gerado.
type

enum (Type)

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

boolean

Imutável. Se for definido como falso, é gerado um uri_pattern para incluir todas as páginas cujo endereço contém o providedUriPattern. Se for definido como verdadeiro, é gerado um uri_pattern para tentar ser uma correspondência exata do providedUriPattern ou apenas da 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 motor de pesquisa.
generatedUriPattern

string

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

string

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

object (SiteVerificationInfo)

Apenas saída. Estado da validação da propriedade e da validade do site.
indexingStatus

enum (IndexingStatus)

Apenas saída. Estado da indexação.
updateTime

string (Timestamp format)

Apenas saída. A hora da última atualização do site de destino.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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

Tipos de sites de destino possíveis.

Enumerações
TYPE_UNSPECIFIED Este valor não é usado. Neste caso, o comportamento do servidor é predefinido para Type.INCLUDE.
INCLUDE Inclua o site de destino.
EXCLUDE Exclua o site de destino.

SiteVerificationInfo

Informações de validação para sites de destino na pesquisa de sites avançada.

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

enum (SiteVerificationState)

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

string (Timestamp format)

Hora da validação do site mais recente.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SiteVerificationState

Estado da validação do site.

Enumerações
SITE_VERIFICATION_STATE_UNSPECIFIED A predefinição é VERIFIED.
VERIFIED Propriedade do site validada.
UNVERIFIED A validação da propriedade do site está pendente ou falhou.
EXEMPTED Site isento de validação, por exemplo, um Website público que está aberto a todos.

IndexingStatus

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

Enumerações
INDEXING_STATUS_UNSPECIFIED A predefinição é SUCCEEDED.
PENDING O site de destino está na fila de atualizações e vai ser processado pelo pipeline de indexação.
FAILED O site de destino não é indexado.
SUCCEEDED O site de destino foi indexado.
DELETING O site de destino indexado anteriormente foi marcado para eliminação. Este é um estado de transição que resulta numa das seguintes situações: 1. O site de destino é eliminado se a anulação da indexação for bem-sucedida; 2. O estado reverte para SUCCEEDED se a anulação da indexação falhar.
CANCELLABLE A alteração do site de destino está pendente, mas pode ser cancelada.
CANCELLED A alteração do site de destino foi cancelada.

FailureReason

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

Representação JSON 
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
Campos
Campo de união failure. Motivo da falha. failure só pode ser uma das seguintes opções:
quotaFailure

object (QuotaFailure)

Falha devido a quota insuficiente.

QuotaFailure

Falha devido a quota insuficiente.

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

string (int64 format)

Este número é uma estimativa da quota total de que este projeto precisa para concluir a indexação com êxito.

Métodos

batchCreate

 Cria TargetSite num lote.

create

 Cria um TargetSite.

delete

 Elimina um TargetSite.

get

 Obtém um TargetSite.

list

 Obtém uma lista de TargetSites.

patch

 Atualiza um TargetSite.