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

Recurso: TargetSite

Es un sitio objetivo para el motor de búsqueda del sitio.

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 objeto generatedUriPattern.
type

enum (Type)

Es el tipo de sitio objetivo, p.ej., si el sitio se debe incluir o excluir.
exactMatch

boolean

Inmutable. Si se establece como falso, se genera un uri_pattern para incluir todas las páginas cuya dirección contenga el providedUriPattern. Si se establece como 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. Se genera automáticamente 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. Fecha y hora de la última actualización del sitio objetivo.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. 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 de la falla.

Tipo

Son los tipos de sitios objetivo 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

Es la información de verificación de los sitios objetivo 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)

Es la fecha y hora de la verificación del sitio más reciente.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. 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

Es el estado de verificación del sitio.

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

IndexingStatus

Es una enumeración del estado de indexación del sitio objetivo.

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 generará uno de los siguientes resultados: 1. Se borra el sitio de destino si se quita la indexación correctamente. 2. El estado vuelve a SUCCEEDED si falla la eliminación de la indexación.
CANCELLABLE El cambio de sitio de destino está pendiente, pero se puede cancelar.
CANCELLED Se canceló el cambio de sitio de destino.

FailureReason

Son los motivos por los que falló la indexación de 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. Es el motivo de la falla. failure puede ser solo uno de los siguientes:
quotaFailure

object (QuotaFailure)

La operación falló debido a que la cuota es insuficiente.

QuotaFailure

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

Métodos

batchCreate

 Crea TargetSite en un lote.

create

 Crea un TargetSite.

delete

 Borra un TargetSite.

get

 Obtienes una TargetSite.

list

 Obtiene una lista de TargetSites.

patch

 Actualiza un TargetSite.