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

Ressource: TargetSite

Eine Zielwebsite für die SiteSearchEngine.

JSON-Darstellung 
{
  "name": string,
  "providedUriPattern": string,
  "type": enum (Type),
  "exactMatch": boolean,
  "generatedUriPattern": string,
  "rootDomainUri": string,
  "siteVerificationInfo": {
    object (SiteVerificationInfo)
  },
  "indexingStatus": enum (IndexingStatus),
  "updateTime": string,
  "failureReason": {
    object (FailureReason)
  }
}
Felder
name

string

Nur Ausgabe. Der vollständig qualifizierte Ressourcenname der Zielwebsite. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} Die target_site_id wird vom System generiert.
providedUriPattern

string

Erforderlich. Nur Eingabe. Das vom Nutzer bereitgestellte URI-Muster, aus dem der generatedUriPattern generiert wird.
type

enum (Type)

Der Typ der Zielwebsite, z.B. ob die Website ein- oder ausgeschlossen werden soll.
exactMatch

boolean

Nicht veränderbar. Wenn der Wert auf „false“ gesetzt ist, wird ein „uri_pattern“ generiert, der alle Seiten umfasst, deren Adresse „providedUriPattern“ enthält. Wenn „true“ festgelegt ist, wird ein „uri_pattern“ generiert, der dem angegebenen „providedUriPattern“ oder nur der spezifischen Seite entspricht, wenn „providedUriPattern“ eine spezifische Seite ist. „providedUriPattern“ wird immer normalisiert, um das von der Suchmaschine zu verwendende URI-Muster zu generieren.
generatedUriPattern

string

Nur Ausgabe. Dies wird vom System basierend auf dem bereitgestellten URI-Muster generiert.
rootDomainUri

string

Nur Ausgabe. Stammdomain des bereitgestellten „uriPattern“.
siteVerificationInfo

object (SiteVerificationInfo)

Nur Ausgabe. Status der Bestätigung der Websiteinhaberschaft und ‑gültigkeit.
indexingStatus

enum (IndexingStatus)

Nur Ausgabe. Indexierungsstatus
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der letzten Aktualisierung der Zielwebsite.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
failureReason

object (FailureReason)

Nur Ausgabe. Grund für den Fehler.

Typ

Mögliche Zielstandorttypen.

Enums
TYPE_UNSPECIFIED Dieser Wert wird nicht verwendet. In diesem Fall ist das Serververhalten standardmäßig Type.INCLUDE.
INCLUDE Nehmen Sie die Zielwebsite mit auf.
EXCLUDE Schließen Sie die Zielwebsite aus.

SiteVerificationInfo

Bestätigungsinformationen für Zielwebsites in der erweiterten Websuche.

JSON-Darstellung 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
Felder
siteVerificationState

enum (SiteVerificationState)

Status der Websitebestätigung, der die Inhaberschaft und Gültigkeit angibt.
verifyTime

string (Timestamp format)

Zeit der letzten Websitebestätigung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

SiteVerificationState

Status der Websitebestätigung.

Enums
SITE_VERIFICATION_STATE_UNSPECIFIED Die Standardeinstellung ist VERIFIED.
VERIFIED Die Websiteinhaberschaft wurde bestätigt.
UNVERIFIED Die Bestätigung der Websiteinhaberschaft steht noch aus oder ist fehlgeschlagen.
EXEMPTED Die Website ist von der Bestätigung ausgenommen, z.B. eine öffentliche Website, die für alle geöffnet ist.

IndexingStatus

Aufzählung des Indexierungsstatus der Zielwebsite.

Enums
INDEXING_STATUS_UNSPECIFIED Die Standardeinstellung ist SUCCEEDED.
PENDING Die Zielwebsite befindet sich in der Aktualisierungswarteschlange und wird von der Indexierungspipeline verarbeitet.
FAILED Die Zielwebsite wird nicht indexiert.
SUCCEEDED Die Zielwebsite wurde indexiert.
DELETING Die zuvor indexierte Zielwebsite wurde zum Löschen markiert. Dies ist ein Übergangszustand, der entweder zu Folgendem führt: 1. Die Zielwebsite wird gelöscht, wenn die Deindexierung erfolgreich ist. 2. Der Status wird auf „ERFOLGREICH“ zurückgesetzt, wenn die Deindexierung fehlschlägt.
CANCELLABLE Die Änderung der Zielwebsite steht aus, kann aber abgebrochen werden.
CANCELLED Die Änderung der Zielwebsite wird abgebrochen.

FailureReason

Gründe für Fehler bei der Indexierung der Website-Suche.

JSON-Darstellung 
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
Felder
Union-Feld failure. Grund für den Fehler. Für failure ist nur einer der folgenden Werte zulässig:
quotaFailure

object (QuotaFailure)

Fehler aufgrund unzureichenden Kontingents.

QuotaFailure

Fehler aufgrund unzureichenden Kontingents.

JSON-Darstellung 
{
  "totalRequiredQuota": string
}
Felder
totalRequiredQuota

string (int64 format)

Diese Zahl ist eine Schätzung des gesamten Kontingents, das für die erfolgreiche Indexierung dieses Projekts erforderlich ist.

Methoden

batchCreate

 Erstellt TargetSite in einem Batch.

create

 Erstellt einen TargetSite.

delete

 Löscht ein TargetSite.

get

 Erstellt einen TargetSite.

list

 Ruft eine Liste von TargetSite ab.

patch

 Aktualisiert ein TargetSite.