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

Recurso: TargetSite

Es un sitio de destino para SiteSearchEngine.

Representación 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

Solo salida. Es el nombre de recurso completamente calificado del sitio de destino. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} El target_site_id se genera automáticamente.
providedUriPattern

string

Obligatorio. Solo entrada. Es el patrón de URI proporcionado por el usuario a partir del cual se genera el generatedUriPattern.
type

enum (Type)

Es el tipo de sitio de destino, por ejemplo, si el sitio se incluirá o excluirá.
exactMatch

boolean

Inmutable. Si se establece en falso, se genera un uri_pattern para incluir todas las páginas cuya dirección contenga el providedUriPattern. Si se establece en verdadero, se genera un uri_pattern para intentar que coincida exactamente con el providedUriPattern o solo con la página específica si el providedUriPattern es específico. El providedUriPattern siempre se normaliza para generar el patrón de URI que usará el motor de búsqueda.
generatedUriPattern

string

Solo salida. El sistema lo genera en función del providedUriPattern.
rootDomainUri

string

Solo salida. Es el dominio raíz del providedUriPattern.
siteVerificationInfo

object (SiteVerificationInfo)

Solo salida. Es el estado de verificación de la propiedad y la validez del sitio.
indexingStatus

enum (IndexingStatus)

Solo salida. Es el estado de indexación.
updateTime

string (Timestamp format)

Solo salida. Es la hora de la última actualización del sitio de destino.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
failureReason

object (FailureReason)

Solo salida. Es el motivo del error.

Tipo

Tipos de sitios de destino posibles.

Enums
TYPE_UNSPECIFIED Este valor no se usa. En este caso, el comportamiento del servidor se establece de forma predeterminada en Type.INCLUDE.
INCLUDE Incluye el sitio de destino.
EXCLUDE Excluye el sitio de destino.

SiteVerificationInfo

Información de verificación para sitios de destino en la búsqueda avanzada en el sitio.

Representación JSON 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
Campos
siteVerificationState

enum (SiteVerificationState)

Es el estado de verificación del sitio que indica la propiedad y la validez.
verifyTime

string (Timestamp format)

Es la hora de la última verificación del sitio.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

SiteVerificationState

Estado de verificación del sitio.

Enums
SITE_VERIFICATION_STATE_UNSPECIFIED El valor predeterminado es VERIFIED.
VERIFIED Se verificó la propiedad del sitio.
UNVERIFIED La propiedad del sitio está pendiente de verificación o falló la verificación.
EXEMPTED El sitio está exento de verificación, por ejemplo, un sitio web público que se abre para todos.

IndexingStatus

Enumeración del estado de indexación del sitio de destino.

Enums
INDEXING_STATUS_UNSPECIFIED El valor predeterminado es SUCCEEDED.
PENDING El sitio de destino está en la cola de actualización y la canalización de indexación lo recogerá.
FAILED No se pudo indexar el sitio de destino.
SUCCEEDED Se indexó el sitio de destino.
DELETING Se marcó el sitio de destino indexado anteriormente para que se borre. Este es un estado de transición que dará como resultado lo siguiente: 1. Se borra el sitio de destino si la anulación de la indexación es correcta. 2. El estado vuelve a SUCCEEDED si falla la anulación de la indexación.
CANCELLABLE El cambio del sitio de destino está pendiente, pero se puede cancelar.
CANCELLED Se canceló el cambio del sitio de destino.

FailureReason

Motivos de la falla de indexación de la búsqueda en el sitio.

Representación 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
Es el motivo del error. A continuación, se incluye una lista de campos mutuamente excluyentes. Se establecerá, como máximo, uno de los campos en una respuesta:
quotaFailure

object (QuotaFailure)

No se pudo indexar debido a que la cuota es insuficiente.
Fin de los campos mutuamente excluyentes.

QuotaFailure

No se pudo indexar debido a que la cuota es insuficiente.

Representación JSON 
{
  "totalRequiredQuota": string
}
Campos
totalRequiredQuota

string (int64 format)

Este número es una estimación de la cuota total que necesita este proyecto para completar correctamente la indexación.

Métodos

batchCreate

 Crea TargetSite en lote.

create

 Crea un TargetSite.

delete

 Borra un TargetSite.

get

 Obtiene un TargetSite.

list

 Obtiene una lista de TargetSites.

patch

 Actualiza un TargetSite.