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

Risorsa: TargetSite

Un sito target per SiteSearchEngine.

Rappresentazione 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)
  }
}
Campi
name

string

Solo output. Il nome risorsa completo del sito target. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} L'elemento target_site_id viene generato dal sistema.

providedUriPattern

string

Obbligatorio. Solo input. Il pattern URI fornito dall'utente da cui viene generato generatedUriPattern.

type

enum (Type)

Il tipo di sito target, ad esempio se il sito deve essere incluso o escluso.

exactMatch

boolean

Immutabile. Se impostato su false, viene generato un uri_pattern per includere tutte le pagine il cui indirizzo contiene providedUriPattern. Se impostato su true, viene generato un uri_pattern per cercare di corrispondere esattamente a providedUriPattern o solo alla pagina specifica se providedUriPattern è specifico. providedUriPattern viene sempre normalizzato per generare il pattern URI da utilizzare per il motore di ricerca.

generatedUriPattern

string

Solo output. Viene generato dal sistema in base a providedUriPattern.

rootDomainUri

string

Solo output. Dominio principale di providedUriPattern.

siteVerificationInfo

object (SiteVerificationInfo)

Solo output. Stato di verifica della proprietà e della validità del sito.

indexingStatus

enum (IndexingStatus)

Solo output. Stato di indicizzazione.

updateTime

string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento del sito target.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

failureReason

object (FailureReason)

Solo output. Motivo dell'errore.

Tipo

Possibili tipi di siti target.

Enum
TYPE_UNSPECIFIED Questo valore non viene utilizzato. In questo caso, il comportamento del server è impostato per impostazione predefinita su Type.INCLUDE.
INCLUDE Includi il sito target.
EXCLUDE Escludi il sito target.

SiteVerificationInfo

Informazioni di verifica per i siti target nella ricerca avanzata sul sito.

Rappresentazione JSON
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
Campi
siteVerificationState

enum (SiteVerificationState)

Stato di verifica del sito che indica la proprietà e la validità.

verifyTime

string (Timestamp format)

Ultima ora di verifica del sito.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

SiteVerificationState

Stato di verifica del sito.

Enum
SITE_VERIFICATION_STATE_UNSPECIFIED Il valore predefinito è VERIFIED.
VERIFIED Proprietà del sito verificata.
UNVERIFIED Proprietà del sito in attesa di verifica o verifica non riuscita.
EXEMPTED Sito esente dalla verifica, ad esempio un sito web pubblico aperto a tutti.

IndexingStatus

Enumerazione dello stato di indicizzazione del sito target.

Enum
INDEXING_STATUS_UNSPECIFIED Il valore predefinito è SUCCEEDED.
PENDING Il sito target è nella coda di aggiornamento e verrà selezionato dalla pipeline di indicizzazione.
FAILED L'indicizzazione del sito target non è riuscita.
SUCCEEDED Il sito target è stato indicizzato.
DELETING Il sito target indicizzato in precedenza è stato contrassegnato per l'eliminazione. Si tratta di uno stato di transizione che comporterà: 1. l'eliminazione del sito target se l'annullamento dell'indicizzazione ha esito positivo; 2. il ripristino dello stato SUCCEEDED se l'annullamento dell'indicizzazione non riesce.
CANCELLABLE La modifica del sito target è in attesa, ma può essere annullata.
CANCELLED La modifica del sito target è stata annullata.

FailureReason

Motivi di errore dell'indicizzazione della ricerca sul sito.

Rappresentazione JSON
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
Campi
Campo unione failure. Motivo dell'errore. failure può essere solo uno dei seguenti tipi:
quotaFailure

object (QuotaFailure)

Errore dovuto a una quota insufficiente.

QuotaFailure

Errore dovuto a una quota insufficiente.

Rappresentazione JSON
{
  "totalRequiredQuota": string
}
Campi
totalRequiredQuota

string (int64 format)

Questo numero è una stima della quota totale necessaria a questo progetto per completare correttamente l'indicizzazione.

Metodi

batchCreate

Crea TargetSite in batch.

create

Crea un TargetSite.

delete

Elimina un TargetSite.

get

Recupera un TargetSite.

list

Recupera un elenco di TargetSite.

patch

Aggiorna un TargetSite.