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

Recurso: TargetSite

Sitio de destino de 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 de salida. Nombre de recurso completo 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 de entrada. El patrón de URI proporcionado por el usuario a partir del cual se genera el generatedUriPattern.
type

enum (Type)

El tipo de sitio de destino (por ejemplo, si el sitio se va a incluir o excluir).
exactMatch

boolean

Inmutable. Si se define como false, se genera un uri_pattern para incluir todas las páginas cuya dirección contenga el valor de providedUriPattern. Si se define como true, se genera un uri_pattern para intentar que coincida exactamente con providedUriPattern o solo con la página específica si providedUriPattern es una página específica. providedUriPattern siempre se normaliza para generar el patrón de URI que utilizará el buscador.
generatedUriPattern

string

Solo de salida. Se genera automáticamente en función de providedUriPattern.
rootDomainUri

string

Solo de salida. Dominio raíz de providedUriPattern.
siteVerificationInfo

object (SiteVerificationInfo)

Solo de salida. Estado de verificación de la propiedad y la validez del sitio.
indexingStatus

enum (IndexingStatus)

Solo de salida. Estado de indexación.
updateTime

string (Timestamp format)

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

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 de salida. Motivo del error.

Tipo

Tipos de sitios de destino posibles.

Enumeraciones
TYPE_UNSPECIFIED Este valor no se usa. En este caso, el comportamiento del servidor es Type.INCLUDE de forma predeterminada.
INCLUDE Incluya el sitio de destino.
EXCLUDE Excluya el sitio de destino.

SiteVerificationInfo

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

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

enum (SiteVerificationState)

Estado de verificación del sitio que indica la propiedad y la validez.
verifyTime

string (Timestamp format)

Hora de la última verificación del sitio.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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.

Enumeraciones
SITE_VERIFICATION_STATE_UNSPECIFIED El valor predeterminado es VERIFIED.
VERIFIED Propiedad del sitio verificada.
UNVERIFIED La verificación de la propiedad del sitio está pendiente o no se ha podido realizar.
EXEMPTED Sitio exento de verificación, como un sitio web público que está abierto a todos los usuarios.

IndexingStatus

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

Enumeraciones
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 puede indexar el sitio de destino.
SUCCEEDED El sitio de destino se ha indexado.
DELETING El sitio de destino indexado anteriormente se ha marcado para que se elimine. Este es un estado de transición que dará lugar a lo siguiente: 1. el sitio de destino se elimina si la desindexación se realiza correctamente; 2. el estado vuelve a SUCCEEDED si la desindexación falla.
CANCELLABLE El cambio de sitio de destino está pendiente, pero se puede cancelar.
CANCELLED Se ha cancelado el cambio de sitio de destino.

FailureReason

Motivos por los que no se ha podido indexar la búsqueda en el sitio.

Representación 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ón failure. Motivo del error. failure solo puede ser una de estas dos opciones:
quotaFailure

object (QuotaFailure)

No se ha podido completar la acción por falta de cuota.

QuotaFailure

No se ha podido completar la acción por falta de cuota.

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 la indexación correctamente.

Métodos

batchCreate

 Crea TargetSite en un lote.

create

 Crea un TargetSite.

delete

 Elimina un TargetSite.

get

 Obtiene un TargetSite.

list

 Obtiene una lista de TargetSites.

patch

 Actualiza un TargetSite.