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

Ressource : TargetSite

Site cible pour le SiteSearchEngine.

Représentation 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)
  }
}
Champs
name

string

Uniquement en sortie. Nom complet de la ressource du site cible. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} Le target_site_id est généré par le système.
providedUriPattern

string

Obligatoire. Uniquement en entrée. Modèle d'URI fourni par l'utilisateur à partir duquel le generatedUriPattern est généré.
type

enum (Type)

Type de site cible (par exemple, si le site doit être inclus ou exclu).
exactMatch

boolean

Immuable. Si la valeur est définie sur "false", un uri_pattern est généré pour inclure toutes les pages dont l'adresse contient le providedUriPattern. Si la valeur est définie sur "true", un uri_pattern est généré pour essayer de correspondre exactement au providedUriPattern ou simplement à la page spécifique si le providedUriPattern est spécifique. providedUriPattern est toujours normalisé pour générer le modèle d'URI à utiliser par le moteur de recherche.
generatedUriPattern

string

Uniquement en sortie. Il est généré par le système en fonction du providedUriPattern.
rootDomainUri

string

Uniquement en sortie. Domaine racine du providedUriPattern.
siteVerificationInfo

object (SiteVerificationInfo)

Uniquement en sortie. État de la validation de la propriété et de la validité du site.
indexingStatus

enum (IndexingStatus)

Uniquement en sortie. État de l'indexation.
updateTime

string (Timestamp format)

Uniquement en sortie. Date et heure de la dernière mise à jour du site cible.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
failureReason

object (FailureReason)

Uniquement en sortie. Motif de l'échec.

Type

Types de sites cibles possibles.

Enums
TYPE_UNSPECIFIED Cette valeur n'est pas utilisée. Dans ce cas, le comportement du serveur est défini par défaut sur Type.INCLUDE.
INCLUDE Incluez le site cible.
EXCLUDE Excluez le site cible.

SiteVerificationInfo

Informations de validation pour les sites cibles dans la recherche avancée sur site.

Représentation JSON 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
Champs
siteVerificationState

enum (SiteVerificationState)

État de validation du site indiquant la propriété et la validité.
verifyTime

string (Timestamp format)

Heure de la dernière validation du site.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SiteVerificationState

État de validation du site.

Enums
SITE_VERIFICATION_STATE_UNSPECIFIED La valeur par défaut est "VERIFIED".
VERIFIED La propriété du site a été validée.
UNVERIFIED La validation de la propriété du site est en attente ou a échoué.
EXEMPTED Site exempté de validation, par exemple un site Web public ouvert à tous.

IndexingStatus

Énumération de l'état d'indexation du site cible.

Enums
INDEXING_STATUS_UNSPECIFIED La valeur par défaut est "SUCCEEDED".
PENDING Le site cible se trouve dans la file d'attente des mises à jour et sera traité par le pipeline d'indexation.
FAILED Le site cible n'est pas indexé.
SUCCEEDED Le site cible a été indexé.
DELETING Le site cible précédemment indexé a été marqué comme devant être supprimé. Il s'agit d'un état transitoire qui peut entraîner : 1) la suppression du site cible si la désindexation réussit ; 2) le retour à l'état "SUCCEEDED" (RÉUSSI) si la désindexation échoue.
CANCELLABLE La modification du site cible est en attente, mais peut être annulée.
CANCELLED La modification du site cible a été annulée.

FailureReason

Motifs d'échec de l'indexation de la recherche sur le site.

Représentation JSON 
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
Champs
Champ d'union failure. Motif de l'échec. failure ne peut être qu'un des éléments suivants :
quotaFailure

object (QuotaFailure)

Échec en raison d'un quota insuffisant.

QuotaFailure

Échec en raison d'un quota insuffisant.

Représentation JSON 
{
  "totalRequiredQuota": string
}
Champs
totalRequiredQuota

string (int64 format)

Ce nombre est une estimation du quota total dont ce projet a besoin pour terminer l'indexation.

Méthodes

batchCreate

 Crée des TargetSite par lot.

create

 Crée un objet TargetSite.

delete

 Supprime un TargetSite.

get

 Récupère un TargetSite.

list

 Obtient une liste de TargetSite.

patch

 Met à jour un TargetSite.